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=12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.2
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
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
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: 26500

[
    {
        "id": 10,
        "name": "Prof. Polly Donnelly",
        "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": true,
        "allow_product_comments": false,
        "offers": [
            {
                "id": 12,
                "name": "Black Friday"
            },
            {
                "id": 15,
                "name": "Black Friday"
            },
            {
                "id": 11,
                "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": 10,
                "name": "Danyka Sauer 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": {
                        "en": "Minus error tempore rem aperiam sequi enim perspiciatis et."
                    },
                    "description": {
                        "en": "Quam enim odit cum amet. Aut quasi et nisi nulla excepturi minus adipisci. Sunt provident ab nemo."
                    },
                    "url": {
                        "en": "http://koss.com/"
                    }
                }
            },
            {
                "id": 10,
                "name": "Mrs. Carolanne Jones",
                "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": "Porro dolores dolorem modi sequi placeat et explicabo rerum ipsam quo."
                    },
                    "description": {
                        "en": "Voluptatem velit quod esse ex ut non consequatur et. Dolores aut sit labore possimus possimus quas ut. Non dolor nam et totam omnis itaque."
                    },
                    "url": {
                        "en": "http://torphy.com/"
                    }
                }
            },
            {
                "id": 18,
                "name": "Alexandre Haag",
                "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": "Doloremque iure doloremque blanditiis delectus atque ex."
                    },
                    "description": {
                        "en": "Et assumenda ab reprehenderit magni dolorem. Hic odio quae ut quo quas. Qui asperiores modi alias minus sit non."
                    },
                    "url": {
                        "en": "http://vandervort.com/harum-aut-odit-omnis-qui-optio.html"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    17,
                    12,
                    12
                ],
                "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": true
                }
            },
            {
                "name": "...",
                "category_ids": [
                    19,
                    11,
                    17
                ],
                "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": [
                    10,
                    17,
                    11
                ],
                "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": true
                }
            }
        ],
        "allow_invoices": true,
        "category_groups_overview": false,
        "display_mode": "blocks",
        "takeout_use_intervals": true,
        "joyn_enabled": true,
        "currency": "EUR"
    },
    {
        "id": 10,
        "name": "Velva Zemlak",
        "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": false,
        "offers": [
            {
                "id": 10,
                "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": true
            }
        },
        "allow_orders": true,
        "delivery_use_intervals": false,
        "categories": [
            {
                "id": 12,
                "name": "Justen Moen",
                "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": "In dolores cumque quis ab ab minus totam ut quia."
                    },
                    "description": {
                        "en": "Iure eum in maxime ipsa ab voluptatem vel blanditiis. Tempora nihil quo quia sequi aut. Possimus sequi qui saepe. Omnis pariatur accusantium ex eligendi sunt."
                    },
                    "url": {
                        "en": "https://www.hermiston.com/quia-cumque-rem-illum-beatae-aut-esse"
                    }
                }
            },
            {
                "id": 15,
                "name": "Myra Pouros",
                "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": "Qui qui omnis debitis sint qui."
                    },
                    "description": {
                        "en": "Est illum voluptatem nostrum eos. Saepe facere qui aut. Ea odio et beatae. Dolorum incidunt id harum eos ut dolorem dicta."
                    },
                    "url": {
                        "en": "http://davis.com/placeat-repudiandae-suscipit-earum-dolores-quos-blanditiis"
                    }
                }
            },
            {
                "id": 10,
                "name": "Mr. Lucius Cremin II",
                "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": "Sunt voluptate atque aut provident quo."
                    },
                    "description": {
                        "en": "Tempore temporibus provident impedit asperiores et. Non blanditiis sequi adipisci qui."
                    },
                    "url": {
                        "en": "https://www.mcclure.com/nihil-perspiciatis-explicabo-voluptas-in"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    12,
                    11,
                    14
                ],
                "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": false
                }
            },
            {
                "name": "...",
                "category_ids": [
                    15,
                    13,
                    12
                ],
                "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
                }
            },
            {
                "name": "...",
                "category_ids": [
                    11,
                    17,
                    11
                ],
                "id": 11,
                "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": true,
        "display_mode": "blocks",
        "takeout_use_intervals": false,
        "joyn_enabled": true,
        "currency": "EUR"
    },
    {
        "id": 16,
        "name": "Lynn Cummings",
        "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": false,
        "offers": [
            {
                "id": 10,
                "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": true,
        "delivery_use_intervals": true,
        "categories": [
            {
                "id": 18,
                "name": "Hector Simonis",
                "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": "Et doloribus molestiae odio sit qui."
                    },
                    "description": {
                        "en": "Totam beatae sunt iure sit eaque. Dolore exercitationem nam necessitatibus ducimus eos perspiciatis. Ut molestiae inventore eum sed. Voluptas et dolores minus quod in sed optio earum."
                    },
                    "url": {
                        "en": "http://www.marvin.com/odio-ullam-et-eius-vel-est-id.html"
                    }
                }
            },
            {
                "id": 19,
                "name": "Paris Bradtke",
                "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": "Rerum voluptas architecto temporibus est commodi."
                    },
                    "description": {
                        "en": "Dolor earum sint laborum aut sit eum et. Doloremque occaecati sed sint ut aliquid provident. Exercitationem itaque sunt repudiandae occaecati. Voluptatibus sapiente ipsum sunt iste id eos."
                    },
                    "url": {
                        "en": "https://schamberger.org/dicta-numquam-quas-numquam-voluptas-temporibus-harum-consequatur-consequuntur.html"
                    }
                }
            },
            {
                "id": 16,
                "name": "Prof. Dave Goodwin",
                "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": "Sit laudantium et nobis possimus maiores."
                    },
                    "description": {
                        "en": "Molestias dolores excepturi quas eum enim ipsa. Expedita et quia distinctio. Dolores reiciendis deserunt doloremque."
                    },
                    "url": {
                        "en": "http://www.carroll.org/consequatur-et-dolorem-impedit-nostrum-veritatis-cumque-consectetur-quibusdam"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    15,
                    18
                ],
                "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,
                    11,
                    12
                ],
                "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": [
                    16,
                    16,
                    16
                ],
                "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": false
                }
            }
        ],
        "allow_invoices": false,
        "category_groups_overview": true,
        "display_mode": "blocks",
        "takeout_use_intervals": true,
        "joyn_enabled": false,
        "currency": "EUR"
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.2 stable