GET /shops/@shop/products/search
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 |
Append the querystring with following properties to the URL.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| query | String | A String value |
GET /shops/10/products/search?query=... HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.1
Accept-Language: en-US,en;q=0.5
Array of Product.detailed: [Product.detailed]
| 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 | Int | 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. |
| 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. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17681
[
{
"id": 12,
"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": true
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": 16,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 15,
"name": "Lactose"
},
{
"id": 13,
"name": "Milk"
},
{
"id": 19,
"name": "Crustaceans"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": false,
"product_prices": [
{
"id": 17,
"name": "...",
"price": 17
},
{
"id": 12,
"name": "...",
"price": 15
},
{
"id": 15,
"name": "...",
"price": 16
}
],
"optionsets": [
{
"id": 17,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 10,
"name": "...",
"price_change": 12
},
{
"id": 19,
"name": "...",
"price_change": 12
},
{
"id": 14,
"name": "...",
"price_change": 11
}
]
},
{
"id": 17,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 13,
"name": "...",
"price_change": 16
},
{
"id": 17,
"name": "...",
"price_change": 16
},
{
"id": 12,
"name": "...",
"price_change": 13
}
]
},
{
"id": 10,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 12,
"name": "...",
"price_change": 11
},
{
"id": 17,
"name": "...",
"price_change": 13
},
{
"id": 13,
"name": "...",
"price_change": 14
}
]
}
],
"min_max": {
"amount": {
"minimum": 10,
"maximum": 18,
"suggested": 13
},
"weight": {
"minimum": 14,
"maximum": 13,
"suggested": 17
},
"persons": {
"minimum": 14,
"maximum": 11,
"suggested": 11
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
},
{
"id": 12,
"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": 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": 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": true
}
],
"price_type": "PER_UNIT",
"target_price": true,
"price": 12,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 10,
"name": "Mustard"
},
{
"id": 16,
"name": "Celery"
},
{
"id": 19,
"name": "Mustard"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": false,
"product_prices": [
{
"id": 17,
"name": "...",
"price": 16
},
{
"id": 14,
"name": "...",
"price": 10
},
{
"id": 18,
"name": "...",
"price": 17
}
],
"optionsets": [
{
"id": 14,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 16,
"name": "...",
"price_change": 16
},
{
"id": 14,
"name": "...",
"price_change": 14
},
{
"id": 12,
"name": "...",
"price_change": 10
}
]
},
{
"id": 17,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 19,
"name": "...",
"price_change": 11
},
{
"id": 18,
"name": "...",
"price_change": 16
},
{
"id": 10,
"name": "...",
"price_change": 14
}
]
},
{
"id": 13,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 10,
"name": "...",
"price_change": 10
},
{
"id": 17,
"name": "...",
"price_change": 14
},
{
"id": 10,
"name": "...",
"price_change": 18
}
]
}
],
"min_max": {
"amount": {
"minimum": 12,
"maximum": 11,
"suggested": 16
},
"weight": {
"minimum": 15,
"maximum": 13,
"suggested": 19
},
"persons": {
"minimum": 18,
"maximum": 10,
"suggested": 12
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
},
{
"id": 15,
"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": 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
},
{
"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": true,
"price": 15,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 16,
"name": "Soy"
},
{
"id": 13,
"name": "Mustard"
},
{
"id": 11,
"name": "Crustaceans"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": false,
"product_prices": [
{
"id": 15,
"name": "...",
"price": 18
},
{
"id": 10,
"name": "...",
"price": 14
},
{
"id": 13,
"name": "...",
"price": 10
}
],
"optionsets": [
{
"id": 10,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 19,
"name": "...",
"price_change": 11
},
{
"id": 10,
"name": "...",
"price_change": 12
},
{
"id": 17,
"name": "...",
"price_change": 11
}
]
},
{
"id": 13,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 10,
"name": "...",
"price_change": 15
},
{
"id": 18,
"name": "...",
"price_change": 10
},
{
"id": 18,
"name": "...",
"price_change": 19
}
]
},
{
"id": 14,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 12,
"name": "...",
"price_change": 12
},
{
"id": 16,
"name": "...",
"price_change": 16
},
{
"id": 16,
"name": "...",
"price_change": 10
}
]
}
],
"min_max": {
"amount": {
"minimum": 19,
"maximum": 12,
"suggested": 13
},
"weight": {
"minimum": 14,
"maximum": 18,
"suggested": 17
},
"persons": {
"minimum": 16,
"maximum": 10,
"suggested": 13
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
}
]