Search for products in a shop

GET /shops/@shop/products/search

Request

Optional authentication

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

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
shop Int An integer value

Query string (URL)

Append the querystring with following properties to the URL.

A dictionary with fields

Field Type Description
query String A String value

Example request 1

GET /shops/14/products/search?query=... HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.0
Accept-Language: en-US,en;q=0.5

Response

Array of Product.detailed: [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.

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17665

[
    {
        "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
                    }
                ],
                "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": false,
        "price": 12,
        "subtitle": "...",
        "description": "...",
        "allergens": [
            {
                "id": 12,
                "name": "Gluten"
            },
            {
                "id": 15,
                "name": "Egg"
            },
            {
                "id": 19,
                "name": "Sulphite"
            }
        ],
        "url": "https://example.com",
        "url_type": "none",
        "specialty": false,
        "favourite": true,
        "product_prices": [
            {
                "id": 14,
                "name": "...",
                "price": 18
            },
            {
                "id": 14,
                "name": "...",
                "price": 10
            },
            {
                "id": 12,
                "name": "...",
                "price": 14
            }
        ],
        "optionsets": [
            {
                "id": 11,
                "name": "...",
                "allow_attachment": false,
                "options": [
                    {
                        "id": 19,
                        "name": "...",
                        "price_change": 16
                    },
                    {
                        "id": 12,
                        "name": "...",
                        "price_change": 12
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 14
                    }
                ]
            },
            {
                "id": 16,
                "name": "...",
                "allow_attachment": true,
                "options": [
                    {
                        "id": 13,
                        "name": "...",
                        "price_change": 17
                    },
                    {
                        "id": 10,
                        "name": "...",
                        "price_change": 19
                    },
                    {
                        "id": 16,
                        "name": "...",
                        "price_change": 17
                    }
                ]
            },
            {
                "id": 12,
                "name": "...",
                "allow_attachment": false,
                "options": [
                    {
                        "id": 12,
                        "name": "...",
                        "price_change": 11
                    },
                    {
                        "id": 19,
                        "name": "...",
                        "price_change": 19
                    },
                    {
                        "id": 18,
                        "name": "...",
                        "price_change": 12
                    }
                ]
            }
        ],
        "min_max": {
            "amount": {
                "minimum": 15,
                "maximum": 19,
                "suggested": 19
            },
            "weight": {
                "minimum": 17,
                "maximum": 16,
                "suggested": 16
            },
            "persons": {
                "minimum": 14,
                "maximum": 19,
                "suggested": 18
            }
        },
        "info": [
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            }
        ]
    },
    {
        "id": 16,
        "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": 15,
        "subtitle": "...",
        "description": "...",
        "allergens": [
            {
                "id": 15,
                "name": "Milk"
            },
            {
                "id": 13,
                "name": "Milk"
            },
            {
                "id": 17,
                "name": "Milk"
            }
        ],
        "url": "https://example.com",
        "url_type": "none",
        "specialty": true,
        "favourite": false,
        "product_prices": [
            {
                "id": 17,
                "name": "...",
                "price": 14
            },
            {
                "id": 14,
                "name": "...",
                "price": 15
            },
            {
                "id": 11,
                "name": "...",
                "price": 15
            }
        ],
        "optionsets": [
            {
                "id": 15,
                "name": "...",
                "allow_attachment": false,
                "options": [
                    {
                        "id": 18,
                        "name": "...",
                        "price_change": 13
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 18
                    },
                    {
                        "id": 11,
                        "name": "...",
                        "price_change": 16
                    }
                ]
            },
            {
                "id": 15,
                "name": "...",
                "allow_attachment": true,
                "options": [
                    {
                        "id": 14,
                        "name": "...",
                        "price_change": 16
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 10
                    },
                    {
                        "id": 19,
                        "name": "...",
                        "price_change": 16
                    }
                ]
            },
            {
                "id": 15,
                "name": "...",
                "allow_attachment": false,
                "options": [
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 19
                    },
                    {
                        "id": 12,
                        "name": "...",
                        "price_change": 19
                    },
                    {
                        "id": 16,
                        "name": "...",
                        "price_change": 11
                    }
                ]
            }
        ],
        "min_max": {
            "amount": {
                "minimum": 16,
                "maximum": 10,
                "suggested": 15
            },
            "weight": {
                "minimum": 14,
                "maximum": 17,
                "suggested": 12
            },
            "persons": {
                "minimum": 17,
                "maximum": 18,
                "suggested": 18
            }
        },
        "info": [
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            }
        ]
    },
    {
        "id": 13,
        "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": 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": false,
        "price": 12,
        "subtitle": "...",
        "description": "...",
        "allergens": [
            {
                "id": 13,
                "name": "Lactose"
            },
            {
                "id": 14,
                "name": "Soy"
            },
            {
                "id": 19,
                "name": "Sesame"
            }
        ],
        "url": "https://example.com",
        "url_type": "none",
        "specialty": true,
        "favourite": false,
        "product_prices": [
            {
                "id": 17,
                "name": "...",
                "price": 10
            },
            {
                "id": 19,
                "name": "...",
                "price": 14
            },
            {
                "id": 15,
                "name": "...",
                "price": 11
            }
        ],
        "optionsets": [
            {
                "id": 16,
                "name": "...",
                "allow_attachment": true,
                "options": [
                    {
                        "id": 10,
                        "name": "...",
                        "price_change": 12
                    },
                    {
                        "id": 16,
                        "name": "...",
                        "price_change": 11
                    },
                    {
                        "id": 16,
                        "name": "...",
                        "price_change": 10
                    }
                ]
            },
            {
                "id": 11,
                "name": "...",
                "allow_attachment": true,
                "options": [
                    {
                        "id": 18,
                        "name": "...",
                        "price_change": 19
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 16
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 18
                    }
                ]
            },
            {
                "id": 12,
                "name": "...",
                "allow_attachment": true,
                "options": [
                    {
                        "id": 12,
                        "name": "...",
                        "price_change": 14
                    },
                    {
                        "id": 15,
                        "name": "...",
                        "price_change": 12
                    },
                    {
                        "id": 11,
                        "name": "...",
                        "price_change": 12
                    }
                ]
            }
        ],
        "min_max": {
            "amount": {
                "minimum": 11,
                "maximum": 13,
                "suggested": 14
            },
            "weight": {
                "minimum": 13,
                "maximum": 10,
                "suggested": 12
            },
            "persons": {
                "minimum": 14,
                "maximum": 14,
                "suggested": 18
            }
        },
        "info": [
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            },
            {
                "name": "...",
                "title": "...",
                "text": "...",
                "type": "HTML"
            }
        ]
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.0 stable