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/12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.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
promotion Promotion The info about the shop promotion
delivery Dictionary A dictionary with fields
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: 19629

{
    "id": 10,
    "name": "Dr. Flossie Kozey V",
    "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": true,
    "allow_product_comments": true,
    "allow_order_messages": false,
    "global_discount_percentage": 10,
    "offers": [
        {
            "id": 18,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 14,
            "recurring_on": {
                "day_1": 16,
                "day_2": 14,
                "day_3": 18,
                "day_4": 12,
                "day_5": 16,
                "day_6": 11,
                "day_7": 17
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 17,
                    "y": 15,
                    "percentage": 11,
                    "minimum": 15,
                    "applies_to": "category",
                    "item_id": 18
                },
                {
                    "type": "percentage",
                    "x": 15,
                    "y": 18,
                    "percentage": 10,
                    "minimum": 19,
                    "applies_to": "category",
                    "item_id": 13
                },
                {
                    "type": "percentage",
                    "x": 14,
                    "y": 11,
                    "percentage": 19,
                    "minimum": 13,
                    "applies_to": "category",
                    "item_id": 12
                }
            ]
        },
        {
            "id": 15,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 10,
            "recurring_on": {
                "day_1": 19,
                "day_2": 14,
                "day_3": 13,
                "day_4": 11,
                "day_5": 15,
                "day_6": 13,
                "day_7": 14
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 17,
                    "y": 13,
                    "percentage": 10,
                    "minimum": 17,
                    "applies_to": "category",
                    "item_id": 18
                },
                {
                    "type": "percentage",
                    "x": 14,
                    "y": 18,
                    "percentage": 12,
                    "minimum": 18,
                    "applies_to": "category",
                    "item_id": 19
                },
                {
                    "type": "percentage",
                    "x": 10,
                    "y": 15,
                    "percentage": 13,
                    "minimum": 10,
                    "applies_to": "category",
                    "item_id": 12
                }
            ]
        },
        {
            "id": 11,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 11,
            "recurring_on": {
                "day_1": 18,
                "day_2": 18,
                "day_3": 14,
                "day_4": 12,
                "day_5": 11,
                "day_6": 11,
                "day_7": 19
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 16,
                    "y": 15,
                    "percentage": 19,
                    "minimum": 15,
                    "applies_to": "category",
                    "item_id": 14
                },
                {
                    "type": "percentage",
                    "x": 18,
                    "y": 17,
                    "percentage": 17,
                    "minimum": 11,
                    "applies_to": "category",
                    "item_id": 10
                },
                {
                    "type": "percentage",
                    "x": 18,
                    "y": 19,
                    "percentage": 17,
                    "minimum": 12,
                    "applies_to": "category",
                    "item_id": 13
                }
            ]
        }
    ],
    "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
                }
            ],
            "file_id": 10,
            "white_background": false
        }
    },
    "allow_orders": false,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 10,
            "name": "Jovanny Fay",
            "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
                    }
                ],
                "file_id": 10,
                "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
                    }
                ],
                "file_id": 14,
                "white_background": true
            },
            "seo": {
                "title": {
                    "en": "Ut dicta corporis modi qui mollitia."
                },
                "description": {
                    "en": "Velit quis odit quo eos ut unde recusandae totam. Ea ut adipisci asperiores a. Ipsam quia eum voluptate accusantium occaecati et omnis. Quibusdam omnis ut sed commodi quis fugit."
                },
                "url": {
                    "en": "http://pouros.biz/odit-et-culpa-rerum-voluptatem-natus"
                }
            }
        },
        {
            "id": 18,
            "name": "Ines Fay III",
            "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
                    }
                ],
                "file_id": 18,
                "white_background": false
            },
            "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
                    }
                ],
                "file_id": 15,
                "white_background": false
            },
            "seo": {
                "title": {
                    "en": "Aut nesciunt dicta quae quasi inventore minus odio aut cum."
                },
                "description": {
                    "en": "Recusandae nisi eaque velit odit. Velit quaerat tempora error id quibusdam ipsa. Quidem sequi cupiditate sint debitis ea ut. Sit et sunt natus in occaecati."
                },
                "url": {
                    "en": "https://www.kuphal.com/sint-vitae-delectus-nesciunt-velit-sit-recusandae-quae"
                }
            }
        },
        {
            "id": 12,
            "name": "Miss Hope Mitchell I",
            "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
                    }
                ],
                "file_id": 14,
                "white_background": false
            },
            "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
                    }
                ],
                "file_id": 19,
                "white_background": false
            },
            "seo": {
                "title": {
                    "en": "Laudantium totam necessitatibus officiis debitis nihil molestiae necessitatibus iste veniam deserunt."
                },
                "description": {
                    "en": "Voluptates nisi maiores voluptatem omnis ut. Harum est corporis ullam saepe. Sint veritatis qui qui ut ab. Ut quia non quia."
                },
                "url": {
                    "en": "http://oreilly.biz/doloribus-blanditiis-voluptas-quo-a"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                19,
                19,
                19
            ],
            "id": 12,
            "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
            }
        },
        {
            "name": "...",
            "category_ids": [
                11,
                12,
                10
            ],
            "id": 17,
            "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": 15,
                "white_background": false
            }
        },
        {
            "name": "...",
            "category_ids": [
                10,
                16,
                15
            ],
            "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
                    }
                ],
                "file_id": 12,
                "white_background": true
            }
        }
    ],
    "allow_invoices": false,
    "category_groups_overview": true,
    "display_mode": "blocks",
    "takeout_use_intervals": false,
    "joyn_enabled": true,
    "category_overview": true,
    "fold_category_groups": true,
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:30 - 17:15",
                        "09:30 - 17:15",
                        "09:30 - 17:15"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:42 - 19:18",
                        "08:42 - 19:18",
                        "08:42 - 19:18"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:53 - 16:41",
                        "07:53 - 16:41",
                        "07:53 - 16:41"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:17 - 15:27",
                        "08:17 - 15:27",
                        "08:17 - 15:27"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:43 - 10:27",
                        "09:43 - 10:27",
                        "09:43 - 10:27"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:11 - 17:33",
                        "07:11 - 17:33",
                        "07:11 - 17:33"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:40 - 10:44",
                        "09:40 - 10:44",
                        "09:40 - 10:44"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:38 - 10:31",
                        "09:38 - 10:31",
                        "09:38 - 10:31"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:56 - 14:18",
                        "07:56 - 14:18",
                        "07:56 - 14:18"
                    ]
                }
            ]
        }
    ],
    "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": false,
    "promotion": {
        "is_enabled": true,
        "title": "...",
        "type": "product",
        "id": 12,
        "custom_image_enabled": false,
        "photo": {
            "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": true
        }
    },
    "delivery": {
        "range": {
            "all_zipcodes": false,
            "has_max_range": true,
            "max_range": 17
        }
    },
    "currency": "EUR"
}
This is a development version Do not use this version in production
1.10.0 development