Skip to content

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
Languages
Servers

https://uberall.com/api/

Mock Server

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

Operations

Business Connections

Set up - Business Connections

Operations
Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations
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
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

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
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

Request

Update the status of all PENDING suggestions that belong to the locations identified by the filter parameters. For non-admin users any non-managed locations will be ignored. Note that rejecting a suggestion does not delete it, and accepting the suggestion won't automatically apply it to the location. The status can only be set to ACCEPTED or DECLINED

Security
X-API-KEY or Authorization
curl -i -X PUT \
  https://uberall.com/api/locations/suggestions/update-all-status \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully updated suggestions

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

The actual response object of the response

response.​updatedSuggestionsCountinteger(int32)

Total number of updated suggestions

Example: 10
Response
No content

Request

Get location suggestions given a search data

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Query
languagestring

Filter suggestion attributes by language

directoryTypesstring

Filter suggestions by directories

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/suggestions?language=string&directoryTypes=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suggestions

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

Suggestion Response Model

response.​idinteger(int64)

Id of the location

response.​namestring

Name of the location

response.​streetAndNumberstring

Street and streetNumber of the location

response.​zipstring

Zip of the location

response.​citystring

City of the location

response.​countrystring

Country of the location

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
response.​statusstring

Status of the location

Enum"CREATED""ACTIVE""INACTIVE""CANCELLED""DELETED""CLOSED"
response.​suggestionsForFieldsArray of objects(SuggestionsForFieldsDetails)

Map containing fields and the suggested values from different directories.

Response
No content

Request

Update the given suggestion object, used to track the status of incoming suggestions. Note that rejecting a suggestion does not delete it, and accepting the suggestion won't automatically apply it to the location.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Body*/*required

List of Maps with both an id and a status key: [[id: 123, status: ACCEPTED], ...]

Array [
idinteger(int64)

id of the Suggestion

statusstring

ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion)

Enum"HIDDEN""PENDING""ACCEPTED""DECLINED""DECLINED_OLD_API"
valueobject

Suggestion Value

directorystring

Suggestion from directory

Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
]
curl -i -X PUT \
  'https://uberall.com/api/locations/{id}/suggestions' \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Successfully updated suggestions

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

responseArray of objects(Suggestion)required

The actual response object of the response

response[].​idinteger(int64)

id of the Suggestion

response[].​statusstring

ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion)

Enum"HIDDEN""PENDING""ACCEPTED""DECLINED""DECLINED_OLD_API"
response[].​valueobject

Suggestion Value

response[].​directorystring

Suggestion from directory

Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
Response
No content