Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To get the menu, run the following query:

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

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

An aswer Response example:

Code Block
languageyml
{
  "result": {
    "categories": [
      {
        "idID": "string",
        "name": "string",
        "parentIdparentID": "string"
      }
    ],
    "products": [
      {
        "idID": "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": [
      {
        "idID": "string",
        "name": "string",
        "price": 0,
        "schemeIdschemeID": "string",
        "description": "string",
        "imageUrls": [
          "string"
        ],
        "measure": {
          "value": 0,
          "unit": "string"
        }
      }
    ],
    "name": "string",
    "isPossibleDelete": true,
    "haveChanges": true
  }
}

...

ParameterTypeDescription
categoriesarrayMenu category

idID

stringDish category idID

name

stringCategory name

parentIdparentID

stringParent category idID
productsarrayDish

idID

stringDish idID

categoryIdcategoryID

stringCategory idID

name

stringDish name

price

stringPrice

schemeIdschemeID

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

idID

stringIngredients or modifiers scheme idID

ingredientsGroups

arrayArray of ingredients or modifiers groups
  • idID
stringGroup idID
  • 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
idIDstringGroup idID
namestringGroup name
ingredientsarrayArray of ingredients idsIDs
ingredientsarrayIngredients and modifiers

idID

stringIngredient or modifier idID

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 

...