Search among the locations
Search among the locations of the store finder
Path parameters
Your store finder key
Query parameters
Only return those locations that match the given filter
List of cites to search for
The language the location data should be returned in (only applicable if location translation feature is enabled)
The list of fields the response object should contain, in the following format: "fieldMask=name&fieldMask=id"
When true (default), searches by proximity using lat/lng/radius or coordinates. When false, returns all locations according to the provided filters.
Latitude for geo search center. Defaults to 52.5251165 (Berlin). Range: -90 to 90. Only used when geo=true.
Longitude for geo search center. Defaults to 13.3915718 (Berlin). Range: -180 to 180. Only used when geo=true.
Bounding box: bottomRightLat,bottomRightLng,topLeftLat,topLeftLng. Alternative to lat/lng/radius.
[ "52.42078412" ]
List of countries to search for
Location ids to search within.
Used for pagination. Maximum number of results per page
Offset used for pagination. Default: 0
Return locations that are open now.
List of provinces to search for
Search term that needs to be matched.
List of fields the term in 'query' is matched against.
Search radius in meters around lat/lng. Only used when geo=true.
List of postcodes to search for
Response
Success
Example response
{
"response": {
"locations": [
{
"addressExtra": "building, floor, etc.",
"customItems": [
{
"category": "Coffee",
"unit": "per kg"
}
],
"menus": [
{
"category": "Starters, Drinks, Desert, etc."
}
],
"nextOpen": {
"date": "2018-11-16"
},
"faqs": [
{
"question": "Do you have parking?",
"answer": "Yes, free valet parking is available."
}
],
"products": [
{
"category": "Coffee",
"unit": "per kg"
}
],
"services": [
{
"currency": "USD"
}
]
}
]
}
}