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 Invalid shop id

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

Example request 2 Valid shop id

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

Example request 3 Shop with offer

GET /shops/2243 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.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
offers [Offer] Array of Offer
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.
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
currency Currency 3 letter ISO 4217 currency name (string)

Example response 1 Invalid shop id

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
Content-Length: 65

{
    "code": "shop_not_found",
    "message": "Shop not found"
}

Example response 2 Valid shop id

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

{
    "id": 2241,
    "name": "The Pastry Corner",
    "address": {
        "street": "Michauxhof",
        "nr": "15",
        "zipcode": "5070",
        "city": "Oudenburg",
        "country": "BE",
        "position": {
            "latitude": 51.260197,
            "longitude": 4.402771
        }
    },
    "allow_comments": true,
    "currency": "EUR",
    "images": {
        "avatar": {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/2241/180x180/keurslager-dewilde.jpg",
                    "width": 180,
                    "height": 180
                },
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/2241/360x360/keurslager-dewilde.jpg",
                    "width": 200,
                    "height": 200
                }
            ]
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 13253,
            "name": "LightGray",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13254,
            "name": "MediumSpringGreen",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13255,
            "name": "LightSkyBlue",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13256,
            "name": "DarkViolet",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13257,
            "name": "Beige",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        }
    ],
    "offers": [],
    "category_groups": [],
    "hours": [
        {
            "name": "Opening hours",
            "description": null,
            "type": "open",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "06:15 - 06:30",
                        "06:30 - 11:15"
                    ]
                },
                {
                    "days": "Tuesday",
                    "times": [
                        "Closed"
                    ]
                },
                {
                    "days": "Wednesday",
                    "times": [
                        "06:30 - 13:30"
                    ]
                },
                {
                    "days": "Thursday",
                    "times": [
                        "Closed"
                    ]
                },
                {
                    "days": "Friday",
                    "times": [
                        "09:45 - 10:15",
                        "10:15 - 10:30",
                        "11:30 - 12:00",
                        "12:15 - 12:30"
                    ]
                },
                {
                    "days": "Sa - Su",
                    "times": [
                        "Closed"
                    ]
                }
            ]
        },
        {
            "name": "Pick up at shop",
            "description": null,
            "type": "takeout",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "Not possible"
                    ]
                },
                {
                    "days": "Tuesday",
                    "times": [
                        "08:30 - 09:30",
                        "10:45 - 11:45",
                        "12:45 - 13:30",
                        "13:45 - 14:00",
                        "14:15 - 14:45",
                        "15:00 - 16:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Wednesday",
                    "times": [
                        "07:15 - 08:15",
                        "08:15 - 08:45",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Thursday",
                    "times": [
                        "12:15 - 13:00",
                        "15:45 - 18:30",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Friday",
                    "times": [
                        "06:15 - 07:30",
                        "08:00 - 08:45",
                        "09:45 - 10:15",
                        "10:30 - 11:30",
                        "11:30 - 12:00",
                        "12:30 - 12:45",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Saturday",
                    "times": [
                        "13:30 - 14:00",
                        "14:00 - 14:15",
                        "14:15 - 14:30",
                        "15:00 - 15:30",
                        "15:30 - 15:45",
                        "16:00 - 16:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Sunday",
                    "times": [
                        "11:15 - 11:45",
                        "13:45 - 14:00",
                        "15:00 - 17:00",
                        "17:00 - 17:15",
                        "Order 5 minutes in advance"
                    ]
                }
            ]
        },
        {
            "name": "Delivery",
            "description": null,
            "type": "delivery",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "13:15 - 15:00",
                        "15:30 - 18:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Tu - We",
                    "times": [
                        "Not possible"
                    ]
                },
                {
                    "days": "Thursday",
                    "times": [
                        "09:45 - 10:45",
                        "11:00 - 12:00",
                        "12:15 - 14:00",
                        "14:15 - 15:00",
                        "15:15 - 16:15",
                        "09:45 - 10:45",
                        "11:00 - 12:00",
                        "12:15 - 14:00",
                        "14:15 - 15:00",
                        "15:15 - 16:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Friday",
                    "times": [
                        "Not possible"
                    ]
                },
                {
                    "days": "Saturday",
                    "times": [
                        "09:45 - 10:45",
                        "11:00 - 12:00",
                        "12:15 - 14:00",
                        "14:15 - 15:00",
                        "15:15 - 16:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Sunday",
                    "times": [
                        "07:00 - 07:30",
                        "08:30 - 09:30",
                        "09:45 - 10:00",
                        "10:00 - 10:30",
                        "10:30 - 12:30",
                        "Order 5 minutes in advance"
                    ]
                }
            ]
        }
    ],
    "contact": {
        "address": {
            "street": "Michauxhof",
            "nr": "15",
            "zipcode": "5070",
            "city": "Oudenburg",
            "country": "BE"
        },
        "telephone": "+32 479 44 77 88",
        "vat": "BE 0572448614",
        "social": {},
        "website": null,
        "email": "martens.julia@example.com"
    },
    "messages": [],
    "info": []
}

Example response 3 Shop with offer

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

{
    "id": 2243,
    "name": "The Flour Tower",
    "address": {
        "street": "Vandenberghebaan",
        "nr": "89",
        "zipcode": "6940",
        "city": "Charleroi",
        "country": "BE",
        "position": {
            "latitude": 51.260197,
            "longitude": 4.402771
        }
    },
    "allow_comments": true,
    "currency": "EUR",
    "images": {
        "avatar": {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/2243/180x180/patisserie-de-ruyter.png",
                    "width": 223,
                    "height": 180
                },
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/2243/360x360/patisserie-de-ruyter.png",
                    "width": 228,
                    "height": 184
                }
            ]
        },
        "banner": {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/banner/2243/1300x315/bakkerij-van-thillo-essen.png",
                    "width": 300,
                    "height": 290
                },
                {
                    "src": "https://bakeronline.be/uploads/banner/2243/900x250/bakkerij-van-thillo-essen.png",
                    "width": 300,
                    "height": 290
                }
            ]
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 13260,
            "name": "Gainsboro",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13261,
            "name": "SkyBlue",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        },
        {
            "id": 13262,
            "name": "DarkMagenta",
            "banner": null,
            "seo": {
                "title": [],
                "description": [],
                "url": []
            }
        }
    ],
    "offers": [
        {
            "id": 105,
            "name": "Black Friday"
        }
    ],
    "category_groups": [],
    "hours": [
        {
            "name": "Opening hours",
            "description": null,
            "type": "open",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "15:30 - 16:00",
                        "16:00 - 16:30",
                        "16:30 - 16:45",
                        "17:00 - 18:15",
                        "15:30 - 16:00",
                        "16:00 - 16:30",
                        "16:30 - 16:45",
                        "17:00 - 18:15"
                    ]
                },
                {
                    "days": "Tuesday",
                    "times": [
                        "15:30 - 16:00",
                        "16:00 - 16:30",
                        "16:30 - 16:45",
                        "17:00 - 18:15"
                    ]
                },
                {
                    "days": "Wednesday",
                    "times": [
                        "06:45 - 08:30",
                        "09:00 - 10:30",
                        "11:30 - 12:00",
                        "13:00 - 13:15",
                        "13:45 - 14:00"
                    ]
                },
                {
                    "days": "Thursday",
                    "times": [
                        "05:45 - 08:00",
                        "09:15 - 09:30",
                        "10:15 - 11:15",
                        "12:15 - 13:45"
                    ]
                },
                {
                    "days": "Friday",
                    "times": [
                        "11:45 - 12:00",
                        "12:00 - 13:00",
                        "13:45 - 14:30",
                        "15:15 - 16:30",
                        "16:45 - 17:00",
                        "11:45 - 12:00",
                        "12:00 - 13:00",
                        "13:45 - 14:30",
                        "15:15 - 16:30",
                        "16:45 - 17:00"
                    ]
                },
                {
                    "days": "Saturday",
                    "times": [
                        "11:45 - 12:00",
                        "12:00 - 13:00",
                        "13:45 - 14:30",
                        "15:15 - 16:30",
                        "16:45 - 17:00"
                    ]
                },
                {
                    "days": "Sunday",
                    "times": [
                        "09:15 - 10:15",
                        "10:15 - 10:45",
                        "11:30 - 12:15"
                    ]
                }
            ]
        },
        {
            "name": "Pick up at shop",
            "description": null,
            "type": "takeout",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "14:45 - 15:30",
                        "16:00 - 17:15",
                        "17:30 - 17:45",
                        "17:45 - 18:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Tuesday",
                    "times": [
                        "09:00 - 09:30",
                        "11:30 - 13:00",
                        "13:30 - 13:45",
                        "14:45 - 15:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Wednesday",
                    "times": [
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Th - Su",
                    "times": [
                        "08:45 - 10:00",
                        "10:30 - 10:45",
                        "11:00 - 12:15",
                        "12:15 - 13:30",
                        "13:30 - 13:45",
                        "14:15 - 14:30",
                        "Order 5 minutes in advance"
                    ]
                }
            ]
        },
        {
            "name": "Delivery",
            "description": null,
            "type": "delivery",
            "hours": [
                {
                    "days": "Monday",
                    "times": [
                        "14:30 - 14:45",
                        "15:00 - 16:00",
                        "17:00 - 18:15",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Tuesday",
                    "times": [
                        "09:45 - 10:00",
                        "10:15 - 12:00",
                        "12:15 - 12:45",
                        "13:00 - 13:45",
                        "14:30 - 15:45",
                        "15:45 - 16:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Wednesday",
                    "times": [
                        "11:30 - 17:00",
                        "11:30 - 17:00",
                        "11:30 - 17:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Th - Fr",
                    "times": [
                        "11:30 - 17:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Saturday",
                    "times": [
                        "13:30 - 15:00",
                        "15:00 - 15:15",
                        "15:30 - 16:30",
                        "16:45 - 17:00",
                        "17:15 - 17:30",
                        "17:30 - 18:00",
                        "13:30 - 15:00",
                        "15:00 - 15:15",
                        "15:30 - 16:30",
                        "16:45 - 17:00",
                        "17:15 - 17:30",
                        "17:30 - 18:00",
                        "Order 5 minutes in advance"
                    ]
                },
                {
                    "days": "Sunday",
                    "times": [
                        "13:30 - 15:00",
                        "15:00 - 15:15",
                        "15:30 - 16:30",
                        "16:45 - 17:00",
                        "17:15 - 17:30",
                        "17:30 - 18:00",
                        "Order 5 minutes in advance"
                    ]
                }
            ]
        }
    ],
    "contact": {
        "address": {
            "street": "Vandenberghebaan",
            "nr": "89",
            "zipcode": "6940",
            "city": "Charleroi",
            "country": "BE"
        },
        "telephone": "+32 479 44 77 88",
        "vat": "BE 0981648723",
        "social": {},
        "website": null,
        "email": "sarah.christiaens@example.net"
    },
    "messages": [],
    "info": []
}
1.5.0 stable