Skip to content
API Reference/
/
Delete a Product using id...

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api/
Mock Server
https://docs.uberall.com/_mock/apis/swagger/

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

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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

Create a Product

Request

Create a product. It can be added to a content list later

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A Product object

titlestringrequired

The name of the product: e.g. Strong Coffee

descriptionstring

Description of the product: e.g. 'The strongest coffee in the world'

identifierstring

Unique Identifier for the Product

listNamestring
idinteger(int64)

The uberall unique id for the product

priceinteger(int32)

Price of the product in cents: e.g. '1500' for 15 €

currencyobject

Currency used for prices in ISO-4217: e.g. EUR, USD, CHF

categorystring

A category the product belongs to: e.g. 'Coffee'

Example: "Coffee"
videoobject

A video about the product

unitstring

A unit of measure, e.g. 'per kg'

Example: "per kg"
urlstring

A valid page url with more details about the product

priceMaxinteger(int32)

Maximum price if you want to use a price range for the product

imageobject

Image of the product (use the Image object format)

curl -i -X POST \
  https://uberall.com/api/products \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "id": 0,
    "price": 0,
    "currency": {},
    "category": "Coffee",
    "video": {
      "id": 0,
      "url": "string",
      "description": "string",
      "type": "YOUTUBE"
    },
    "unit": "per kg",
    "url": "string",
    "priceMax": 0,
    "image": {
      "id": 0,
      "url": "string",
      "type": "LOGO",
      "description": "string",
      "uid": "string"
    }
  }'

Responses

Product successfully created

Bodyapplication/json
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
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}

Delete a Product using identifier

Request

Delete a product identified by identifier in the url param

Security
X-API-KEY or Authorization
curl -i -X DELETE \
  https://uberall.com/api/products \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Product 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 Product using identifier

Request

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

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A Product object

titlestringrequired

The name of the product: e.g. Strong Coffee

descriptionstring

Description of the product: e.g. 'The strongest coffee in the world'

identifierstring

Unique Identifier for the Product

listNamestring
idinteger(int64)

The uberall unique id for the product

priceinteger(int32)

Price of the product in cents: e.g. '1500' for 15 €

currencyobject

Currency used for prices in ISO-4217: e.g. EUR, USD, CHF

categorystring

A category the product belongs to: e.g. 'Coffee'

Example: "Coffee"
videoobject

A video about the product

unitstring

A unit of measure, e.g. 'per kg'

Example: "per kg"
urlstring

A valid page url with more details about the product

priceMaxinteger(int32)

Maximum price if you want to use a price range for the product

imageobject

Image of the product (use the Image object format)

curl -i -X PATCH \
  https://uberall.com/api/products \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "id": 0,
    "price": 0,
    "currency": {},
    "category": "Coffee",
    "video": {
      "id": 0,
      "url": "string",
      "description": "string",
      "type": "YOUTUBE"
    },
    "unit": "per kg",
    "url": "string",
    "priceMax": 0,
    "image": {
      "id": 0,
      "url": "string",
      "type": "LOGO",
      "description": "string",
      "uid": "string"
    }
  }'

Responses

Product 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

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Locations

Locations

Operations