Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
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

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

Search through all LocationGroups

Request

Can be used to search for specific location groups or even return all, depending on the given params.

Query
fieldMaskArray of strings

Used for bypassing pagination and reducing the response objects (List of String), following are supported ["id", "name"]

locationGroupIdsArray of integers(int64)

Used for restricting the returned location groups within the given range of IDs.

querystring

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

maxinteger(int64)

Used for pagination, specifies the amount of entries maximum returned per page (must be between 0-100).

offsetinteger(int64)

Used for pagination, specifies the starting point from which the returned subset should start.

pageinteger(int64)

Used for pagination, specifies which page you want to get back from a set of pages. Can be used instead of using "offset". Can also be used in combination with "max" otherwise default "max" is being used. Difference to "offset" is that you don't need to calculate the correct value, you can simply request page number 2 with max 10 result in it (page: 2, max: 10). So you will get back results 10-19 while skipping the first 10 (0-9) ones.

sortstring

Used for specify the field by which the list entries shall be sorted, possible values ["NAME", "LAST_UPDATED", "LOCATION_SIZE", "USER_SIZE"]. If none or invalid given list will automatically sorted by "id".

orderstring

Used for specify the sorting direction in which the list entries shall be returned, possible values ['ASC', 'DESC'].

hideLocationsboolean

If given true value the endpoint will not return the locations array as part of the response, just the group id and name

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/location-groups?fieldMask=string&hideLocations=true&locationGroupIds=0&max=0&offset=0&order=string&page=0&query=string&sort=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

LocationGroups 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

The actual response object of the response

response.​locationGroupsArray of objects(LocationGroupModel)

The location groups

response.​countinteger(int32)

The total number of location groups

response.​pageSizeinteger(int32)

The number of location groups per page

response.​maxinteger(int32)

The maximum number of location groups

response.​offsetinteger(int32)

The offset

response.​pageinteger(int32)

The page

Response
No content

Create a new LocationGroup

Request

Can be used to create a new LocationGroup

Body*/*required

LocationGroup to create

namestringrequired

Name (String) of the LocationGroup

statusstring

Status of the LocationGroup, defaults to "ACTIVE", supported values: ["ACTIVE"].

Enum"ACTIVE""DELETED"
locationsArray of integers(int64)

List of location IDs (Long) that shall be assigned to the new LocationGroup.

usersArray of integers(int64)

List of user IDs (Long) that shall be assigned to the new LocationGroup.

curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/location-groups \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

LocationGroup created successfully

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.​idinteger(int64)

ID of the LocationGroup.

response.​lastUpdatedstring(date-time)

Last updated date of the Location Group

response.​namestring

Name of the LocationGroup.

response.​statusstring

Status of the Location Group

Enum"ACTIVE""DELETED"
response.​usersArray of objects(UserDetails)
response.​creatorinteger(int64)
response.​salesPartnerinteger(int64)
response.​locationsCountinteger(int32)
response.​locationsArray of objects(LocationDetails)
Response
No content

Get a single LocationGroup

Request

Can be used to retrieve a single LocationGroup.

Path
idstringrequired

ID of the LocationGroup that should be returned.

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/location-groups/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

LocationGroup 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

The actual response object of the response

response.​idinteger(int64)

ID of the LocationGroup.

response.​lastUpdatedstring(date-time)

Last updated date of the Location Group

response.​namestring

Name of the LocationGroup.

response.​statusstring

Status of the Location Group

Enum"ACTIVE""DELETED"
response.​usersArray of objects(UserDetails)
response.​creatorinteger(int64)
response.​salesPartnerinteger(int64)
response.​locationsCountinteger(int32)
response.​locationsArray of objects(LocationDetails)
Response
No content

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