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=11 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.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
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
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: 33939

[
    {
        "id": 17,
        "name": "Ladarius Weber",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "url": "...",
        "allow_order_comments": true,
        "allow_product_comments": true,
        "allow_order_messages": false,
        "offers": [
            {
                "id": 15,
                "name": "Black Friday"
            },
            {
                "id": 17,
                "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": false
            }
        },
        "allow_orders": true,
        "delivery_use_intervals": false,
        "categories": [
            {
                "id": 14,
                "name": "Jodie Osinski",
                "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": "Facere minus rerum deleniti illum iste non."
                    },
                    "description": {
                        "en": "Modi deserunt magnam et et dolor a. Fuga unde repellat necessitatibus at error. Perferendis dolor vel velit aut dolorum. Qui necessitatibus soluta incidunt quo quibusdam aut."
                    },
                    "url": {
                        "en": "http://www.altenwerth.biz/illum-aut-nemo-assumenda-aut-aliquid-quis"
                    }
                }
            },
            {
                "id": 12,
                "name": "Jaime Braun",
                "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": "Distinctio aliquam ex sint et voluptate laudantium vero a."
                    },
                    "description": {
                        "en": "Distinctio nostrum est aspernatur consequatur quidem. Eum numquam nostrum culpa velit. Accusantium distinctio esse doloremque. Aut rerum earum et sunt sed recusandae."
                    },
                    "url": {
                        "en": "http://www.okeefe.com/"
                    }
                }
            },
            {
                "id": 19,
                "name": "Miss Georgette Rodriguez Jr.",
                "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": 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": true
                },
                "seo": {
                    "title": {
                        "en": "Est numquam saepe ut aliquid ut quo enim velit tenetur."
                    },
                    "description": {
                        "en": "Et qui velit deserunt fugiat. Sunt magnam est ullam est aut. Doloremque et suscipit aut suscipit voluptates vel cumque sunt. Beatae deserunt qui officia nobis."
                    },
                    "url": {
                        "en": "http://oreilly.com/deserunt-rerum-ut-totam-nihil-itaque.html"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    17,
                    11,
                    19
                ],
                "id": 16,
                "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": [
                    11,
                    17,
                    14
                ],
                "id": 17,
                "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": [
                    18,
                    10,
                    11
                ],
                "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": false
                }
            }
        ],
        "allow_invoices": true,
        "category_groups_overview": false,
        "display_mode": "blocks",
        "takeout_use_intervals": true,
        "joyn_enabled": true,
        "category_overview": true,
        "fold_category_groups": false,
        "currency": "EUR"
    },
    {
        "id": 16,
        "name": "Clifton Bahringer DVM",
        "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": false,
        "offers": [
            {
                "id": 18,
                "name": "Black Friday"
            },
            {
                "id": 10,
                "name": "Black Friday"
            },
            {
                "id": 13,
                "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": false,
        "categories": [
            {
                "id": 17,
                "name": "Lolita Baumbach",
                "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": 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": "Debitis odio et aut fugit assumenda porro."
                    },
                    "description": {
                        "en": "Delectus inventore quis libero quia vero. Doloremque eum similique sit quam voluptatum sapiente. Et eos laudantium repellat. Id quos ea facere est dignissimos ea."
                    },
                    "url": {
                        "en": "http://www.sawayn.com/laborum-et-dolore-harum-autem-voluptatem-sit"
                    }
                }
            },
            {
                "id": 12,
                "name": "Dr. Elian Baumbach 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": 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": "Dicta quis nisi quae perspiciatis itaque tempore."
                    },
                    "description": {
                        "en": "Temporibus ea ratione dolor doloremque. Distinctio debitis excepturi est est. Exercitationem ut expedita qui dicta. Fugit non atque non ipsum asperiores ipsam eum aut."
                    },
                    "url": {
                        "en": "http://www.ankunding.com/saepe-aut-porro-consequuntur-beatae-quis-amet-quod-ad"
                    }
                }
            },
            {
                "id": 18,
                "name": "Ms. Rosina Jakubowski",
                "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": "At voluptas alias numquam unde sed totam nihil aut."
                    },
                    "description": {
                        "en": "Necessitatibus fugit voluptatum nihil ullam ut. Et saepe blanditiis sequi eos dolor. Aspernatur quis quas omnis eligendi eos possimus."
                    },
                    "url": {
                        "en": "http://www.pollich.com/"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    19,
                    15,
                    18
                ],
                "id": 19,
                "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": [
                    17,
                    13,
                    15
                ],
                "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": [
                    19,
                    19,
                    10
                ],
                "id": 17,
                "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": false,
        "category_groups_overview": true,
        "display_mode": "blocks",
        "takeout_use_intervals": false,
        "joyn_enabled": true,
        "category_overview": true,
        "fold_category_groups": true,
        "currency": "EUR"
    },
    {
        "id": 10,
        "name": "Brisa Becker",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "url": "...",
        "allow_order_comments": false,
        "allow_product_comments": true,
        "allow_order_messages": true,
        "offers": [
            {
                "id": 17,
                "name": "Black Friday"
            },
            {
                "id": 14,
                "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": true
            }
        },
        "allow_orders": true,
        "delivery_use_intervals": true,
        "categories": [
            {
                "id": 13,
                "name": "Dr. Bonita Yost III",
                "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": "Rerum velit velit fugiat optio ratione vitae explicabo qui temporibus quam."
                    },
                    "description": {
                        "en": "Minima ullam ipsam incidunt doloribus dolor dolor rerum. Velit voluptas eius voluptas. Enim assumenda non est nam ea ut."
                    },
                    "url": {
                        "en": "https://fahey.com/quas-suscipit-aliquid-aut-deserunt-delectus.html"
                    }
                }
            },
            {
                "id": 13,
                "name": "Oda Lehner",
                "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": "Voluptas ex quasi mollitia laudantium vero et."
                    },
                    "description": {
                        "en": "Consequatur debitis aliquam ut vitae quas. Molestias quae explicabo qui odit."
                    },
                    "url": {
                        "en": "http://www.schuster.biz/et-a-architecto-atque-dolorem-sit"
                    }
                }
            },
            {
                "id": 11,
                "name": "Clifford Armstrong",
                "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": 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": "Beatae est quod dolores qui aspernatur magnam."
                    },
                    "description": {
                        "en": "Nulla eum natus et. Velit veritatis aut impedit odit quaerat nesciunt ut. Nulla voluptatem ipsa rerum porro molestiae dolorem."
                    },
                    "url": {
                        "en": "http://pouros.net/minus-est-impedit-non-id-modi-ea"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    15,
                    17,
                    12
                ],
                "id": 15,
                "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": [
                    13,
                    12,
                    17
                ],
                "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": [
                    17,
                    17,
                    10
                ],
                "id": 19,
                "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": false,
        "display_mode": "blocks",
        "takeout_use_intervals": false,
        "joyn_enabled": true,
        "category_overview": false,
        "fold_category_groups": true,
        "currency": "EUR"
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable