getProductRelations.v1
Requests all related products to the given productId and returns them as array.
Request Body
Section titled “Request Body”object
Responses
Section titled “Responses”object
A basic product entity, that is used for search results or categoryviews
object
The unique product id of this product inside the shop (in old cake system: product_number)
If this product is active or not
object
Text to describe the availability of this product
A kind of flag, that describes the availability state of this product
object
Should always be used for visual representation instead of id if not explicitly given, this will be the same as id (product_number_public in cake)
The European Article Number of this product
The International Standard Book Number of this product
The Universal Product Code of this product
The “Pharmazentralnummer” of this product
The Manufacturer Product Number of this product
The manufacturer or brand of this product
The product name to display
object
A custom text concerning stock (see available_text in old cake system)
A boolean flag that determines if the product it orderable at all
The amount of products that are available
The maximum of amount of items that are orderable in one order
The minimu amount of items that have to be ordered of this product
If true, this will allow the customer to buy more products than are available in stock
The accumulated review data of this product
object
The amount of star-ratings
The average score of the star-ratings
The amount of reviews
The main image of this product, displayed in lists or search results
Base URL of the main image of this product, displayed in lists or search results. GET params for width, height, etc needs to be added.
object
A list of tier prices for this product, if available
object
The minimum order quantity for this tier to apply
The maximum order quantity for this tier to apply
The product price if this tier applies, already includes customer group discount
Additional text which should be displayed near the price, like “12,40€/kg” (amount_info_text in old cake system)
The price in the shop’s selected currency (unit_amount_display/100 in old cake system), which already includes possible customer group discounts
The crossed out price in the shop’s selected currency (unit_amount_display_old/100 in old cake system)
The price of the cheapest variant or child product in the shop’s selected currency (unit_amount_display_min/100 in old cake system), which already includes possible customer group discounts
The price of the most expensive variant or child product in the shop’s selected currency (unit_amount_display_min/100 in old cake system), which already includes possible customer group discounts
The net price in the shop’s selected currency (unit_amount_display/100 in old cake system)
The price with tax in the shop’s selected currency (unit_amount_display/100 in old cake system)
The amount of the taxes (unitPriceWithTax - unitPriceNet) in the shop’s selected currency
The tax percentage for product
The manufacturer’s suggested retail price in the shop’s selected currency
The currency code for this value
object
A flag that determines if this product has children, they have to be loaded separately at the detail page by using getProductChildren_v1 pipeline
A flag that determines if this product has variants, they have to be loaded separately at the detail page by using getProductVariants_v1 pipeline
A flag that determines if this product has options, they have to be loaded separately at the detail page by using getProductOptions_v1 pipeline
A list of liveshopping-timeframes for this product. By default it will load all timeframes, that ended in the last 7 days, are active or will start in the future.
object
The exact start-time for this liveshopping entry
The exact end-time for this liveshopping entry
True if the product is highlighted
Special kind of characteristics which are directly label/value mappings for a certain product. Will only be applied, if the product is a variant.
Type of the product
Example
{ "relations": [ { "id": "fugiat in ea proident", "active": true, "availability": { "text": "cupidatat et", "state": "warning" }, "identifiers": { "sku": "Excepteur cillum qui", "ean": "Duis adipisicing commodo", "isbn": "esse sint incididunt quis", "upc": "voluptate ipsum esse deserunt sit", "pzn": "qu", "mpn": "pariatur velit in Excepteur voluptate" }, "manufacturer": "consequa", "name": "magna", "stock": { "info": "culpa anim quis", "orderable": true, "quantity": 33584205, "maxOrderQuantity": 97366, "minOrderQuantity": 40715739, "ignoreQuantity": true }, "rating": { "count": -59247659, "average": 25.297849903477864, "reviewCount": 34314424 }, "featuredImageUrl": "aute sit sint incididunt", "featuredImageBaseUrl": "aute sit sint incididunt", "price": { "tiers": [ { "from": -83582892, "to": 37186792, "unitPrice": 2959344.3867304474 }, { "from": -98856052, "to": 74887940, "unitPrice": 30726844.985108852 }, { "from": -4848282, "to": 41756552, "unitPrice": 83127520.02787206 }, { "from": 31336171, "to": -19329635, "unitPrice": -1462361.0358020365 }, { "from": -54652192, "to": 54713261, "unitPrice": 85345745.93461573 } ], "info": "exercitation minim et consectetur", "unitPrice": -97660349.16192675, "unitPriceStriked": -18194495.842893764, "unitPriceMin": -1291496.274884805, "unitPriceMax": -66739440.002870426, "unitPriceNet": -31639302.036971807, "unitPriceWithTax": -57485829.53072434, "taxAmount": -36674255.80160968, "taxPercent": -91333010.97812904, "msrp": -34666009.59783288, "currency": "GBP" }, "flags": { "hasChildren": true, "hasVariants": false, "hasOptions": false }, "liveshoppings": [ { "from": "1969-11-29T16:11:35.795Z", "to": "1994-11-04T23:48:32.817Z" }, { "from": "2014-05-22T23:01:08.353Z", "to": "1985-05-20T17:06:55.493Z" }, { "from": "2003-08-27T23:43:43.918Z", "to": "1947-06-28T12:01:01.630Z" } ], "highlight": true, "parent": {}, "characteristics": [ { "id": "dolore commodo eiusmod nisi quis", "label": "veniam eiusmod", "value": "nostrud" } ], "type": "parent", "tags": [ "nostrud est magna", "cupidatat esse ut ", "ut sint sed" ] }, { "id": "velit esse dolor nulla", "active": false, "availability": { "text": "id cupidatat Lorem et", "state": "warning" }, "identifiers": { "sku": "veniam", "ean": "sint officia enim", "isbn": "pariatur consequat", "upc": "non sint dolor", "pzn": "labore dolor est", "mpn": "ullamco do" }, "manufacturer": "Duis labore", "name": "occaecat sint dolore voluptate in", "stock": { "info": "Ut Excepteur q", "orderable": false, "quantity": -25012450, "maxOrderQuantity": 76932951, "minOrderQuantity": 64022416, "ignoreQuantity": true }, "rating": { "count": -66561579, "average": 70.27447201919642, "reviewCount": -64602653 }, "featuredImageUrl": "elit id ex", "featuredImageBaseUrl": "elit id ex", "price": { "tiers": [ { "from": 31459837, "to": -84758361, "unitPrice": -10903565.675326869 }, { "from": 27954442, "to": 99428378, "unitPrice": 82222959.33835292 }, { "from": 13880474, "to": -95094549, "unitPrice": -8793141.929797694 }, { "from": -98520256, "to": -3650994, "unitPrice": 68934162.12560934 } ], "info": "tempor enim sed irure", "unitPrice": -11673818.263900101, "unitPriceStriked": 87650360.979007, "unitPriceMin": 26322028.895985067, "unitPriceMax": -36924499.373529196, "unitPriceNet": -69249499.43070082, "unitPriceWithTax": 55344099.47770777, "taxAmount": 18904177.527472347, "taxPercent": 89781484.37194774, "msrp": 84806869.50166744, "currency": "USD" }, "flags": { "hasChildren": false, "hasVariants": false, "hasOptions": false }, "liveshoppings": [ { "from": "1945-10-05T18:09:44.346Z", "to": "1968-10-12T01:26:17.860Z" }, { "from": "1994-06-03T18:05:11.808Z", "to": "1971-05-10T15:47:35.536Z" }, { "from": "2014-06-23T16:01:59.304Z", "to": "1960-09-06T06:27:39.691Z" }, { "from": "1992-11-24T05:17:00.449Z", "to": "1949-02-07T20:23:58.089Z" } ], "highlight": false, "parent": {}, "characteristics": [ { "id": "nostrud exercitation", "label": "aliqua aliquip consectetur cupidatat", "value": "eu Lorem ex" } ], "type": "variant", "tags": [ "ea nostrud qui incididunt", "nisi ipsum voluptate Ut", "quis", "in reprehenderit quis" ] }, { "id": "officia", "active": true, "availability": { "text": "incididunt Lorem adipisicing", "state": "ok" }, "identifiers": { "sku": "cillum irure", "ean": "reprehenderit ullamco veniam consectetur", "isbn": "qui", "upc": "consequat dolore an", "pzn": "in culpa sit et sunt", "mpn": "voluptate qui quis" }, "manufacturer": "eu nostrud si", "name": "irure commodo dolor", "stock": { "info": "dolor in consectetur aliqua voluptate", "orderable": true, "quantity": -18418697, "maxOrderQuantity": -37263049, "minOrderQuantity": -74893450, "ignoreQuantity": true }, "rating": { "count": 97753704, "average": 48.458780235400425, "reviewCount": 93842926 }, "featuredImageUrl": "sunt", "featuredImageBaseUrl": "sunt", "price": { "tiers": [ { "from": 50211023, "to": -6564418, "unitPrice": -97242752.270364 } ], "info": "Excepteur ut consequat aliqua", "unitPrice": 6980496.577218533, "unitPriceStriked": 49897898.6805501, "unitPriceMin": -81765907.53632814, "unitPriceMax": -78533780.96503079, "unitPriceNet": 58817738.92158297, "unitPriceWithTax": 22937849.687388122, "taxAmount": -91170235.21153134, "taxPercent": -92868074.65811786, "msrp": -42860234.04230721, "currency": "DKK" }, "flags": { "hasChildren": false, "hasVariants": true, "hasOptions": true }, "liveshoppings": [ { "from": "1954-03-15T17:47:03.813Z", "to": "1959-01-06T14:11:05.658Z" }, { "from": "2002-08-15T03:45:58.312Z", "to": "1950-09-09T10:13:59.320Z" }, { "from": "2017-01-27T03:10:50.127Z", "to": "1992-08-06T02:06:06.294Z" }, { "from": "1953-06-04T13:05:04.974Z", "to": "1970-05-25T12:25:36.238Z" } ], "highlight": true, "parent": {}, "characteristics": [ { "id": "magna ipsum commodo incididunt", "label": "ullamco officia qui ", "value": "nulla aliquip in ut" } ], "type": "parent", "tags": [ "in", "commodo ullamco" ] }, { "id": "labore exercitation magn", "active": true, "availability": { "text": "enim", "state": "alert" }, "identifiers": { "sku": "amet voluptate", "ean": "sit in ut sint reprehenderit", "isbn": "id tempor in eu", "upc": "eu occaecat proident", "pzn": "in deserunt pariatur laboris", "mpn": "officia labore" }, "manufacturer": "consectetur nostrud tempor", "name": "non proident", "stock": { "info": "pariatur sunt magna", "orderable": true, "quantity": -58040802, "maxOrderQuantity": 69655341, "minOrderQuantity": -69279506, "ignoreQuantity": true }, "rating": { "count": -53109994, "average": 42.298234510003724, "reviewCount": -24192426 }, "featuredImageUrl": "consectetur Duis incididunt aliqua", "featuredImageBaseUrl": "consectetur Duis incididunt aliqua", "price": { "tiers": [ { "from": 13100591, "to": -3313021, "unitPrice": 81381841.57397857 }, { "from": -70212220, "to": -63240017, "unitPrice": -90758252.75561798 }, { "from": -56384946, "to": 95475672, "unitPrice": 7397228.888709158 }, { "from": 55512443, "to": -87197733, "unitPrice": 50128478.74012542 } ], "info": "culpa irure velit mollit", "unitPrice": 94479459.48307312, "unitPriceStriked": -72554496.34852393, "unitPriceMin": 81564174.19947138, "unitPriceMax": 47261695.12855187, "unitPriceNet": -62017207.54546165, "unitPriceWithTax": 2825490.1051389873, "taxAmount": -19644107.727421194, "taxPercent": -91709558.55789131, "msrp": -36365623.09645166, "currency": "PLN" }, "flags": { "hasChildren": false, "hasVariants": false, "hasOptions": false }, "liveshoppings": [ { "from": "1991-01-06T19:36:15.557Z", "to": "1957-09-18T23:31:56.830Z" }, { "from": "1976-07-05T12:31:16.019Z", "to": "1939-06-23T18:59:13.100Z" }, { "from": "1968-09-16T19:53:35.113Z", "to": "1971-09-09T06:48:28.383Z" }, { "from": "1961-11-04T13:53:16.485Z", "to": "1942-11-07T05:15:46.119Z" } ], "highlight": false, "parent": {}, "characteristics": [ { "id": "ullamco dolore Duis adipisicing", "label": "eu officia cillum dolore", "value": "Ut aliqua amet quis" } ], "type": "parent", "tags": [ "enim", "non dol", "elit adipisicing", "magna adipisicing ipsum" ] } ]}