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=12&sortBy=distance&company_id=14 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.6.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: 33988

[
    {
        "id": 14,
        "name": "Sid Hegmann",
        "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": true,
        "allow_order_messages": false,
        "offers": [
            {
                "id": 11,
                "name": "Black Friday"
            },
            {
                "id": 12,
                "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": true,
        "categories": [
            {
                "id": 17,
                "name": "Aniya Berge 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": 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": "Excepturi vitae perferendis ad distinctio omnis quos ex."
                    },
                    "description": {
                        "en": "Aut qui voluptate ipsum. Distinctio aut incidunt aliquid perspiciatis dolor. Fuga libero dolor doloribus facilis officia. Ipsam necessitatibus eveniet enim perspiciatis aut quia inventore."
                    },
                    "url": {
                        "en": "https://www.quitzon.com/omnis-qui-error-quasi-sunt"
                    }
                }
            },
            {
                "id": 10,
                "name": "Juwan Walter",
                "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": 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": "Et voluptatem accusantium magnam cum quos est vel temporibus esse eum."
                    },
                    "description": {
                        "en": "Et autem at ut. Vel sit velit alias animi. Quo ex est praesentium ab vitae. Natus libero et sunt ut quis qui."
                    },
                    "url": {
                        "en": "https://wisoky.net/earum-ut-laudantium-voluptas-cumque-quos-consectetur-magnam.html"
                    }
                }
            },
            {
                "id": 16,
                "name": "Lily Zemlak DDS",
                "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": "Expedita nobis aut qui id inventore."
                    },
                    "description": {
                        "en": "Voluptatem architecto et nemo tempore consequatur in. Rerum numquam incidunt quibusdam quos eum eveniet odit. At quo aut quis debitis ut eos accusantium eos."
                    },
                    "url": {
                        "en": "https://aufderhar.com/quod-fuga-est-fugit-et-ut-earum-saepe-eos.html"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    17,
                    15,
                    13
                ],
                "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": false
                }
            },
            {
                "name": "...",
                "category_ids": [
                    15,
                    13,
                    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": false
                }
            },
            {
                "name": "...",
                "category_ids": [
                    12,
                    10,
                    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
                }
            }
        ],
        "allow_invoices": false,
        "category_groups_overview": true,
        "display_mode": "blocks",
        "takeout_use_intervals": true,
        "joyn_enabled": true,
        "category_overview": true,
        "fold_category_groups": false,
        "currency": "EUR"
    },
    {
        "id": 14,
        "name": "Mrs. Angeline Ullrich Jr.",
        "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": true,
        "offers": [
            {
                "id": 15,
                "name": "Black Friday"
            },
            {
                "id": 19,
                "name": "Black Friday"
            },
            {
                "id": 16,
                "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": 15,
                "name": "Shannon Hartmann",
                "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": "Libero voluptate quia eaque blanditiis enim."
                    },
                    "description": {
                        "en": "Voluptate eveniet minima libero vel earum rerum iste. Voluptas eos commodi ut reiciendis aperiam. Omnis deleniti debitis doloribus accusantium."
                    },
                    "url": {
                        "en": "http://www.ledner.org/laboriosam-ex-optio-nobis-quo-ipsam-dolorum-pariatur"
                    }
                }
            },
            {
                "id": 18,
                "name": "Prof. Janie Block 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": 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": "Veritatis itaque quia assumenda eligendi expedita ut ipsam."
                    },
                    "description": {
                        "en": "Aliquam eos sunt magni maiores. Ipsum laudantium tempore eum vel maxime. Qui libero itaque ea eaque."
                    },
                    "url": {
                        "en": "http://www.baumbach.com/nulla-numquam-vel-hic-numquam-et-consequatur"
                    }
                }
            },
            {
                "id": 10,
                "name": "Prof. Myrtle Ratke 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
                },
                "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": "Et atque consequatur repellat repellendus fugit sequi et quo."
                    },
                    "description": {
                        "en": "Itaque inventore mollitia ut. Dolores commodi quis laboriosam corporis earum quo. Eum in non autem id nisi exercitationem repellat. Nihil ut vero inventore."
                    },
                    "url": {
                        "en": "http://www.rohan.org/"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    13,
                    18
                ],
                "id": 18,
                "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": [
                    14,
                    12,
                    19
                ],
                "id": 13,
                "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,
                    11,
                    10
                ],
                "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
                }
            }
        ],
        "allow_invoices": true,
        "category_groups_overview": true,
        "display_mode": "blocks",
        "takeout_use_intervals": false,
        "joyn_enabled": true,
        "category_overview": false,
        "fold_category_groups": false,
        "currency": "EUR"
    },
    {
        "id": 16,
        "name": "Ms. Libbie Johnson PhD",
        "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,
        "allow_order_messages": true,
        "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": false,
        "delivery_use_intervals": true,
        "categories": [
            {
                "id": 10,
                "name": "Lily Marks",
                "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": "Nemo quidem sed est est consequatur nam deserunt amet praesentium."
                    },
                    "description": {
                        "en": "Eos quam animi sit dolorum. Dolore repellendus suscipit modi non sapiente aliquam culpa. Ut odio quia quos pariatur. Cum et veritatis sint voluptatem et nisi."
                    },
                    "url": {
                        "en": "http://conroy.com/"
                    }
                }
            },
            {
                "id": 14,
                "name": "Elian Stoltenberg",
                "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": "Ratione incidunt illo quo optio tenetur praesentium minus modi molestias."
                    },
                    "description": {
                        "en": "Et minus consequatur ut quaerat tempora. Quia quidem nihil architecto. Quis sunt beatae et maiores animi voluptatem."
                    },
                    "url": {
                        "en": "http://kshlerin.com/"
                    }
                }
            },
            {
                "id": 13,
                "name": "Cletus Becker",
                "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": "Facilis cupiditate id perferendis veniam ab voluptates deleniti."
                    },
                    "description": {
                        "en": "Id et iusto quia eos. Molestiae vitae praesentium aut fugiat minus. Voluptas sit mollitia possimus et earum. Quae et sapiente natus ut id aut possimus."
                    },
                    "url": {
                        "en": "http://mitchell.com/veritatis-quia-totam-veritatis-veniam-deleniti-consequatur-enim"
                    }
                }
            }
        ],
        "category_groups": [
            {
                "name": "...",
                "category_ids": [
                    13,
                    19,
                    10
                ],
                "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
                }
            },
            {
                "name": "...",
                "category_ids": [
                    17,
                    14,
                    16
                ],
                "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": true
                }
            },
            {
                "name": "...",
                "category_ids": [
                    13,
                    11,
                    11
                ],
                "id": 13,
                "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": true,
        "joyn_enabled": false,
        "category_overview": true,
        "fold_category_groups": false,
        "currency": "EUR"
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable