View Source

To get the menu, run the following query:

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

The menu view for an API connection is set in the card.

To get the menu for a specific restaurant, add restaurantId to the query

Query example:

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

Response example:

{
  "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
  }
}

Where externalId is for r_keeper 7 dish identifier.

Parameters description

Parameter	Type	Description
categories	array	Menu category
id	string	Dish category ID
name	string	Category name
parentId	string	Parent category ID
products	array	Dish
id	string	Dish ID
extarnalId	string	A dish identifier. Using it, you can create orders, specifying identifiers of dishes and ingredients/modifiers from r_keeper 7
categoryId	string	Category ID
name	string	Dish name
price	string	Price
schemeId	string	If a dish has a modifier or a combo-dish
description	string	Dish description
imageUrls	array	Image URLs array
measure	object	Serving
value	double	Serving size
unit	string	Unit of measurement: kg, liter, pcs.
isContainInStopList	array	Stop-list
calories	string	Calorific value (kcal)
energyValue	string	Energy value (kJ)
proteins	string	Proteins
fats	string	Fats
carbohydrates	string	Carbohydrates
ingredientsSchemes	array	Array of ingredients or modifiers groups schemes
Id	string	Ingredients or modifiers scheme ID
ingredientsGroups	array	Array of ingredients or modifiers groups
Id	string	Group ID
minCount	int	Minimum number of items of the group
maxCount	int	Maximum possible number of items of the group
ingredientsGroups	array	Array of ingredients or modifiers groups schemes
Id	string	Group ID
name	string	Group name
ingredients	array	Array of ingredients IDs
ingredients	array	Ingredients and modifiers
Id	string	Ingredient or modifier ID
name	string	Ingredient or modifier name
price	string	Price
description	string	Ingredient (not modifier) description
imageUrls	array	Image URLs array for the ingredient (not a modifier)
measure	object	Serving
value	string	Ingredient (not modifier) serving size
unit	string	Unit of measurement: kg, liter, pcs.
name	string	Menu view name
isPossibleDelete	boolean	Shows if it is possible to delete a menu view
haveChanges	boolean	Shows if there are any changes in the menu view

Find the list of possible errors in the «Errors description» article.