To get the menu, run the following query:
| Code Block |
|---|
GET https://delivery.ucs.ru/orders/api/v1/menu/view |
The menu view for an API connection is set in the card.
| Info |
|---|
To get the menu for a specific restaurant, add restaurantId to the query |
Query example:
| Code Block |
|---|
GET https://delivery.ucs.ru/orders/api/v1/menu/view/?restaurantId=18f550d8-7fbe-45fa-8c83-35f531380f65 |
Response example:
| Code Block | ||
|---|---|---|
| ||
{
"result": {
"categories": [
{
"IDid": "string",
"name": "string",
"parentIDparentId": "string"
}
],
"products": [
{
"IDid": "string",
"externalId": "string",
"categoryIDcategoryId": "string",
"name": "string",
"price": 0,
"schemeIDschemeId": "string",
"description": "string",
"imageUrls": [
"string"
],
"measure": {
"value": 0,
"unit": "string"
},
"isContainInStopList": [
"string"
],
"calories": 0,
"energyValue": 0,
"proteins": 0,
"fats": 0,
"carbohydrates": 0
}
],
"ingredientsSchemes": [
{
"IDid": "string"
"ingredientsGroups": [
{
"IDid": "string",
"minCount": 0,
"maxCount": 0
}
]
}
],
"ingredientsGroups": [
{
"IDid": "string",
"name": "string",
"ingredients": [
"string"
]
}
],
"ingredients": [
{
"id": "string",
"IDexternalId": "string",
"name": "string",
"price": 0,
"schemeIDschemeId": "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 |
IDid | string | Dish category ID |
name | string | Category name |
parentIDparentId | string | Parent category ID |
| products | array | Dish |
IDid | 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 |
categoryIdcategoryID | string | Category ID |
name | string | Dish name |
price | string | Price |
schemeIDschemeId | 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 |
IDId | 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 |
| IDId | string | Group ID |
| name | string | Group name |
| ingredients | array | Array of ingredients IDs |
| ingredients | array | Ingredients and modifiers |
IDId | 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 |
...