Fields when send to the api inside a request.
Field | Type | Description |
---|---|---|
favourite | Bool | A boolean value |
Fields when returned by the api in a response.
Field | Type | Description |
---|---|---|
id | Int | Id of the product |
name | String | Name of the product (translated) |
images | [Image] | Array of Image |
price_type | PriceType | A product has a price type that defines the price calculations and the way consumers can order the product. |
target_price | Bool | Is true when the price of the product can change on takeout (e.g. not exact weight) |
price | Price | Price of the product (cents). It only makes sense to use this property when price_type is not multiple choice. Please also check if the shop where you want to order has an offer with a discount for this product available. |
When used inside a request.
{
"favourite": true
}
When returned in a response.
{
"id": 17,
"name": "...",
"images": [
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 11,
"currency": "EUR"
}
}