Shop.extended

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)

Examples

Request

When used inside a request.

Example 1

{
    "id": 1518,
    "name": "Path of Crumbs",
    "address": {
        "street": "Michielslaan",
        "nr": "23",
        "zipcode": "7730",
        "city": "Sankt Vith",
        "country": "BE",
        "position": {
            "latitude": 51.05,
            "longitude": 3.71667
        }
    },
    "allow_comments": true,
    "currency": "EUR",
    "images": {
        "avatar": {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/1518/180x180/bakkerij-van-hecke-iepenstraat.jpg",
                    "width": 178,
                    "height": 178
                }
            ]
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [],
    "offers": [],
    "category_groups": [],
    "hours": [
        {
            "name": "6572",
            "description": null,
            "type": "open",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "13:30 - 13:45",
                        "13:45 - 15:15",
                        "15:15 - 15:45",
                        "16:00 - 16:45",
                        "17:15 - 17:45"
                    ]
                },
                {
                    "days": "2126",
                    "times": [
                        "10:15 - 10:45",
                        "10:45 - 11:30",
                        "13:15 - 14:30",
                        "14:30 - 14:45",
                        "15:00 - 15:15"
                    ]
                },
                {
                    "days": "2127",
                    "times": [
                        "09:30 - 11:00",
                        "13:00 - 13:15",
                        "14:15 - 17:00",
                        "09:30 - 11:00",
                        "13:00 - 13:15",
                        "14:15 - 17:00",
                        "09:30 - 11:00",
                        "13:00 - 13:15",
                        "14:15 - 17:00"
                    ]
                },
                {
                    "days": "2121 - 2122",
                    "times": [
                        "09:30 - 11:00",
                        "13:00 - 13:15",
                        "14:15 - 17:00"
                    ]
                },
                {
                    "days": "2130",
                    "times": [
                        "07:00 - 07:15",
                        "07:15 - 07:30",
                        "09:45 - 11:30",
                        "11:45 - 13:00"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "11:15 - 13:00"
                    ]
                }
            ]
        },
        {
            "name": "6573",
            "description": null,
            "type": "takeout",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "12:15 - 12:30",
                        "13:15 - 14:30",
                        "14:45 - 16:00",
                        "16:00 - 16:30",
                        "16:45 - 17:45",
                        "17:45 - 18:15",
                        "3841"
                    ]
                },
                {
                    "days": "2126",
                    "times": [
                        "14:30 - 14:45",
                        "14:45 - 15:15",
                        "16:15 - 17:00",
                        "17:15 - 17:45",
                        "3841"
                    ]
                },
                {
                    "days": "2127",
                    "times": [
                        "07:15 - 08:45",
                        "09:15 - 10:15",
                        "10:30 - 12:00",
                        "12:15 - 12:45",
                        "13:00 - 13:30",
                        "13:45 - 14:15",
                        "3841"
                    ]
                },
                {
                    "days": "2128",
                    "times": [
                        "16:45 - 17:45",
                        "17:45 - 18:15",
                        "18:15 - 18:30",
                        "19:00 - 19:15",
                        "19:30 - 19:45",
                        "16:45 - 17:45",
                        "17:45 - 18:15",
                        "18:15 - 18:30",
                        "19:00 - 19:15",
                        "19:30 - 19:45",
                        "16:45 - 17:45",
                        "17:45 - 18:15",
                        "18:15 - 18:30",
                        "19:00 - 19:15",
                        "19:30 - 19:45",
                        "3841"
                    ]
                },
                {
                    "days": "2122 - 2123",
                    "times": [
                        "16:45 - 17:45",
                        "17:45 - 18:15",
                        "18:15 - 18:30",
                        "19:00 - 19:15",
                        "19:30 - 19:45",
                        "3841"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "11:00 - 12:45",
                        "14:00 - 15:00",
                        "3841"
                    ]
                }
            ]
        },
        {
            "name": "6574",
            "description": null,
            "type": "delivery",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "07:30 - 09:45",
                        "10:30 - 11:15",
                        "11:45 - 12:45",
                        "13:45 - 14:15",
                        "15:00 - 15:15",
                        "07:30 - 09:45",
                        "10:30 - 11:15",
                        "11:45 - 12:45",
                        "13:45 - 14:15",
                        "15:00 - 15:15",
                        "07:30 - 09:45",
                        "10:30 - 11:15",
                        "11:45 - 12:45",
                        "13:45 - 14:15",
                        "15:00 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2119 - 2120",
                    "times": [
                        "07:30 - 09:45",
                        "10:30 - 11:15",
                        "11:45 - 12:45",
                        "13:45 - 14:15",
                        "15:00 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2128",
                    "times": [
                        "15:15 - 16:15",
                        "16:30 - 17:00",
                        "18:15 - 18:45",
                        "3841"
                    ]
                },
                {
                    "days": "2129",
                    "times": [
                        "13:30 - 14:30",
                        "15:00 - 15:45",
                        "16:30 - 17:15",
                        "17:30 - 18:30",
                        "13:30 - 14:30",
                        "15:00 - 15:45",
                        "16:30 - 17:15",
                        "17:30 - 18:30",
                        "3841"
                    ]
                },
                {
                    "days": "2130",
                    "times": [
                        "13:30 - 14:30",
                        "15:00 - 15:45",
                        "16:30 - 17:15",
                        "17:30 - 18:30",
                        "3841"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "11:15 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:00",
                        "14:00 - 14:30",
                        "15:00 - 15:15",
                        "15:30 - 16:15",
                        "3841"
                    ]
                }
            ]
        }
    ],
    "contact": {
        "address": {
            "street": "Michielslaan",
            "nr": "23",
            "zipcode": "7730",
            "city": "Sankt Vith",
            "country": "BE"
        },
        "telephone": "+32 479 44 77 88",
        "vat": "BE 0984727664",
        "social": {},
        "website": null,
        "email": "sam.collignon@example.net"
    },
    "messages": [],
    "info": []
}

