Получить позиции меню, недоступные для заказа на текущий момент

Позиции, содержащие схематические или логические несоответствия (слишком длинная строка, остаток равен -10.00) могут быть проигнорированы. Актуальная версия модели ответа - application/vnd.eats.menu.availability.v2+json

Request

GET

/menu/{restaurantId}/availability

Path parameters

Name

Description

restaurantId*

Type: string

Идентификатор ресторана в системе партнёра

Responses

200 OK

Возвращает список позиций меню, недоступных на текущий момент в данном ресторане

Body

application/vnd.eats.menu.availability.v2+json
{
    "items": [
        {
            "itemId": "eff0cec0-058c-4d53-b524-1c04ac24fb51",
            "stock": 5
        }
    ],
    "modifiers": [
        {
            "modifierId": "eff0cec0-058c-4d53-b524-1c04ac24fb51",
            "stock": 5
        }
    ],
    "combos": [
        {
            "comboId": "string",
            "stock": 5.5
        }
    ]
}

Name

Description

items*

Type: MenuAvailabilityItems[]

Список пунктов меню, по которым требуется изменить доступность

modifiers*

Type: MenuAvailabilityModifiers[]

Список модификаторов блюд, по которым требуется изменить доступность

combos

Type: MenuAvailabilityCombos[]

Список комбо, по которым требуется изменить доступность

Name

Description

itemId*

Type: string

Внутренний идентификатор блюда в ресторане в системе партнера. Может быть любым значением, приводимым к строке. Рекомендация – UUID4

Example: eff0cec0-058c-4d53-b524-1c04ac24fb51

stock

Type: integer<int32>

Остаток в ресторане. При 0 блюдо пропадает из выдачи. Не обязательное поле. Если stock для itemId не передан, то остаток блюда считается за 0.

Default: 0

Example: 5

Name

Description

modifierId*

Type: string

Внутренний идентификатор модификатора в ресторане в системе партнера. Может быть любым значением, приводимым к строке. Рекомендация – UUID4

Example: eff0cec0-058c-4d53-b524-1c04ac24fb51

stock

Type: integer<int32>

Остаток в ресторане. При 0 модификатор пропадает из выдачи. Не обязательное поле. Если stock для modifierId не передан, то остаток блюда считается за 0.

Default: 0

Example: 5

Name

Description

comboId*

Type: string

Внутренний идентификатор комбо в ресторане в системе партнера. Может быть любым значением, приводимым к строке. Рекомендация - UUID4

stock

Type: number<float>

Остаток в ресторане. При 0 комбо пропадает из выдачи. Не обязательное поле. Если не указан, считается за 0

Default: 0

Example: 5.5

401 Unauthorized

Не пройдена авторизация - истек токен, либо не был передан в запросе. Будет сделан ретрай

Body

application/json
{
    "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason*

Type: string

Причина, по которой не прошла авторизация

Example: Access token has been expired. You should request a new one

404 Not Found

Не найден ресторан. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
    {
        "code": 100,
        "description": "Description of error"
    }
]

ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Согласованный с Яндекс.Еда числовой код ошибки

Example: 100

description

Type: string

Сообщение об ошибке

Example: Description of error

500 Internal Server Error

Внутренние ошибки сервера. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
    {
        "code": 100,
        "description": "Description of error"
    }
]

ErrorItem[]

No longer supported, please use an alternative and newer version.

Предыдущая
Получить актуальное меню ресторана
Следующая
Получить акционные блюда в связке с меню