Get shop by url

GET /shops/url/@url

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
url String A String value

Example request 1

GET /shops/url/... 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: 19584

{
    "id": 19,
    "name": "Craig Friesen",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": false,
    "url": "...",
    "allow_order_comments": false,
    "allow_product_comments": true,
    "allow_order_messages": true,
    "global_discount_percentage": 17,
    "offers": [
        {
            "id": 16,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 17,
            "recurring_on": {
                "day_1": 17,
                "day_2": 13,
                "day_3": 16,
                "day_4": 14,
                "day_5": 17,
                "day_6": 10,
                "day_7": 12
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 13,
                    "y": 17,
                    "percentage": 14,
                    "minimum": 16,
                    "applies_to": "category",
                    "item_id": 13
                },
                {
                    "type": "percentage",
                    "x": 16,
                    "y": 18,
                    "percentage": 14,
                    "minimum": 17,
                    "applies_to": "category",
                    "item_id": 17
                },
                {
                    "type": "percentage",
                    "x": 17,
                    "y": 10,
                    "percentage": 13,
                    "minimum": 19,
                    "applies_to": "category",
                    "item_id": 11
                }
            ]
        },
        {
            "id": 16,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 14,
            "recurring_on": {
                "day_1": 18,
                "day_2": 16,
                "day_3": 16,
                "day_4": 18,
                "day_5": 14,
                "day_6": 13,
                "day_7": 12
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 16,
                    "y": 19,
                    "percentage": 16,
                    "minimum": 16,
                    "applies_to": "category",
                    "item_id": 18
                },
                {
                    "type": "percentage",
                    "x": 11,
                    "y": 15,
                    "percentage": 12,
                    "minimum": 19,
                    "applies_to": "category",
                    "item_id": 15
                },
                {
                    "type": "percentage",
                    "x": 19,
                    "y": 16,
                    "percentage": 13,
                    "minimum": 16,
                    "applies_to": "category",
                    "item_id": 10
                }
            ]
        },
        {
            "id": 10,
            "name": "Black Friday",
            "from_date": "2019-01-31",
            "until_date": "2019-01-31",
            "valid_for": "order",
            "recurring": 12,
            "recurring_on": {
                "day_1": 13,
                "day_2": 10,
                "day_3": 18,
                "day_4": 17,
                "day_5": 10,
                "day_6": 18,
                "day_7": 14
            },
            "items": [
                {
                    "type": "percentage",
                    "x": 19,
                    "y": 17,
                    "percentage": 11,
                    "minimum": 16,
                    "applies_to": "category",
                    "item_id": 15
                },
                {
                    "type": "percentage",
                    "x": 13,
                    "y": 19,
                    "percentage": 17,
                    "minimum": 13,
                    "applies_to": "category",
                    "item_id": 17
                },
                {
                    "type": "percentage",
                    "x": 17,
                    "y": 12,
                    "percentage": 17,
                    "minimum": 15,
                    "applies_to": "category",
                    "item_id": 16
                }
            ]
        }
    ],
    "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": 12,
            "white_background": true
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 13,
            "name": "Miss Charlotte Mueller 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": 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": 18,
                "white_background": false
            },
            "seo": {
                "title": {
                    "en": "Soluta mollitia provident perferendis atque blanditiis officiis minima eum reprehenderit."
                },
                "description": {
                    "en": "Fugiat est sapiente veritatis nihil. Est quia rerum incidunt hic ad magnam non. Est itaque aut in et nobis. Itaque animi totam ipsum debitis laudantium vero eum."
                },
                "url": {
                    "en": "http://www.prosacco.com/deserunt-est-recusandae-explicabo-inventore"
                }
            }
        },
        {
            "id": 12,
            "name": "Tristian Jones",
            "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": 12,
                "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": 18,
                "white_background": true
            },
            "seo": {
                "title": {
                    "en": "Amet corporis non eligendi necessitatibus quos repellendus est voluptate culpa."
                },
                "description": {
                    "en": "Corrupti saepe provident unde voluptatibus sit ullam. Aliquam reiciendis dicta non distinctio placeat magni. Ut iusto sunt consectetur minus a quia."
                },
                "url": {
                    "en": "http://www.moore.com/"
                }
            }
        },
        {
            "id": 16,
            "name": "Mr. Christian Grimes II",
            "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": 17,
                "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": 11,
                "white_background": true
            },
            "seo": {
                "title": {
                    "en": "Delectus ut dignissimos qui pariatur voluptas qui earum."
                },
                "description": {
                    "en": "Excepturi qui vel iure architecto amet. Adipisci libero voluptatem quidem porro."
                },
                "url": {
                    "en": "https://www.rutherford.biz/cum-ratione-iusto-earum-mollitia-id-est-molestias-fuga"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                18,
                10,
                16
            ],
            "id": 18,
            "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": 13,
                "white_background": true
            }
        },
        {
            "name": "...",
            "category_ids": [
                15,
                14,
                12
            ],
            "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
                    }
                ],
                "file_id": 14,
                "white_background": false
            }
        },
        {
            "name": "...",
            "category_ids": [
                13,
                19,
                10
            ],
            "id": 13,
            "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": 11,
                "white_background": true
            }
        }
    ],
    "allow_invoices": false,
    "category_groups_overview": true,
    "display_mode": "blocks",
    "takeout_use_intervals": true,
    "joyn_enabled": false,
    "category_overview": true,
    "fold_category_groups": false,
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:58 - 13:21",
                        "08:58 - 13:21",
                        "08:58 - 13:21"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:36 - 17:30",
                        "07:36 - 17:30",
                        "07:36 - 17:30"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:28 - 10:33",
                        "09:28 - 10:33",
                        "09:28 - 10:33"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:16 - 16:33",
                        "08:16 - 16:33",
                        "08:16 - 16:33"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:17 - 13:22",
                        "06:17 - 13:22",
                        "06:17 - 13:22"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:44 - 15:12",
                        "09:44 - 15:12",
                        "09:44 - 15:12"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "06:40 - 16:19",
                        "06:40 - 16:19",
                        "06:40 - 16:19"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:14 - 15:11",
                        "09:14 - 15:11",
                        "09:14 - 15:11"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:26 - 13:44",
                        "07:26 - 13:44",
                        "07:26 - 13:44"
                    ]
                }
            ]
        }
    ],
    "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": 11,
        "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": 11,
            "white_background": false
        }
    },
    "delivery": {
        "range": {
            "all_zipcodes": true,
            "has_max_range": true,
            "max_range": 12
        }
    },
    "currency": "EUR"
}
This is a development version Do not use this version in production
1.10.0 development