Get shop by id

GET /shops/@id

Request

URL parameters

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

A dictionary with fields

Field Type Description
id Int An integer value

Example request 1

GET /shops/17 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.8.0
Accept-Language: en-US,en;q=0.5

Response

Field Type Description
id Int Id of the shop
name String Name of the shop (translated)
address Address.detailed An address
allow_comments Bool A boolean value
url String A String value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
allow_order_messages Bool A boolean value
global_discount_percentage Int Discount percentage for all products
offers [Offer.detailed] Array of Offer.detailed
images [String: Image] Dictionary of Image with keys of type String
allow_orders Bool A boolean value
delivery_use_intervals Bool A boolean value
categories [Category.simple] Array of Category.simple
category_groups [CategoryGroup] List of category groups. The ids refer to a category in the categories field. Categories without a CategoryGroup should also get displayed.
allow_invoices Bool A boolean value
category_groups_overview Bool Show an overview of all the category groups on the webshop homepage
display_mode String String enumarion of 'blocks', 'list'
takeout_use_intervals Bool A boolean value
joyn_enabled Bool A boolean value
category_overview Bool Show an overview of all the categories on the webshop homepage
fold_category_groups Bool Whether the shop prefers to hide all the categories for all category groups by default
hours [MethodHours] Information about the opening hours, delivery hours... for all available methods and machines
contact Contact Contact details of a shop
messages [Message] You are required to keep track of the messages the user saw. When you receive new messages, you should indicate this in the app with a bubble icon (e.g. red circle with number of new messages)
info [Message] Same as messages, but you shouldn't notify the user when this changes or is received for the first time
status ShopStatus
has_specialties Bool A boolean value
currency Currency 3 letter ISO 4217 currency name (string)

Example response 1

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

