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=18&sortBy=distance&company_id=19 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.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.
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: 18867

[
    {
        "id": 11,
        "name": "Dorothea Denesik",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 13,
                "name": "Black Friday"
            },
            {
                "id": 14,
                "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": false,
        "delivery_use_intervals": false,
        "categories": [
            {
                "id": 16,
                "name": "Erwin Huels",
                "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": {
                        "en": "Ut nesciunt aut qui praesentium quia vel aliquam earum recusandae omnis sunt."
                    },
                    "description": {
                        "en": "Repellat et nobis in ut ut repellat consequatur. Sunt ullam cupiditate molestias aperiam. Qui et quia ipsa."
                    },
                    "url": {
                        "en": "https://runolfsdottir.com/molestias-aut-ut-iste-doloremque-placeat-sit-voluptatem.html"
                    }
                }
            },
            {
                "id": 10,
                "name": "Ron Wisozk",
                "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": {
                        "en": "Quis id nam minima laudantium aut exercitationem voluptatem et sunt ex."
                    },
                    "description": {
                        "en": "Ut porro praesentium ea quia unde ea. Sunt cum sed inventore eligendi itaque architecto est. Maxime ex et totam voluptate et ratione. Eum ab officiis accusantium consequatur eaque aut."
                    },
                    "url": {
                        "en": "http://www.koepp.info/"
                    }
                }
            },
            {
                "id": 19,
                "name": "Holly Roberts",
                "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": {
                        "en": "Labore hic vero autem earum nam nostrum blanditiis cupiditate ut et."
                    },
                    "description": {
                        "en": "Iusto est hic sunt natus eos. Sequi laborum praesentium est officia perspiciatis ut quidem. Autem aut magnam et nemo dolore in. Minus qui explicabo ratione dignissimos expedita saepe quasi."
                    },
                    "url": {
                        "en": "http://jerde.com/culpa-porro-enim-ducimus-dolor-id-autem-adipisci.html"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    11,
                    11
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    19,
                    13,
                    19
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    11,
                    12,
                    19
                ]
            }
        ],
        "currency": "EUR"
    },
    {
        "id": 18,
        "name": "Gerson Beier",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 16,
                "name": "Black Friday"
            },
            {
                "id": 13,
                "name": "Black Friday"
            },
            {
                "id": 15,
                "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": true,
        "categories": [
            {
                "id": 12,
                "name": "Jaylon Durgan",
                "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": {
                        "en": "Enim voluptas vel sunt molestiae velit et."
                    },
                    "description": {
                        "en": "Repellat libero soluta ducimus exercitationem deserunt sit consectetur. Voluptas molestiae eos dolorum velit. Voluptas sit perferendis alias et totam ut."
                    },
                    "url": {
                        "en": "http://www.prosacco.org/"
                    }
                }
            },
            {
                "id": 11,
                "name": "Aisha Treutel",
                "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": {
                        "en": "Est in architecto nihil quasi molestias aut quia."
                    },
                    "description": {
                        "en": "Eos qui esse non error officiis assumenda similique. Et aliquid officiis corrupti ut sed. Cumque veniam non nihil sit nihil ad debitis magnam. Optio et aperiam natus unde dolorum amet."
                    },
                    "url": {
                        "en": "http://www.rohan.org/illum-perferendis-similique-omnis-itaque-non"
                    }
                }
            },
            {
                "id": 19,
                "name": "Prof. Vada Mueller",
                "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": {
                        "en": "Ut consequatur doloremque id exercitationem iste."
                    },
                    "description": {
                        "en": "Cupiditate doloremque ratione labore cum ipsam. Dolore labore et vel."
                    },
                    "url": {
                        "en": "http://www.morar.net/occaecati-ut-aliquam-porro-eum-facilis-magnam-animi"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    10,
                    13
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    13,
                    13,
                    12
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    18,
                    10,
                    19
                ]
            }
        ],
        "currency": "EUR"
    },
    {
        "id": 16,
        "name": "Nathen Sanford",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "offers": [
            {
                "id": 16,
                "name": "Black Friday"
            },
            {
                "id": 18,
                "name": "Black Friday"
            },
            {
                "id": 15,
                "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": false,
        "delivery_use_intervals": false,
        "categories": [
            {
                "id": 17,
                "name": "Mr. Noble Bahringer DVM",
                "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": {
                        "en": "Maxime necessitatibus et quidem nobis."
                    },
                    "description": {
                        "en": "Voluptatem natus quam expedita explicabo. Ipsum debitis quia quo officia repudiandae. Maxime sed doloribus consequatur ad modi molestiae."
                    },
                    "url": {
                        "en": "https://www.morar.com/accusamus-enim-repellendus-est-aspernatur-tempora"
                    }
                }
            },
            {
                "id": 14,
                "name": "Janessa Rogahn V",
                "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": {
                        "en": "Vel aut a sed dolorum et corrupti est consequatur neque sint."
                    },
                    "description": {
                        "en": "Cupiditate et dolor dolor consequatur omnis eum impedit. Quos eveniet praesentium sapiente quam ut. Qui nostrum aut saepe modi quasi illo dolorem."
                    },
                    "url": {
                        "en": "http://www.kuhlman.net/"
                    }
                }
            },
            {
                "id": 12,
                "name": "Monserrat Windler 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
                },
                "seo": {
                    "title": {
                        "en": "Odio dolorem et vel at fuga sit et inventore aliquam neque."
                    },
                    "description": {
                        "en": "Saepe cumque alias amet aliquid. Ut ut amet natus velit cupiditate. Et ut quis consequatur perspiciatis autem."
                    },
                    "url": {
                        "en": "http://www.jast.com/"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    11,
                    16
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    11,
                    16,
                    16
                ]
            },
            {
                "name": "...",
                "category_ids": [
                    10,
                    19,
                    10
                ]
            }
        ],
        "currency": "EUR"
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable