Actions with menu

The menu can be obtained upon the request:

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

The menu view for the API connection is assigned in the card.

To request a menu for a specific establishment, you need to add restaurantId to the request

Example request

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

CODE

Example answer

{
  "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
  }
}
    "dishTaxes": {
        "groupName": "VAT 18%",
        "taxes": [
            {
                "taxName": "VAT",
                "rateName": "18,00 %",
                "rate": 18.0
             }
     "measure": {
         "value": null,
         "unit": null,
         "priceMode": "PerPiece",
         "qntDecDigits": null,
         "changeQntOnce": null,
         "joinMode": "almJoinLines"
      },

CODE

Where "externalId" is the dish ID from r_keeper 7.

Description of parameters

Parameter	Type	Description
categories	array	Category from menu
id	string	dish category id
name	string	Category name
parentId	string	parent category id
products	array	Dish
id	string	dish id
externalId	string	dish identifier. With its help you can create orders by specifying dish identifiers and ingredients/modifiers from r_k 7
categoryId	string	category id
name	string	Name of the dish
price	string	Price
schemeId	string	If the dish has a modifier or combo dish
description	string	Description of the dish
imageUrls	array	Array of links to pictures
measure	object	Serving
value	double	Serving size
unit	string	Unit of measurement: kg, liter, pcs. Non-dictionary meaning
measure.joinMode	string	Single Portion Dishes
isContainInStopList	array	Out-of-stock list
calories	string	Caloric content (kcal)
energyValue	string	Energy value (kJ)
proteins	string	Proteins
fats	string	Fats
carbohydrates	string	Carbohydrates
dishTaxes	object	Taxes on Menu item. Data is filled out in the Manager Station of r_keeper system
taxes	string	Group Name
taxName	string	Tax Name
rateName	string	Rate Name
rate	double	Rate
ingredientsSchemes	array	A set of ingredient or modifier group schemes
id	string	id of ingredient or modifier scheme
ingredientsGroups	array	A set of groups of ingredients or modifiers
id	string	group id
minCount	int	Minimum number of items from a group
maxCount	int	Maximum possible number of items from a group
ingredientsGroups	array	A set of ingredient or modifier group schemes
id	string	group id
name	string	Group name
ingredients	array	Array of ids from ingredients
ingredients	array	Ingredients and modifiers
id	string	ingredient or modifier id
externalId	string	dish identifier. With its help you can create orders by specifying dish identifiers and ingredients/modifiers from r_k 7
name	string	Name of ingredient or modifier
price	string	Price
description	string	Description of the ingredient (not the modifier)
imageUrls	array	Array of image links for the ingredient (not modifier)
measure	object	Serving
value	string	Serving size of ingredient (not modifier)
unit	string	Unit of measurement: kg, liter, pcs. Non-dictionary meaning
name	string	Name of the menu view
isPossibleDelete	boolean	Shows whether the menu view can be removed.
haveChanges	boolean	Indicates whether changes have been made to the menu view.

You can see possible error types in a separate article - Description of errors.