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.7.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
offers [Offer.simple] Array of Offer.simple
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: 14544

{
    "id": 16,
    "name": "Jasmin Heller",
    "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": false,
    "allow_order_messages": true,
    "offers": [
        {
            "id": 14,
            "name": "Black Friday"
        },
        {
            "id": 12,
            "name": "Black Friday"
        },
        {
            "id": 18,
            "name": "Black Friday"
        }
    ],
    "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": true
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 16,
            "name": "Justine Harvey",
            "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": true
            },
            "seo": {
                "title": {
                    "en": "Et repellendus consectetur maxime repellat mollitia voluptatum corporis."
                },
                "description": {
                    "en": "Debitis nihil sit unde facere accusantium tenetur nemo nobis. Earum excepturi et quia molestiae dolor eius assumenda porro. Veritatis nisi sit nisi rerum. Labore fugit dolorem minima sunt temporibus."
                },
                "url": {
                    "en": "http://www.rempel.com/itaque-voluptatem-ipsa-voluptatem-voluptates-eum-aut-ullam"
                }
            }
        },
        {
            "id": 12,
            "name": "Cathryn Hudson",
            "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": "Quidem libero temporibus aspernatur dignissimos ut qui."
                },
                "description": {
                    "en": "Nihil est ea quo dolorum nisi quia veritatis fugit. Maxime sint et voluptatem quo quidem praesentium. Numquam quia saepe voluptatem sed ut et."
                },
                "url": {
                    "en": "http://friesen.biz/"
                }
            }
        },
        {
            "id": 14,
            "name": "Fabian Tromp MD",
            "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": false
            },
            "seo": {
                "title": {
                    "en": "Consectetur iste provident architecto quisquam quisquam eaque aut repellendus."
                },
                "description": {
                    "en": "Qui voluptatem occaecati in excepturi et enim sint. Sint expedita voluptatibus labore ut corporis velit ut. Dolor quasi magnam occaecati. Autem vitae suscipit sunt ut non sit et. Quia quas est qui."
                },
                "url": {
                    "en": "http://www.schamberger.net/commodi-aut-nihil-voluptas-repudiandae-quia"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                10,
                10,
                18
            ],
            "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
                    }
                ],
                "white_background": false
            }
        },
        {
            "name": "...",
            "category_ids": [
                10,
                12,
                14
            ],
            "id": 14,
            "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": [
                16,
                13,
                11
            ],
            "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
                    }
                ],
                "white_background": true
            }
        }
    ],
    "allow_invoices": true,
    "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:19 - 19:18",
                        "09:19 - 19:18",
                        "09:19 - 19:18"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:19 - 19:42",
                        "09:19 - 19:42",
                        "09:19 - 19:42"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:44 - 11:40",
                        "09:44 - 11:40",
                        "09:44 - 11:40"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "06:31 - 20:51",
                        "06:31 - 20:51",
                        "06:31 - 20:51"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:18 - 18:36",
                        "08:18 - 18:36",
                        "08:18 - 18:36"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:41 - 10:13",
                        "06:41 - 10:13",
                        "06:41 - 10:13"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:20 - 16:41",
                        "09:20 - 16:41",
                        "09:20 - 16:41"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:26 - 15:12",
                        "08:26 - 15:12",
                        "08:26 - 15:12"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:36 - 18:40",
                        "07:36 - 18:40",
                        "07:36 - 18:40"
                    ]
                }
            ]
        }
    ],
    "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.7.0 stable