API Reference
/
Locations Data
/
Get the post / zip code for 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

Social Posting Templates

Products - Social Posting - Social Posting Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

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

Get the labels for locations

Request

Get the labels assigned to a location

Query
querystring

Used for searching for a specific keyword within label names, only label names matching the given query via 'like' will be returned.

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/labels?query=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Labels successfully retrieved

Body*/*
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

Labels response model

response.​labelsArray of strings

List of labels

Response
No content

Get the post / zip code for locations

Request

Get the post / zip code assigned to a location

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://docs.uberall.com/_mock/apis/swagger/locations/postcodes?businessIds=string&cities=string&countries=string&locationIds=string&max=0&offset=0&provinces=string&query=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Postcodes successfully retrieved

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

response.​postcodesArray of strings
Response
No content

Get the province/state for locations

Request

Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

Query
businessIdsArray of strings

Get the provinces / states of locations associated with specific Business Id(s)

countriesArray of strings

Get provinces / states for locations in a country

querystring

Restricts the response to the provinces/states that contain this text, for example 'indi' would return 'Indiana' when appropriate.

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/provinces?businessIds=string&countries=string&max=0&offset=0&query=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Provinces successfully retrieved

Body*/*
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

Provinces response model

response.​provincesArray of strings

List of provinces

Example: ["Province1","Province2"]
Response
No content

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

Menu Items

Locations Hub - Locations - Menu Items

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