Create a collection

Request

Create a new collection managed by the current API user. If the user specifies a set of locations for the collections, users managing the whole set of locations can also manage the collection.

Security

X-API-KEY or Authorization

Bodyapplication/json

ContentCollection object to create

idinteger, (int64)

Collection id

identifierstringrequired

Mandatory - A unique identifier for the collection

namestringrequired

Mandatory - Name of the content collection

descriptionstring

A description of the collection

typestringrequired

Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM

Enum:"MENU""PEOPLE""PRODUCTS""CUSTOM""SERVICES""EVENTS""FAQ"

contentListsArray of objects

Mandatory - Sections within the content collections

locationIdsArray of integers, (int64), unique

Location Ids that should be associated with this collection

isReadOnlyboolean

Special field for FE indicating if the collection is read-only for the logged in user

Example:false

cuisineTypestring

Only applicable to Menu content collections - indicates the cuisine the restaurant serves

Enum:"AMERICAN""ASIAN""BRAZILIAN""BREAKFAST""BRUNCH""CHICKEN""CHINESE""FAMILY""FAST_FOOD""FRENCH"

urlstring

Applicable to Menu collections only - url to the brand webpage menu

curl -i -X POST \
  https://uberall.com/api/collections \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "identifier": "string",
    "name": "string",
    "description": "string",
    "type": "MENU",
    "contentLists": [
      {
        "id": 0,
        "title": "Lunch Menu",
        "type": "MENU",
        "description": "string",
        "translations": [
          {
            "hu": {
              "title": "Magyar"
            },
            "fr": {
              "title": "Titre Français"
            }
          }
        ],
        "items": [
          {
            "title": "string",
            "description": "string",
            "identifier": "string",
            "listName": "string",
            "id": 0,
            "price": 0,
            "currency": "EUR",
            "category": "Starters, Drinks, Desert, etc.",
            "image": {
              "id": 0,
              "url": "string",
              "type": "LOGO",
              "description": "string",
              "uid": "string"
            },
            "url": "string",
            "priceMax": 0,
            "caloriesLow": 0,
            "caloriesHigh": 0,
            "allergens": "Eggs, Dairy, Wheat, etc.",
            "dietaryRestrictions": "Vegetarian, Halal, etc."
          }
        ]
      }
    ],
    "locationIds": [
      0
    ],
    "isReadOnly": false,
    "cuisineType": "AMERICAN",
    "url": "string"
  }'

Responses

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