Skip to content
API Reference/
/
Search among the location...

Search among the locations

Request

Search among the locations of the store finder

Path
storeKeystringrequired

Your store finder key

Query
filterArray of strings, (string)

Only return those locations that match the given filter

Example:filter=services=pickup&services=wifi&my-cool-filter=custom-value
citiesArray of strings

List of cites to search for

languagestring

The language the location data should be returned in (only applicable if location translation feature is enabled)

Example:language=en
fieldMaskArray of strings

The list of fields the response object should contain, in the following format: "fieldMask=name&fieldMask=id"

geoboolean

When true (default), searches by proximity using lat/lng/radius or coordinates. When false, returns all locations according to the provided filters.

latstring

Latitude for geo search center. Defaults to 52.5251165 (Berlin). Range: -90 to 90. Only used when geo=true.

lngstring

Longitude for geo search center. Defaults to 13.3915718 (Berlin). Range: -180 to 180. Only used when geo=true.

coordinatesArray of strings, = 4 items

Bounding box: bottomRightLat,bottomRightLng,topLeftLat,topLeftLng. Alternative to lat/lng/radius.

Example:coordinates=52.42078412
countriesArray of strings

List of countries to search for

locationIdsArray of strings

Location ids to search within.

maxinteger, (int64)

Used for pagination. Maximum number of results per page

offsetinteger, (int64)

Offset used for pagination. Default: 0

openNowboolean

Return locations that are open now.

provincesArray of strings

List of provinces to search for

queryArray of strings

Search term that needs to be matched.

queryFieldsArray of strings

List of fields the term in 'query' is matched against.

radiusstring

Search radius in meters around lat/lng. Only used when geo=true.

zipsArray of strings

List of postcodes to search for

curl -i -X GET \
  'https://uberall.com/api/store-finders/{storeKey}/locations?filter=services%3Dpickup%26services%3Dwifi%26my-cool-filter%3Dcustom-value&cities=string&language=en&fieldMask=string&geo=true&lat=string&lng=string&coordinates=52.42078412%2C52.42078412%2C52.42078412%2C52.42078412&countries=string&locationIds=string&max=0&offset=0&openNow=true&provinces=string&query=string&queryFields=string&radius=string&zips=string'

Responses

Success

Bodyapplication/json
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Response containing store finder location search data

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 0,
    "count": 0,
    "locations": [ … ]
  }
}