Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| favourite | Bool | A boolean value |
| category | Dictionary | Optional. A dictionary with fields |
| origin | String | Optional. Translated origin of the product |
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. |
| only_order_in_store | Bool | Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized. |
| subtitle | String? | Nullable. Important text you need to display under the product name |
| description | String | Description of the product (translated) |
| allergens | [Allergen]? | Nullable. The allergens of this product. An empty array means no allergens. Null means no allergens specified (= can have allergens, ask in shop) |
| url | URL? | Nullable. An URL field starting with http:// or https:// |
| url_type | String | String enumarion of 'none', 'recipe', 'website' |
| specialty | Bool | A boolean value |
| favourite | Bool? | Nullable. A boolean value |
| product_prices | [ProductPrice.detailed] | Array of ProductPrice.detailed |
| optionsets | [OptionSet.detailed] | Array of OptionSet.detailed |
| min_max | MinMaxSummary | An overview of the minimum and maximum values for all amount types. |
| info | [Message] | A list of messages with information you need to display on the product page. |
| offer | OfferItem.detailed? | Nullable. Specificies where a discount should get appllied. A shop can give a complete category a discount, or only a certain product, or only a fixed product price. When calculating the discount, always round the price to 1 cent before multiplying it with an amount, persons or kilograms. |
| soldout | Bool | Check if product is soldout or not |
| stock | Dictionary | Amount in stock |
| soldout_until | DateTime? | Nullable. Product is temporarily soldout until |
| plu_code | String? | Nullable. A String value |
| category | Dictionary | Optional. A dictionary with fields |
| origin | String | Optional. Translated origin of the product |
When used inside a request.
{
"favourite": false,
"category": {
"id": 13,
"name": "..."
},
"origin": "..."
}When returned in a response.
{
"id": 14,
"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": 13,
"currency": "EUR"
},
"only_order_in_store": false,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 17,
"name": "Milk"
},
{
"id": 10,
"name": "Egg"
},
{
"id": 15,
"name": "Gluten"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": true,
"product_prices": [
{
"id": 13,
"name": "...",
"price": {
"value": 12,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 11,
"y": 18,
"percentage": 19,
"minimum": 13,
"offer": {
"id": 13,
"name": "Black Friday"
}
}
},
{
"id": 19,
"name": "...",
"price": {
"value": 14,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 11,
"y": 12,
"percentage": 12,
"minimum": 14,
"offer": {
"id": 10,
"name": "Black Friday"
}
}
},
{
"id": 10,
"name": "...",
"price": {
"value": 12,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 11,
"y": 15,
"percentage": 19,
"minimum": 17,
"offer": {
"id": 18,
"name": "Black Friday"
}
}
}
],
"optionsets": [
{
"id": 13,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 12,
"max_different_options": 13,
"min_amount_options": 19,
"max_amount_options": 16,
"options": [
{
"id": 16,
"name": "...",
"price_change": {
"value": 10,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 13,
"name": "...",
"price_change": {
"value": 19,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 13,
"name": "...",
"price_change": {
"value": 16,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
},
{
"id": 13,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 10,
"max_different_options": 17,
"min_amount_options": 12,
"max_amount_options": 16,
"options": [
{
"id": 17,
"name": "...",
"price_change": {
"value": 10,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 14,
"name": "...",
"price_change": {
"value": 15,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 17,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
},
{
"id": 11,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 12,
"max_different_options": 12,
"min_amount_options": 16,
"max_amount_options": 13,
"options": [
{
"id": 13,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 19,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 10,
"name": "...",
"price_change": {
"value": 14,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
}
],
"min_max": {
"amount": {
"minimum": 14,
"maximum": 16,
"suggested": 17
},
"weight": {
"minimum": 13,
"maximum": 18,
"suggested": 17
},
"persons": {
"minimum": 14,
"maximum": 10,
"suggested": 19
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"offer": {
"type": "percentage",
"x": 18,
"y": 10,
"percentage": 10,
"minimum": 12,
"offer": {
"id": 10,
"name": "Black Friday"
}
},
"soldout": true,
"stock": {
"amount": 17
},
"soldout_until": "2019-01-31 12:00:00",
"plu_code": "...",
"category": {
"id": 14,
"name": "..."
},
"origin": "..."
}