Get Location Suggestions

Request

Get a list of suggestions for all locations managed by the logged user

Security

X-API-KEY or Authorization

Query

querystring

Filter by name, zip, street, city, label

Example:query=Berlin

sortstring

The location property to sort by (ascending unless order is specified)

orderstring

use asc for ascending sort or desc for descending sort

maxinteger, (int64)

Used for pagination. Maximum number of results per page.

identifierstring

The location identifier, based on your internal identification system, you want the suggestions for.

offsetinteger, (int64)

Offset used for pagination. Default: 0

businessIdArray of integers, (int64)

The ids of the businesses you want suggestions for

locationIdsArray of integers, (int64)

The ids of the locations you want suggestions for.

curl -i -X GET \
  'https://uberall.com/api/locations/suggestions?query=Berlin&sort=string&order=string&max=0&identifier=string&offset=0&businessId=0&locationIds=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suggestions

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

Search response object containing pagination details and a list of suggestion responses

Response

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