API Reference
/
Menu Items

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

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

Menu Items

Locations Hub - Locations - Menu Items

Operations

Get All Menu Items

Request

Get all menu items the current API user can manage.
To specify products with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 in the URL param

curl -i -X GET \
  https://docs.uberall.com/_mock/apis/swagger/menu-items \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Menu Items successfully retrieved

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.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​totalinteger(int32)

Total count of results

Example: 100
response.​menuItemsArray of objects(MenuItem)
Response
No content

Create a Menu Item

Request

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

Bodyapplication/jsonrequired

Menu Item object to create

titlestringrequired

Title

descriptionstring

Description of the menu item: e.g. 'With mozzarella, fresh basil and tomatoes'

identifierstring

Unique Identifier for the Menu

listNamestring
idinteger(int64)

The uberall unique id for the menu item

priceinteger(int32)

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

currencyobject

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

categorystring

Category or section of the menu item (e.g. Starters, Drinks, Desert, etc.)

Example: "Starters, Drinks, Desert, etc."
imageobject

Image

urlstring

A valid page url with more details about the item

priceMaxinteger(int32)

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

caloriesLowinteger(int32)

The lowest possible number of calories for a menu item

caloriesHighinteger(int32)

The high end of the range of calories for a menu item

allergensArray of strings

Allergens in the food item (e.g. Eggs, Dairy, Wheat, etc.)

Example: "Eggs, Dairy, Wheat, etc."
dietaryRestrictionsArray of strings

Restrictive diet the menu item fits into (e.g. Vegetarian, Halal, etc.)

Example: "Vegetarian, Halal, etc."
curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/menu-items \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "id": 0,
    "price": 0,
    "currency": {},
    "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."
  }'

Responses

Menu Item 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.​menuItemobject

Menu Item

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "menuItem": { … }
  }
}

Delete a Menu Item using identifier

Request

Delete a menu item identified by identifier in the url param

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

Responses

Menu 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

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

Suggestions

Locations Hub - Locations - Suggestions

Operations