Menu
Response format
|
Parameter | Parameter type | Mandatory | Description |
---|---|---|---|
Parameter | Parameter type | Mandatory | Description |
type | string enum | yes (agent v1 only) | The type of menu returned by the agent. Possible options:
|
categories | array | yes | Array of dish categories |
id | string | - | Category ID |
name | string | - | Category name |
parentId | string | - | If parentId is specified, then this is a child category |
products | array | yes | An array of dishes from the menu |
id | string | - | Dish ID |
categoryId | string | - | Category of dish |
classificationIds* | string array | - | Array of classification identifiers that include the dish |
name | string | - | Name of the dish |
code* | string | - | Dish code |
price | string | - | Cost of the dish. Depends on the price type specified during the request or the agent configuration |
originalPrice | decimal | - | Cost of the dish for the aggregator. Only when receiving a menu from r_k Delivery (delivery multi-agent) |
schemeId | string | - | Used for an option of a dish with modifiers or combos. It is not included in a simple dish. |
description | string | - | 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 |
imageUrls | string array | - | An array of images. Links to images are passed |
excise | string | - | Excise tax indicator. Can take values: sugary_drink, other or null |
exciseCode | string | - | Excise code. Can take values from the classification of r_keeper markings: 1 – Goods (regular non-excise goods) |
measure | - | Portion size | |
value | string | - | Portion Size Value |
unit | string | - | Unit of measurement: liter, gr, piece, kg, etc. |
priceMode | string | - | Dish selling mode: PerPiece, PerPortion, PerUnitOfWeight, PerDose. Starting with agent version 2.7.1.4 |
qntDecDigits | string | - | 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 |
changeQntOnce | string | - | If true, then weight change is allowed only once after K.O.T. printing Starting with agent version 2.7.1.4 |
joinMode | string | - | 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 |
protein | string | - | Proteins. Only when receiving a menu from r_k Delivery (delivery multi-agent) |
fat | string | - | Fats. Only when receiving a menu from r_k Delivery (delivery multi-agent) |
carbohydrates | string | - | Carbohydrates. Only when receiving a menu from r_k Delivery (delivery multi-agent) |
kcal | string | - | Kcal. Only when receiving a menu from r_k Delivery (delivery multi-agent) |
globalTradeItemNumbers | string | - | Starting with WSA 2.8.1.11 and r_keeper 7.7.0.307 |
alcoholCodes | string | - | Starting with WSA 2.8.1.11 and r_keeper 7.7.0.307 |
openPrice | boolean | Open price indicator (if true, the item's price can be set differently from the Base Price when creating an order). | |
dishTaxes | object | - | 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) |
groupName | string | Name of the tax group applied to the dish in r_k 7 | |
taxes | array | Array of applied taxes | |
taxName | string | Name of tax | |
rateName | string | Rate name | |
rate | number | Rate value in percentage | |
ingredientsSchemes | array | yes | Array of ingredient schemes or modifiers for dishes |
id | string | - | Ingredient or modifier scheme identifier |
ingredientsGroups | array | - | An array of ingredient groups or modifiers included in the scheme |
id | string | - | Group ID |
minCount | number | yes | Minimum required number of elements from a group |
maxCount | number | yes | Maximum 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 | yes | Array with groups of ingredients or modifiers | |
id | string | - | Group ID |
name | string | - | Group name |
ingredients | array string | - | An array of acceptable ingredients or modifiers |
ingredients | yes | Array of combo dish ingredients and dish modifiers | |
id | string | - | Identifier |
name | string | - | Name of the combo ingredient or dish modifier |
code* | string | - | Combo ingredient or dish modifier code |
price | string | - | Price |
originalPrice | decimal | - | Cost of modifier for aggregator. Only when receiving menu from r_k Delivery (delivery multi-agent) |
schemeId | string | - | Modifier or ingredient scheme identifier |
maxAmountForDish | number | 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. |
description | string | - | Description of the dish obtained from the Recipe field |
imageUrls | array string | - | An array of images. Links to images are passed |
dishId* | number | - | The ID of the dish the ingredient belongs to. For combos only. |
excise | string | - | Excise tax indicator. Can take values: sugary_drink, other or null |
exciseCode | string | - | Excise code. Can take values from the classification of r_keeper markings: 1 – Goods (regular non-excise goods) |
measure | - | Portion size | |
value | string | - | Portion Size Value |
unit | string | - | Unit of measurement: liter, gr, piece, kg, etc. |
classifications* | array | - | Array of classification of dishes |
id | string | yes | Classification ID |
code | string | - | Classification code |
name | string | - | Classification name |
parentId | string | - | 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.