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

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

Delete a Service Item

Request

Delete a service item identified by identifier in the url param

Path
idstringrequired

The uberall unique ID for the service item

curl -i -X DELETE \
  'https://docs.uberall.com/_mock/apis/swagger/service-items/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Service Item successfully deleted

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

Update a Service Item

Request

Make changes to a service item.
Always use ?identifier= in url param to identify the service item uniquely.
Any blank parameter deletes an old value, any unspecified parameter does nothing

Path
idstringrequired

The uberall unique ID for the service item you want to update

Bodyapplication/jsonrequired

A ServiceItem object

titlestringrequired

Name of the service item as represented at the location

descriptionstring

A description of the service

identifierstring

Required - A unique identifier for this service

listNamestring
priceinteger(int32)

Price of the service item

currencyobject

The currency of the price for this service - required when a price is given

categoryinteger(int64)

Business category the service should be applied to - this is required when applying a Google structured service but not necessary for freeform services.

countrystring

The country where the locations providing this service are located - this is required when applying a Google structured service but not necessary for freeform services.

googleServicestring

The Google name for a structured service - this is required when applying a Google structured service but not necessary for freeform services.

curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/service-items/{id}' \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "price": 0,
    "currency": {},
    "category": 0,
    "country": "string",
    "googleService": "string"
  }'

Responses

Service Item successfully updated

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

Suggestions

Locations Hub - Locations - Suggestions

Operations