To get the menu, run the following query:
The menu view for an API connection is set in the card.
An aswer example:
{ "result": { "categories": [ { "id": "string", "name": "string", "parentId": "string" } ], "products": [ { "id": "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", "name": "string", "price": 0, "schemeId": "string", "description": "string", "imageUrls": [ "string" ], "measure": { "value": 0, "unit": "string" } } ], "name": "string", "isPossibleDelete": true, "haveChanges": true } }
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 |
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 |
| double | Serving size |
| 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 |
| string | Group id |
| int | Minimum number of items of the group |
| 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 |
| string | Ingredient (not modifier) serving size |
| 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 possible errors in this article.