{
    "id": 14,
    "name": "Zelda Upton",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "url": "...",
    "allow_order_comments": false,
    "allow_product_comments": true,
    "allow_order_messages": false,
    "global_discount_percentage": 17,
    "offers": [
        {
            "id": 10,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 10,
            "recurring_on": {
                "day_1": 13,
                "day_2": 15,
                "day_3": 15,
                "day_4": 14,
                "day_5": 11,
                "day_6": 11,
                "day_7": 14
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 13,
                    "y": 17,
                    "percentage": 19,
                    "minimum": 11,
                    "applies_to": "category",
                    "item_id": 18
                },
                {
                    "type": "percentage",
                    "x": 11,
                    "y": 17,
                    "percentage": 16,
                    "minimum": 15,
                    "applies_to": "category",
                    "item_id": 14
                },
                {
                    "type": "percentage",
                    "x": 12,
                    "y": 12,
                    "percentage": 19,
                    "minimum": 13,
                    "applies_to": "category",
                    "item_id": 19
                }
            ]
        },
        {
            "id": 17,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 13,
            "recurring_on": {
                "day_1": 11,
                "day_2": 18,
                "day_3": 18,
                "day_4": 16,
                "day_5": 18,
                "day_6": 15,
                "day_7": 15
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 12,
                    "y": 10,
                    "percentage": 18,
                    "minimum": 18,
                    "applies_to": "category",
                    "item_id": 17
                },
                {
                    "type": "percentage",
                    "x": 16,
                    "y": 14,
                    "percentage": 16,
                    "minimum": 11,
                    "applies_to": "category",
                    "item_id": 12
                },
                {
                    "type": "percentage",
                    "x": 14,
                    "y": 11,
                    "percentage": 14,
                    "minimum": 11,
                    "applies_to": "category",
                    "item_id": 11
                }
            ]
        },
        {
            "id": 15,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 18,
            "recurring_on": {
                "day_1": 11,
                "day_2": 18,
                "day_3": 15,
                "day_4": 10,
                "day_5": 10,
                "day_6": 11,
                "day_7": 18
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 12,
                    "y": 18,
                    "percentage": 17,
                    "minimum": 10,
                    "applies_to": "category",
                    "item_id": 12
                },
                {
                    "type": "percentage",
                    "x": 10,
                    "y": 12,
                    "percentage": 15,
                    "minimum": 13,
                    "applies_to": "category",
                    "item_id": 14
                },
                {
                    "type": "percentage",
                    "x": 12,
                    "y": 12,
                    "percentage": 16,
                    "minimum": 19,
                    "applies_to": "category",
                    "item_id": 11
                }
            ]
        }
    ],
    "images": {
        "avatar": {
            "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
        }
    },
    "allow_orders": false,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 13,
            "name": "Prof. Edwina Reichert IV",
            "banner": {
                "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
            },
            "only_order_in_store": true,
            "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
            },
            "seo": {
                "title": {
                    "en": "Perspiciatis nulla vel occaecati repellat maiores optio tempora."
                },
                "description": {
                    "en": "Sequi harum eum iste repellat ducimus rerum. Explicabo dolorum tempore impedit quibusdam dolores. Minima reiciendis ut dolore in incidunt et. Aliquid quis veniam in qui."
                },
                "url": {
                    "en": "https://www.anderson.org/voluptate-quia-nihil-magnam-quis-provident-minus-et"
                }
            }
        },
        {
            "id": 14,
            "name": "Alan Kreiger",
            "banner": {
                "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
            },
            "only_order_in_store": true,
            "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
            },
            "seo": {
                "title": {
                    "en": "Maxime deserunt quo corporis placeat quia veniam libero quia nulla."
                },
                "description": {
                    "en": "Et deserunt et aut vel aut quis. Error tempore officiis commodi deserunt. Modi nihil eum aspernatur."
                },
                "url": {
                    "en": "http://nitzsche.biz/molestiae-ut-accusantium-voluptatem-cupiditate-molestiae-eos"
                }
            }
        },
        {
            "id": 17,
            "name": "Christa Monahan",
            "banner": {
                "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
            },
            "only_order_in_store": false,
            "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
            },
            "seo": {
                "title": {
                    "en": "Quia placeat voluptatum natus et qui."
                },
                "description": {
                    "en": "Perspiciatis totam dicta enim consequatur. Natus similique earum culpa blanditiis earum temporibus. Alias autem necessitatibus magni ut maxime. Vel velit consequatur labore molestiae tenetur dolores."
                },
                "url": {
                    "en": "http://windler.org/laboriosam-ut-rem-quis"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                18,
                15,
                15
            ],
            "id": 16,
            "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
            }
        },
        {
            "name": "...",
            "category_ids": [
                14,
                19,
                17
            ],
            "id": 15,
            "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
            }
        },
        {
            "name": "...",
            "category_ids": [
                19,
                17,
                16
            ],
            "id": 10,
            "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
            }
        }
    ],
    "allow_invoices": false,
    "category_groups_overview": true,
    "display_mode": "blocks",
    "takeout_use_intervals": true,
    "joyn_enabled": true,
    "category_overview": true,
    "fold_category_groups": false,
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:54 - 18:36",
                        "07:54 - 18:36",
                        "07:54 - 18:36"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:52 - 15:25",
                        "09:52 - 15:25",
                        "09:52 - 15:25"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:45 - 11:59",
                        "07:45 - 11:59",
                        "07:45 - 11:59"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:59 - 13:13",
                        "08:59 - 13:13",
                        "08:59 - 13:13"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:36 - 13:14",
                        "06:36 - 13:14",
                        "06:36 - 13:14"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:34 - 18:35",
                        "08:34 - 18:35",
                        "08:34 - 18:35"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:11 - 20:39",
                        "08:11 - 20:39",
                        "08:11 - 20:39"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:42 - 11:17",
                        "07:42 - 11:17",
                        "07:42 - 11:17"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:15 - 19:20",
                        "07:15 - 19:20",
                        "07:15 - 19:20"
                    ]
                }
            ]
        }
    ],
    "contact": {
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        },
        "telephone": "+32 475 00 00 00",
        "vat": "BE0123.456.789",
        "social": {
            "facebook": "https://example.com",
            "twitter": "https://example.com",
            "snapchat": "https://example.com",
            "instagram": "https://example.com",
            "pinterest": "https://example.com",
            "youtube": "https://example.com"
        },
        "website": "https://example.com",
        "email": "example@domain.com"
    },
    "messages": [
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        }
    ],
    "info": [
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        }
    ],
    "status": {
        "open": {
            "status": "closes-soon",
            "text": "..."
        },
        "takeout": "...",
        "delivery": "...",
        "latch": "..."
    },
    "has_specialties": true,
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable