GET /shops/@shop/products/@id
You can use authentication for this request, but it is not required. Always provide the access_token when you have one. It may affect the response.
| Header | Value |
|---|---|
| Authorization | Optional. Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| shop | Int | An integer value |
| id | Int | An integer value |
GET /shops/15/products/19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
| 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 |
| ingredients | String | Optional. Translated ingredients of the product |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 19417
{
"id": 19,
"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
}
],
"file_id": 11,
"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
}
],
"file_id": 17,
"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
}
],
"file_id": 17,
"white_background": false
}
],
"price_type": "PER_UNIT",
"target_price": true,
"price": {
"value": 18,
"currency": "EUR"
},
"only_order_in_store": false,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 16,
"name": "Mollusc"
},
{
"id": 17,
"name": "Sesame"
},
{
"id": 12,
"name": "Peanut"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": false,
"favourite": true,
"product_prices": [
{
"id": 13,
"name": "...",
"price": {
"value": 13,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 12,
"y": 14,
"percentage": 18,
"minimum": 18,
"offer": {
"id": 14,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 13,
"recurring_on": {
"day_1": 18,
"day_2": 13,
"day_3": 15,
"day_4": 19,
"day_5": 17,
"day_6": 14,
"day_7": 10
}
},
"applies_to": "category",
"item_id": 15
}
},
{
"id": 12,
"name": "...",
"price": {
"value": 11,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 16,
"y": 14,
"percentage": 12,
"minimum": 12,
"offer": {
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 17,
"recurring_on": {
"day_1": 13,
"day_2": 17,
"day_3": 14,
"day_4": 18,
"day_5": 16,
"day_6": 19,
"day_7": 14
}
},
"applies_to": "category",
"item_id": 12
}
},
{
"id": 12,
"name": "...",
"price": {
"value": 14,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 12,
"y": 17,
"percentage": 10,
"minimum": 19,
"offer": {
"id": 14,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 18,
"recurring_on": {
"day_1": 13,
"day_2": 15,
"day_3": 11,
"day_4": 11,
"day_5": 11,
"day_6": 16,
"day_7": 15
}
},
"applies_to": "category",
"item_id": 18
}
}
],
"optionsets": [
{
"id": 15,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 16,
"max_different_options": 17,
"min_amount_options": 16,
"max_amount_options": 19,
"options": [
{
"id": 12,
"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
}
],
"file_id": 17,
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 15,
"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
}
],
"file_id": 12,
"white_background": false
},
"require_image": true,
"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
}
],
"file_id": 13,
"white_background": true
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
},
{
"id": 10,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 14,
"max_different_options": 19,
"min_amount_options": 12,
"max_amount_options": 12,
"options": [
{
"id": 15,
"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
}
],
"file_id": 19,
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 19,
"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
}
],
"file_id": 17,
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 14,
"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
}
],
"file_id": 11,
"white_background": true
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
},
{
"id": 16,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 13,
"max_different_options": 12,
"min_amount_options": 13,
"max_amount_options": 10,
"options": [
{
"id": 12,
"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
}
],
"file_id": 18,
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"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
}
],
"file_id": 19,
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE"
},
{
"id": 11,
"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
}
],
"file_id": 11,
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE"
}
]
}
],
"min_max": {
"amount": {
"minimum": 17,
"maximum": 15,
"suggested": 18
},
"weight": {
"minimum": 14,
"maximum": 17,
"suggested": 15
},
"persons": {
"minimum": 11,
"maximum": 13,
"suggested": 19
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"offer": {
"type": "percentage",
"x": 19,
"y": 12,
"percentage": 11,
"minimum": 15,
"offer": {
"id": 19,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 17,
"day_2": 19,
"day_3": 16,
"day_4": 15,
"day_5": 11,
"day_6": 16,
"day_7": 16
}
},
"applies_to": "category",
"item_id": 12
},
"soldout": true,
"stock": {
"amount": 14
},
"soldout_until": "2019-01-31 12:00:00",
"plu_code": "...",
"category": {
"id": 12,
"name": "..."
},
"origin": "...",
"ingredients": "..."
}