Response

When returned in a response.

Example 1

{
    "id": 1519,
    "name": "Flour Power",
    "address": {
        "street": "Smetpad",
        "nr": "32",
        "zipcode": "4837",
        "city": "Hannuit",
        "country": "BE",
        "position": {
            "latitude": 50.8503396,
            "longitude": 4.3517103
        }
    },
    "allow_comments": true,
    "currency": "EUR",
    "images": {
        "avatar": {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/1519/180x180/bakkerij-ponnet-erondegem.jpg",
                    "width": 180,
                    "height": 180
                },
                {
                    "src": "https://bakeronline.be/uploads/shop-avatars/1519/360x360/bakkerij-ponnet-erondegem.jpg",
                    "width": 300,
                    "height": 300
                }
            ]
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [],
    "offers": [],
    "category_groups": [],
    "hours": [
        {
            "name": "6572",
            "description": null,
            "type": "open",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "11:00 - 11:45",
                        "14:30 - 15:00",
                        "15:30 - 17:30",
                        "11:00 - 11:45",
                        "14:30 - 15:00",
                        "15:30 - 17:30"
                    ]
                },
                {
                    "days": "2126",
                    "times": [
                        "11:00 - 11:45",
                        "14:30 - 15:00",
                        "15:30 - 17:30"
                    ]
                },
                {
                    "days": "2127",
                    "times": [
                        "05:00 - 06:30",
                        "08:30 - 08:45",
                        "09:15 - 11:00",
                        "05:00 - 06:30",
                        "08:30 - 08:45",
                        "09:15 - 11:00"
                    ]
                },
                {
                    "days": "2128",
                    "times": [
                        "05:00 - 06:30",
                        "08:30 - 08:45",
                        "09:15 - 11:00"
                    ]
                },
                {
                    "days": "2129",
                    "times": [
                        "08:45 - 09:45",
                        "13:15 - 17:45"
                    ]
                },
                {
                    "days": "2130",
                    "times": [
                        "11:00 - 13:00",
                        "14:15 - 15:15",
                        "15:45 - 16:30",
                        "11:00 - 13:00",
                        "14:15 - 15:15",
                        "15:45 - 16:30"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "11:00 - 13:00",
                        "14:15 - 15:15",
                        "15:45 - 16:30"
                    ]
                }
            ]
        },
        {
            "name": "6573",
            "description": null,
            "type": "takeout",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "11:30 - 12:30",
                        "13:30 - 14:00",
                        "14:15 - 15:00",
                        "15:15 - 15:30",
                        "3841"
                    ]
                },
                {
                    "days": "2126",
                    "times": [
                        "11:30 - 12:00",
                        "12:00 - 14:00",
                        "14:30 - 15:00",
                        "15:15 - 15:45",
                        "3841"
                    ]
                },
                {
                    "days": "2127",
                    "times": [
                        "05:00 - 11:15",
                        "12:00 - 13:00",
                        "3841"
                    ]
                },
                {
                    "days": "2128",
                    "times": [
                        "11:00 - 11:45",
                        "12:30 - 14:15",
                        "3841"
                    ]
                },
                {
                    "days": "2129",
                    "times": [
                        "08:45 - 10:15",
                        "11:00 - 12:00",
                        "12:15 - 13:00",
                        "13:15 - 13:30",
                        "14:45 - 15:15",
                        "08:45 - 10:15",
                        "11:00 - 12:00",
                        "12:15 - 13:00",
                        "13:15 - 13:30",
                        "14:45 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2130",
                    "times": [
                        "08:45 - 10:15",
                        "11:00 - 12:00",
                        "12:15 - 13:00",
                        "13:15 - 13:30",
                        "14:45 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "06:45 - 09:15",
                        "10:15 - 12:00",
                        "14:15 - 15:00",
                        "3841"
                    ]
                }
            ]
        },
        {
            "name": "6574",
            "description": null,
            "type": "delivery",
            "hours": [
                {
                    "days": "2125",
                    "times": [
                        "10:30 - 19:15",
                        "3841"
                    ]
                },
                {
                    "days": "2126",
                    "times": [
                        "07:00 - 13:30",
                        "14:00 - 15:45",
                        "3841"
                    ]
                },
                {
                    "days": "2127",
                    "times": [
                        "11:15 - 11:45",
                        "11:45 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:45",
                        "14:45 - 15:00",
                        "15:00 - 15:15",
                        "11:15 - 11:45",
                        "11:45 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:45",
                        "14:45 - 15:00",
                        "15:00 - 15:15",
                        "11:15 - 11:45",
                        "11:45 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:45",
                        "14:45 - 15:00",
                        "15:00 - 15:15",
                        "11:15 - 11:45",
                        "11:45 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:45",
                        "14:45 - 15:00",
                        "15:00 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2121 - 2123",
                    "times": [
                        "11:15 - 11:45",
                        "11:45 - 12:30",
                        "12:45 - 13:15",
                        "13:45 - 14:45",
                        "14:45 - 15:00",
                        "15:00 - 15:15",
                        "3841"
                    ]
                },
                {
                    "days": "2131",
                    "times": [
                        "12:00 - 13:00",
                        "13:45 - 14:15",
                        "16:15 - 17:30",
                        "3841"
                    ]
                }
            ]
        }
    ],
    "contact": {
        "address": {
            "street": "Smetpad",
            "nr": "32",
            "zipcode": "4837",
            "city": "Hannuit",
            "country": "BE"
        },
        "telephone": "+32 479 44 77 88",
        "vat": "BE 0253573650",
        "social": {},
        "website": null,
        "email": "oceane.herman@example.org"
    },
    "messages": [],
    "info": []
}
1.5.0 stable