Skip to content
API Reference/
/
Create a Product

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""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}