{
   "type": "string",
   "categories":[
      {
         "id":"string",
         "name":"string",
         "parentId": "string"
      }
   ],
   "classifications": [
       {
          "id": "string",
          "code": "string",
          "name": "string",
          "parentId": "string"
       }
   ],
   "products":[
      {
         "id":"string",
         "categoryId":"string",
         "name":"string",
         "code":"string",
         "price":"string",
         "originalPrice: number,
         "schemeId":"string",
         "description":"string",
         "excise":"string",
         "exciseCode":"string",
         "imageUrls":[
            "string1",
            "string2"
         ],
         "measure":{
            "value":"string",
            "unit":"string",
            "priceMode": "string",
            "qntDecDigits": "string",
            "changeQntOnce": "true/false",
            "joinMode": "string"
         },
         "classificationIds": [
            "string1",
            "string2"
         ],
         "protein": "string",
         "fat": "string",
         "carbohydrates": "string",
         "kcal": "string",
         "globalTradeItemNumbers": "string",
         "alcoholCodes": "string",
         "openPrice": boolean
         "dishTaxes": {
           "groupName": "10% VAT",
           "taxes": [
             {
                "taxName": "VAT",
                "rateName": "10,00 %",
                "rate": 10
             }
           ]
         }       
       }
   ],
   "ingredientsSchemes":[
      {
         "id":"string",
         "ingredientsGroups":[
            {
               "id":"string",
               "minCount":number,
               "maxCount":number,
               "changesPrice":true/false
            }
         ]
      }
   ],
   "ingredientsGroups":[
      {
         "id":"string",
         "name":"string",
         "ingredients":[
            "string"
         ]
      }
   ],
   "ingredients":[
      {
         "id":"string",
         "name":"string",
         "code":"string",
         "price":"string",
         "originalPrice: number,
         "schemeId":"string",
         "description":"string",
         "excise":string,
         "exciseCode":string,
         "dishId":number,
         "imageUrls":[
            "string1",
            "string2"
         ],
         "measure":{
            "value":"string",
            "unit":"string"
         }
      }
   ]
}

Parameter

Parameter type

Mandatory

Description

Parameter

Parameter type

Mandatory

Description

typestring enumyes (agent v1 only)

The type of menu returned by the agent. Possible options:

  • selectors —  selectors menu
  • menu — data from the Menu directory.
  categoriesarrayyesArray of dish categories
      idstring-Category ID
      namestring-Category name
      parentIdstring-If parentId is specified, then this is a child category
productsarrayyesAn array of dishes from the menu
   idstring-Dish ID
   categoryIdstring-Category of dish
   classificationIds*string array-Array of classification identifiers that include the dish
   namestring-Name of the dish
   code*string-Dish code
   pricestring-Cost of the dish. Depends on the price type specified during the request or the agent configuration
   originalPricedecimal-

Cost of the dish for the aggregator. Only when receiving a menu from r_k Delivery (delivery multi-agent)

   schemeIdstring-

Used for an option of a dish with modifiers or combos.

It is not included in a simple dish.

   descriptionstring-Description of the dish, obtained from the Recipe field. If you fill in the Description for delivery field, the value from this field will be displayed
   imageUrlsstring array-An array of images. Links to images are passed
   excisestring-Excise tax indicator. Can take values: sugary_drink, other or null
   exciseCodestring-

Excise code. Can take values ​​from the classification of r_keeper markings:

1 – Goods (regular non-excise goods)
2 – Excisable goods
3 – Work
4 – Service
10 – Payment
30 – Excisable goods without marking code
31 – Excisable goods with marking code
32 – Non-excisable goods without a marking code
33 – Non-excisable goods with a marking code

   measure
-Portion size
      valuestring-Portion Size Value
      unitstring-Unit of measurement: liter, gr, piece, kg, etc.
      priceModestring-Dish selling mode: PerPiece, PerPortion, PerUnitOfWeight, PerDose. Starting with agent version 2.7.1.4
      qntDecDigitsstring-

