Search shops

GET /shops/search

Request

Query string (URL)

Append the querystring with following properties to the URL.

A dictionary with fields

Field Type Description
query String Optional. A String value
coordinates Coordinates Optional. Coordinates of a place in the world
distance Int Optional. An integer value
sortBy String Optional. String. Should be equal to 'distance'
company_id Int Optional. Only return shops of this company ID

Example request 1

GET /shops/search?query=...&coordinates%5Blatitude%5D=1%2C54361&coordinates%5Blongitude%5D=0%2C45645&distance=17&sortBy=distance&company_id=15 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5

Response

Array of Shop.detailed: [Shop.detailed]

Shop.detailed

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.
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: 17677

[
    {
        "id": 17,
        "name": "Dr. Michel Lehner",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 17,
                "name": "Black Friday"
            },
            {
                "id": 19,
                "name": "Black Friday"
            },
            {
                "id": 14,
                "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": 19,
                "name": "Winfield Bode",
                "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
                },
                "seo": {
                    "title": "Recusandae esse a corporis voluptas.",
                    "description": "Libero soluta dolores quo perspiciatis voluptatum. Omnis voluptas temporibus dignissimos ea quae dolores. Molestiae aut quidem assumenda qui neque at voluptates rem. Aut rerum qui et quae quasi.",
                    "url": "http://kertzmann.com/officia-neque-omnis-corporis-totam-voluptatem-quia-fugiat-dignissimos.html"
                }
            },
            {
                "id": 15,
                "name": "Bulah Adams",
                "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
                },
                "seo": {
                    "title": "Et dolorum sed delectus unde asperiores placeat.",
                    "description": "Velit quia voluptates aut voluptatem aut architecto molestiae. Porro nulla aut qui magni ut accusantium officia accusantium. Quod autem ut sint reprehenderit nesciunt.",
                    "url": "https://gutkowski.org/sint-est-quia-ullam-et-nostrum-vitae-omnis-velit.html"
                }
            },
            {
                "id": 13,
                "name": "Prof. Lawrence Tremblay",
                "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
                },
                "seo": {
                    "title": "Est ut nisi itaque reprehenderit omnis sint repellendus.",
                    "description": "Aliquam sed quo eveniet amet similique nulla et. Vitae non aut est et ea tempore.",
                    "url": "https://emmerich.com/incidunt-cumque-corrupti-perferendis-enim-non-voluptas-deserunt.html"
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    11,
                    18,
                    18
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    14,
                    13,
                    16
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    10,
                    14,
                    18
                ]
            }
        ],
        "currency": "EUR"
    },
    {
        "id": 13,
        "name": "Dr. Izaiah Altenwerth",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 12,
                "name": "Black Friday"
            },
            {
                "id": 15,
                "name": "Black Friday"
            },
            {
                "id": 17,
                "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": false
            }
        },
        "allow_orders": true,
        "delivery_use_intervals": false,
        "categories": [
            {
                "id": 19,
                "name": "Alessandra Fahey",
                "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
                },
                "seo": {
                    "title": "Possimus incidunt voluptates exercitationem labore nemo ad et quis.",
                    "description": "Voluptatem asperiores et autem eveniet est. Neque eum odit eos ullam modi sed delectus harum. Ea rem cumque occaecati est.",
                    "url": "http://www.baumbach.com/aliquam-libero-in-voluptatem-rerum"
                }
            },
            {
                "id": 17,
                "name": "Mckenzie Lemke PhD",
                "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
                },
                "seo": {
                    "title": "Minus labore ipsa est voluptas ad vitae corrupti vitae repellat et.",
                    "description": "Quis voluptatibus voluptates necessitatibus. Dolorum voluptatem eius modi sunt assumenda. Rerum facilis recusandae nisi magni hic vel ab.",
                    "url": "http://www.larson.com/nulla-cupiditate-iste-repudiandae-saepe-in-voluptatem-rerum"
                }
            },
            {
                "id": 11,
                "name": "Al Williamson",
                "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
                },
                "seo": {
                    "title": "Sapiente quod illum architecto molestias eos aperiam temporibus quas.",
                    "description": "Quia amet sint esse nulla. Quisquam voluptatem sunt quasi. Aperiam aliquam molestiae nobis vel. Et non omnis aspernatur qui est explicabo voluptatum.",
                    "url": "http://www.windler.biz/aut-voluptates-ab-qui-enim-quia.html"
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    11,
                    18,
                    15
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    15,
                    19,
                    10
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    15,
                    16,
                    11
                ]
            }
        ],
        "currency": "EUR"
    },
    {
        "id": 17,
        "name": "Jasper Breitenberg IV",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 15,
                "name": "Black Friday"
            },
            {
                "id": 14,
                "name": "Black Friday"
            },
            {
                "id": 10,
                "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": false,
        "delivery_use_intervals": true,
        "categories": [
            {
                "id": 13,
                "name": "Ms. Clarabelle Fahey",
                "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
                },
                "seo": {
                    "title": "Nostrum tempore dolor sunt maiores eligendi illum provident in corrupti.",
                    "description": "Non corporis est repellat. Soluta doloribus deleniti odit eius quia. Quo quo ratione amet. Sed est sit laudantium quos.",
                    "url": "http://www.langosh.com/porro-temporibus-maxime-culpa-iste-et.html"
                }
            },
            {
                "id": 12,
                "name": "Ahmed 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": false
                },
                "seo": {
                    "title": "Asperiores autem assumenda et necessitatibus quis perspiciatis cumque facilis placeat.",
                    "description": "Voluptas velit maiores veritatis error similique praesentium culpa. Dolores voluptatum qui quibusdam officia quia. Hic nesciunt quod voluptas ipsum maiores eos.",
                    "url": "http://www.grady.com/qui-aliquam-voluptatum-officiis-provident-officiis-necessitatibus-quo-aliquid"
                }
            },
            {
                "id": 10,
                "name": "Nelle Nitzsche",
                "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
                },
                "seo": {
                    "title": "Ea dignissimos laudantium odit fugit atque temporibus.",
                    "description": "Velit sequi labore et aut quia. Dolor id officiis nobis rerum molestias. Ducimus provident repellendus aut optio quasi sint error.",
                    "url": "http://gislason.net/id-deserunt-ut-rem-eos-sit-molestias-eum.html"
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    18,
                    13,
                    14
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    17,
                    14,
                    18
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    11,
                    11,
                    11
                ]
            }
        ],
        "currency": "EUR"
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable