Получение списка ресторанов с активным статусом высокого спроса

Высокий спрос можно установить через приложение Яндекс Еда Вендор, если
ресторан нагружен в данный момент и время приготовления заказов увеличилось.

В будущем будет возможно устанавливать и снимать высокий спрос через API

Примечание

Метод доступен только по подписке.

Request

POST

/v1/busy-mode-status

Body

application/json

{
    "filters": {
        "origin_ids": [
            "restaurant1"
        ],
        "delivery_type": "marketplace",
        "service": "YE"
    },
    "pagination": {
        "cursor": "string",
        "limit": 500
    }
}

Name

Description

filters

Type: BusyModeStatusFilters

Фильтры запроса на поиск ресторанов

pagination

Type: BusyModePagination

Пагинация для получения статуса высокого спроса в ресторанах. Подробнее про пагинацию и курсоры можно почитать на https://slack.engineering/evolving-api-pagination-at-slack/

BusyModeStatusFilters

Фильтры запроса на поиск ресторанов

Name	Description
delivery_type	Type: DeliveryType Тип доставки Example: `marketplace` Enum: `native`, `marketplace`
origin_ids	Type: string[] Список идентификаторов ресторанов в системе партнера Example: `restaurant1` Min items: `1` Max items: `100`
service	Type: Service Enum: `YE`, `MD`

BusyModePagination

Name

Description

cursor

Type: string

Курсор для получения ресторанов с активным статусом высокого спроса

limit

Type: integer

Лимит количества возвращаемых ресторанов

Default: 500

Min value: 1

Max value: 500

DeliveryType

Тип доставки

Type

Description

DeliveryType

Example: marketplace

Enum: native, marketplace

Service

Type	Description
Service	Enum: `YE`, `MD`

Responses

200 OK

Body

application/json

{
    "busy_places": [
        {
            "origin_id": "restaurant1",
            "delivery_type": "marketplace",
            "services": [
                "YE"
            ],
            "extra_minutes": 0,
            "valid_till": "2024-01-01T12:00:05.125+03:00"
        }
    ],
    "cursor": "string"
}

Name

Description

busy_places*

Type: BusyPlace[]

Список ресторанов с информацией о высоком спросе

cursor

Type: string

Курсор для получения ресторанов с активным статусом высокого спроса

BusyPlace

Name	Description
delivery_type*	Type: DeliveryType Тип доставки Example: `marketplace` Enum: `native`, `marketplace`
extra_minutes*	Type: integer Добавочное время к готовке в минутах
origin_id*	Type: string Example: `restaurant1`
services*	Type: Service[] Список сервисов, в которых представлен ресторан Enum: `YE`, `MD`
valid_till*	Type: string<date-time> Дата и время в формате RFC3339 с указанием часового пояса, до которого действует надбавка к готовке Example: `2024-01-01T12:00:05.125+03:00`

400 Bad Request

Ошибка запроса

Body

application/json

{
    "message": "string",
    "code": "string"
}

Name

Description

code*

Type: string

Код ошибки

message*

Type: string

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

500 Internal Server Error

Ошибка сервиса

Body

application/json

{
    "message": "string",
    "code": "string"
}

Name

Description

code*

Type: string

Код ошибки

message*

Type: string

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

Была ли статья полезна?

Детальная информация о заказах