Get the post / zip code for locations

Request

Get the post / zip code assigned to a location

Security

X-API-KEY or Authorization

Query

locationIdsArray of strings

Get the post / zip codes for associated to the given list of location Ids

businessIdsArray of strings

Get the post / zip codes for locations assigned to a business id

countriesArray of strings

Get the post / zip codes for locations within a country

provincesArray of strings

Get the post / zip codes for locations within a province / state

citiesArray of strings

Get the post / zip codes for locations within a city

querystring

Restricts the response to the post/zip codes that contain this text, for example "374" would return "37490" when appropriate.

maxinteger, (int64)

Maximum number of items to return

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/locations/postcodes?locationIds=string&businessIds=string&countries=string&provinces=string&cities=string&query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Postcodes successfully retrieved

Body*/*

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 object containing a list of postcodes

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "postcodes": [
      "string"
    ]
  }
}