Weight precision — number of digits after the decimal point, for example (if 0, then only an integer value can be specified, if 3, then 2.456)

Starting with agent version 2.7.1.4

      changeQntOncestring-

If true, then weight change is allowed only once after K.O.T. printing

Starting with agent version 2.7.1.4

      joinModestring-

Method of adding to order

almSeparately - On a separate line

almOnePortion - Separate line for each portion

almJoinLines - Merge

Starting with agent version 2.7.1.4

     proteinstring-Proteins. Only when receiving a menu from r_k Delivery (delivery multi-agent)
      fatstring-Fats. Only when receiving a menu from r_k Delivery (delivery multi-agent)
  carbohydratesstring-Carbohydrates. Only when receiving a menu from r_k Delivery (delivery multi-agent)
   kcalstring-Kcal. Only when receiving a menu from r_k Delivery (delivery multi-agent)
globalTradeItemNumbersstring-Starting with WSA 2.8.1.11 and r_keeper 7.7.0.307
   alcoholCodesstring-Starting with WSA 2.8.1.11 and r_keeper 7.7.0.307
   openPriceboolean

Open price indicator (if true, the item's price can be set differently from the Base Price when creating an order).

dishTaxesobject-

Information on taxes applied to the dish. May not be included if it is a combo dish.

To apply the changes, you need to restart the cash server (or servers, if there are several)

 groupNamestring
Name of the tax group applied to the dish in r_k 7
 taxesarray
Array of applied taxes
    taxNamestring
Name of tax
    rateNamestring
Rate name
    ratenumber
Rate value in percentage
ingredientsSchemesarrayyesArray of ingredient schemes or modifiers for dishes
   idstring-Ingredient or modifier scheme identifier
   ingredientsGroupsarray-An array of ingredient groups or modifiers included in the scheme
      idstring-Group ID
      minCountnumberyesMinimum required number of elements from a group
      maxCountnumberyesMaximum possible number of elements from a group
      changesPrice boolean-Checkbox value Changes the price from the modifier group parameters since version 2.7.3.10
ingredientsGroups
yesArray with groups of ingredients or modifiers
   idstring-Group ID
   namestring-Group name
   ingredientsarray string-An array of acceptable ingredients or modifiers
ingredients
yesArray of combo dish ingredients and dish modifiers
   idstring-Identifier
   namestring-Name of the combo ingredient or dish modifier
   code*string-Combo ingredient or dish modifier code
   pricestring-Price
   originalPricedecimal-

Cost of modifier for aggregator. Only when receiving menu from r_k Delivery (delivery multi-agent)

   schemeIdstring-Modifier or ingredient scheme identifier
   maxAmountForDishnumber

yes

There is a limit on the maximum amount of this ingredient that can be ordered with a dish.

If 0 or absent then there are no restrictions.

   descriptionstring-Description of the dish obtained from the Recipe field
   imageUrlsarray string-An array of images. Links to images are passed
   dishId*number-The ID of the dish the ingredient belongs to. For combos only.
   excisestring-Excise tax indicator. Can take values: sugary_drink, other or null
   exciseCodestring-

Excise code. Can take values ​​from the classification of r_keeper markings:

1 – Goods (regular non-excise goods)
2 – Excisable goods
3 – Work
4 – Service
10 – Payment
30 – Excisable goods without marking code
31 – Excisable goods with marking code
32 – Non-excisable goods without a marking code
33 – Non-excisable goods with a marking code

   measure
-Portion size
      valuestring-Portion Size Value
      unitstring-

Unit of measurement: liter, gr, piece, kg, etc.

classifications*array-Array of classification of dishes
      idstringyesClassification ID
      codestring-Classification code
      namestring-Classification name
      parentIdstring-If parentId is specified, then this is a child classification

Fields marked with an asterisk are not present in the response for the GetMenu request. They are returned from the WSA but are not present in the WS model.