Return all favourites the current user has in a shop

GET /shops/@shop/favourites

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization 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

Example request 1 Return all favourites without inactive categories and products

GET /shops/2828/favourites HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer 8057bb273511251742f697eb5620e4d2d9941be389f60a822231daa581bb1e7b82d59d2a5371cfb9a22cf765c8fcaf8b2ef345d2fd368fb574f9ed0b2e2ff0dfb4e170073065b498a28543565a15ec4b10b65965224149c441550f2f4da9ca1e31ecb97b
X-VERSION: 1.5.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 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.
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? 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.

Example response 1 Return all favourites without inactive categories and products

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

[
    {
        "id": 6570,
        "name": "Pistolet grof",
        "price": {
            "value": 320,
            "currency": "EUR"
        },
        "images": [
            {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/tests/250x200/product-pistolet-plaat-groot.jpg",
                        "width": 300,
                        "height": 200
                    },
                    {
                        "src": "https://bakeronline.be/uploads/tests/1080x720/product-pistolet-plaat-groot.jpg",
                        "width": 1080,
                        "height": 720
                    }
                ],
                "white_background": true
            }
        ],
        "price_type": "PER_KILOGRAM",
        "target_price": true,
        "subtitle": null,
        "description": "",
        "allergens": [
            {
                "id": 1,
                "name": "1319"
            },
            {
                "id": 2,
                "name": "1320"
            },
            {
                "id": 3,
                "name": "1321"
            },
            {
                "id": 4,
                "name": "1322"
            },
            {
                "id": 6,
                "name": "1324"
            },
            {
                "id": 7,
                "name": "1325"
            },
            {
                "id": 9,
                "name": "1327"
            },
            {
                "id": 10,
                "name": "1328"
            },
            {
                "id": 11,
                "name": "1329"
            },
            {
                "id": 12,
                "name": "1330"
            },
            {
                "id": 13,
                "name": "1331"
            },
            {
                "id": 14,
                "name": "1332"
            }
        ],
        "url": null,
        "url_type": "none",
        "specialty": false,
        "favourite": true,
        "product_prices": [],
        "optionsets": [
            {
                "id": 7738,
                "name": "Extra baked?",
                "code": null,
                "options": [
                    {
                        "id": 27190,
                        "name": "No thank you",
                        "price_change": {
                            "value": 252,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27191,
                        "name": "Yes please",
                        "price_change": {
                            "value": 648,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    }
                ]
            }
        ],
        "min_max": {
            "amount": {
                "suggested": 1,
                "minimum": 1,
                "maximum": null
            },
            "weight": {
                "suggested": 100,
                "minimum": 1,
                "maximum": null
            },
            "persons": {
                "suggested": 1,
                "minimum": 1,
                "maximum": null
            }
        },
        "info": [
            {
                "name": "availability-takeout",
                "title": "6736",
                "text": "<p>3841</p>",
                "type": "HTML"
            },
            {
                "name": "availability-delivery",
                "title": "5674",
                "text": "<p>3841</p>",
                "type": "HTML"
            },
            {
                "name": "ingredients",
                "title": "3881",
                "text": "A list of ingredients here",
                "type": "PLAIN"
            },
            {
                "name": "allergens",
                "title": "3882",
                "text": "3883",
                "type": "PLAIN"
            }
        ],
        "offer": {
            "type": "percentage",
            "x": null,
            "y": null,
            "percentage": 1000,
            "minimum": null,
            "offer": {
                "id": 192,
                "name": "Black Friday"
            }
        }
    },
    {
        "id": 6571,
        "name": "Authentiek bruin pistolet",
        "price": {
            "value": 8413,
            "currency": "EUR"
        },
        "images": [
            {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/tests/250x200/product-multigranenbroodje.jpg",
                        "width": 300,
                        "height": 200
                    },
                    {
                        "src": "https://bakeronline.be/uploads/tests/1080x720/product-multigranenbroodje.jpg",
                        "width": 1080,
                        "height": 720
                    }
                ],
                "white_background": true
            }
        ],
        "price_type": "MULTIPLE_CHOICE",
        "target_price": false,
        "subtitle": null,
        "description": "Random product description",
        "allergens": [
            {
                "id": 2,
                "name": "1320"
            },
            {
                "id": 3,
                "name": "1321"
            },
            {
                "id": 4,
                "name": "1322"
            },
            {
                "id": 5,
                "name": "1323"
            },
            {
                "id": 6,
                "name": "1324"
            },
            {
                "id": 7,
                "name": "1325"
            },
            {
                "id": 8,
                "name": "1326"
            },
            {
                "id": 9,
                "name": "1327"
            },
            {
                "id": 10,
                "name": "1328"
            },
            {
                "id": 11,
                "name": "1329"
            },
            {
                "id": 14,
                "name": "1332"
            },
            {
                "id": 15,
                "name": "1333"
            }
        ],
        "url": null,
        "url_type": "none",
        "specialty": false,
        "favourite": true,
        "product_prices": [
            {
                "id": 4562,
                "name": "7 persons",
                "price": {
                    "value": 14,
                    "currency": "EUR"
                },
                "offer": {
                    "type": "percentage",
                    "x": null,
                    "y": null,
                    "percentage": 2000,
                    "minimum": null,
                    "offer": {
                        "id": 192,
                        "name": "Black Friday"
                    }
                }
            },
            {
                "id": 4563,
                "name": "3 persons",
                "price": {
                    "value": 16,
                    "currency": "EUR"
                },
                "offer": null
            },
            {
                "id": 4564,
                "name": "2 persons",
                "price": {
                    "value": 46,
                    "currency": "EUR"
                },
                "offer": null
            }
        ],
        "optionsets": [
            {
                "id": 7739,
                "name": "Do you want your bread sliced?",
                "code": null,
                "options": [
                    {
                        "id": 27192,
                        "name": "Yes please",
                        "price_change": {
                            "value": 232,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27193,
                        "name": "Yes",
                        "price_change": {
                            "value": 171,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    }
                ]
            },
            {
                "id": 7740,
                "name": "Do you want your bread sliced?",
                "code": null,
                "options": [
                    {
                        "id": 27194,
                        "name": "No thank you",
                        "price_change": {
                            "value": 405,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27195,
                        "name": "No thank you",
                        "price_change": {
                            "value": 832,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27196,
                        "name": "No thank you",
                        "price_change": {
                            "value": 503,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27197,
                        "name": "Yes",
                        "price_change": {
                            "value": 904,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    },
                    {
                        "id": 27198,
                        "name": "No thank you",
                        "price_change": {
                            "value": 426,
                            "currency": "EUR"
                        },
                        "image": null,
                        "require_image": false,
                        "code": null
                    }
                ]
            }
        ],
        "min_max": {
            "amount": {
                "suggested": 1,
                "minimum": 1,
                "maximum": null
            },
            "weight": {
                "suggested": 100,
                "minimum": 1,
                "maximum": null
            },
            "persons": {
                "suggested": 1,
                "minimum": 1,
                "maximum": null
            }
        },
        "info": [
            {
                "name": "description",
                "title": "3879",
                "text": "Random product description",
                "type": "PLAIN"
            },
            {
                "name": "availability-takeout",
                "title": "6736",
                "text": "<p>3841</p>",
                "type": "HTML"
            },
            {
                "name": "availability-delivery",
                "title": "5674",
                "text": "<p>3841</p>",
                "type": "HTML"
            },
            {
                "name": "allergens",
                "title": "3882",
                "text": "3883",
                "type": "PLAIN"
            }
        ],
        "offer": null
    }
]
Version update available Please adjust your integration to the latest stable version (1.5.2)
1.5.0 stable