Skip to content
API Reference
/
Store Finder
/
Search among the locations

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Get all possible filter values

Request

Will return all possible filter values for the given store finder. If locations are eligible for translations and a language is provided it will translate the values.

Path
storeKeystringrequired

Your store finder key

Query
languagestring

The language to show the filter values in

Example: language=en
countryArray of strings

Optional parameter to filter locations from a specific country

Example: country=FR
filtersArray of strings

The names of the filters for which the values should be returned

Example: filters=services
curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/store-finders/{storeKey}/filters?language=en&country=FR&filters=services'

Responses

Success

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Store Finder Filters Model

response.​filtersobject
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "filters": {}
  }
}

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

If geo search should be used.

latstring

Latitude. For local search.

lngstring

Longitude. For local search.

coordinatesArray of strings= 4 items

List of 4 coordinate points to search within (instead of 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

Radius (in meters). For local search.

zipsArray of strings

List of postcodes to search for

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/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&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""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Response containing store finder location search data

response.​offsetinteger(int32)
response.​maxinteger(int32)
response.​countinteger(int32)
response.​locationsArray of objects(StoreFinderResponse)
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 0,
    "count": 0,
    "locations": [ … ]
  }
}

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations