Create a Custom Item

Request

Create a custom item. It can be added to a content list later

Security

X-API-KEY or Authorization

Bodyapplication/jsonrequired

CustomItem object to create

titlestringrequired

mandatory, the custom name, e.g. 'Strong Coffee'

descriptionstring

identifierstring

listNamestring

idinteger, (int64)

The uberall unique id for the custom item

priceinteger, (int32)

optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )

currencyobject

optional, indicating the currency for price and priceMax in ISO-4217, e.g. EUR

categorystring

optional, a category name, e.g. 'Coffee'

Example:"Coffee"

videoobject

optional, a video about the custom

unitstring

optional, indicating the unit of measure, e.g. 'per kg'

Example:"per kg"

urlstring

optional, a url related to the custom item

priceMaxinteger, (int32)

optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00 EUR )

imageobject

Image of the custom-item (use the Image object format)

curl -i -X POST \
  https://uberall.com/api/custom-items \
  -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

Successfully created custom item

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": {
    "customItem": { … }
  }
}