To get the menu, run the following query:

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

The menu view for an API connection is set in the card. 

Response 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
  }
}
YML

Parameters description

ParameterTypeDescription
categoriesarrayMenu category

ID

stringDish category ID

name

stringCategory name

parentID

stringParent category ID
productsarrayDish

ID

stringDish ID

categoryID

stringCategory ID

name

stringDish name

price

stringPrice

schemeID

stringIf a dish has a modifier or a combo-dish

description

stringDish description

imageUrls

arrayImage URLs array

measure

objectServing
  • value
doubleServing size
  • unit
stringUnit of measurement: kg, liter, pcs. 

isContainInStopList

arrayStop-list
caloriesstring

Calorific value (kcal)

energyValuestringEnergy value (kJ)
proteinsstringProteins
fatsstringFats
carbohydratesstringCarbohydrates
ingredientsSchemesarrayArray of ingredients or modifiers groups schemes

ID

stringIngredients or modifiers scheme ID

ingredientsGroups

arrayArray of ingredients or modifiers groups
  • ID
stringGroup ID
  • minCount
 int

Minimum number of items of the group

  • maxCount
 int Maximum possible number of items of the group

ingredientsGroups

arrayArray of ingredients or modifiers groups schemes
IDstringGroup ID
namestringGroup name
ingredientsarrayArray of ingredients IDs
ingredientsarrayIngredients and modifiers

ID

stringIngredient or modifier ID

name

stringIngredient or modifier name

price

stringPrice

description

stringIngredient (not modifier) description

imageUrls

arrayImage URLs array for the ingredient (not a modifier)

measure

objectServing
  • value
stringIngredient (not modifier) serving size
  • unit
stringUnit of measurement: kg, liter, pcs. 
namestringMenu view name
isPossibleDeletebooleanShows if it is possible to delete a menu view
haveChangesbooleanShows if there are any changes in the menu view 

Find the list of possible errors in the «Errors description» article