Получить меню можно по запросу:

GET https://delivery.ucs.ru/orders/api/v1/menu/view

Представление меню для подключения по API назначается в карточке.

Чтобы запросить меню для определенного заведения в запрос нужно добавить restaurantId

Пример запроса

GET https://delivery.ucs.ru/orders/api/v1/menu/view/?restaurantId=18f550d8-7fbe-45fa-8c83-35f531380f65
JSON

Пример ответа

{
  "result": {
    "categories": [
      {
        "id": "string",
        "name": "string",
        "parentId": "string"
      }
    ],
    "products": [
      {
        "id": "string",
		"externalId": "string",
        "categoryId": "string",
        "name": "string",
        "price": 0,
        "schemeId": "string",
        "description": "string",
        "imageUrls": [
          "string"
        ],
        "measure": {
          "value": 0,
          "unit": "string"
        },
        "isContainInStopList": [
          "string"
        ],
        "calories": 0,
        "energyValue": 0,
        "proteins": 0,
        "fats": 0,
        "carbohydrates": 0
      }
    ],
    "ingredientsSchemes": [
      {
        "id": "string"
        "ingredientsGroups": [
          {
            "id": "string",
            "minCount": 0,
            "maxCount": 0
          }
        ]
      }
    ],
    "ingredientsGroups": [
      {
       "id": "string", 
       "name": "string",
       "ingredients": [
          "string"
        ]
      }
    ],
    "ingredients": [
      {
        "id": "string",
		"externalId": "string",
        "name": "string",
        "price": 0,
        "schemeId": "string",
        "description": "string",
        "imageUrls": [
          "string"
        ],
        "measure": {
          "value": 0,
          "unit": "string"
        }
      }
    ],
    "name": "string",
    "isPossibleDelete": true,
    "haveChanges": true
  }
}
JSON

Где "externalId" - идентификатор блюда из r_keeper 7.

Описание параметров

ПараметрТипОписание
categoriesarrayКатегория из меню

id

stringid категории блюд

name

stringНаименование категории

parentId

stringid родительской категории
productsarrayБлюдо

id

stringid блюда
externalIdstringидентификатор блюда, с его помощью можно создавать заказы, указывая идентификаторы блюд и ингредиентов/модификаторов из r_k 7

categoryId

stringid категории

name

stringНаименование блюда

price

stringЦена

schemeId

stringЕсли у блюда есть модификатор или комбо-блюдо

description

stringОписание блюда

imageUrls

arrayМассив ссылок на картинки

measure

objectПорция
  • value
doubleРазмер порции
  • unit
stringЕдиница измерения: кг, литр, шт. Несловарное значение

isContainInStopList

arrayСтоп-лист
caloriesstring

Калорийность (ккал)

energyValuestringЭнергетическая ценность (кдж)
proteinsstringБелки
fatsstringЖиры
carbohydratesstringУглеводы
ingredientsSchemesarrayНабор схем групп ингредиентов или модификаторов

id

stringid схемы ингредиентов или модификаторов

ingredientsGroups

arrayНабор групп ингредиентов или модификаторов
  • id
stringid группы
  • minCount
 int

Минимальное количество позиций из группы

  • maxCount
 int Максимальное возможное количество позиций из группы

ingredientsGroups

arrayНабор схем групп ингредиентов или модификаторов
idstringid группы
namestringНаименование группы
ingredientsarrayМассив идентификаторов из ingredients
ingredientsarrayИнгредиенты и модификаторы

id

stringid ингредиента или модификатора
externalIdstringидентификатор блюда, с его помощью можно создавать заказы, указывая идентификаторы блюд и ингредиентов/модификаторов из r_k 7

name

stringНаименование ингредиента или модификатора

price

stringЦена

description

stringОписание ингредиента (не модификатора)

imageUrls

arrayМассив ссылок на картинки для ингредиента (не модификатора)

measure

objectПорция
  • value
stringРазмер порции ингредиента (не модификатора)
  • unit
stringЕдиница измерения: кг, литр, шт. Несловарное значение
namestringНаименование представления меню
isPossibleDeletebooleanПоказывает, можно ли удалить представление меню
haveChangesbooleanПоказывает, были ли внесены изменения в представление меню

Посмотреть возможные варианты ошибок можно в отдельной статье - Описание ошибок.