Skip to content
API Reference
/
Batch Operation

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

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

Get all Location Imports

Request

Returns a list of all existing location imports for the current user

Security
accessToken or privateKey
Query
maxinteger(int64)

Used for pagination. Maximum number of results per page

Default 10
offsetinteger(int64)

Offset used for pagination

Default 0
sortstring

Order results by the specified field. Default is location id.

orderstring

Use asc for ascending sort or desc for descending sort

Default "asc"
curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/batch?max=10&offset=0&sort=string&order=asc' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved location imports

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.​offsetinteger(int32)

Offset for the current page

Example: 0
response.​maxinteger(int32)

Maximum number of items per page

Example: 10
response.​countinteger(int32)

Total count of location imports

Example: 100
response.​locationsArray of objects(LocationImport)
Response
No content

Get Excel document with Location errors

Request

After a file import, a results report is created with all location failures. This endpoints allows downloading only the locations with errors.

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique ID of the location import

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

Responses

Successfully retrieved error report file

Bodyapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string(binary)
Response
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
<root>string</root>

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

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