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

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

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

Request

POST

/partner-integration/v1/place-info/v1/busy-mode-status

Body

application/json

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

Name

Description

filters

Type: BusyModeStatusFilters

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

Example

{
  "origin_ids": [
    "restaurant1"
  ],
  "delivery_type": "marketplace",
  "service": "YE"
}

pagination

Type: BusyModePagination

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

Example

{
  "cursor": "example",
  "limit": 500
}

OriginId

Type: string

Example: restaurant1

DeliveryType

Тип доставки

Type: string

Enum: native, marketplace

Service

Type: string

Enum: YE, MD

BusyModeStatusFilters

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

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

Example

{
  "origin_ids": [
    "restaurant1"
  ],
  "delivery_type": "marketplace",
  "service": "YE"
}

Cursor

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

Type: string

Example: example

Limit

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

Type: integer

Default: 500

Min value: 1

Max value: 500

BusyModePagination

Name

Description

cursor

Type: Cursor

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

Example: example

limit

Type: Limit

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

Default: 500

Min value: 1

Max value: 500

Example: 1

Example

{
  "cursor": "example",
  "limit": 500
}

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": "example"
}

Name

Description

busy_places

Type: BusyPlace[]

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

Example

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

cursor

Type: Cursor

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

Example: example

BusyPlace

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

Example

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

400 Bad Request

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

Body

application/json

{
  "message": "example",
  "code": "example"
}

Name

Description

code

Type: string

Код ошибки

Example: example

message

Type: string

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

Example: example

500 Internal Server Error

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

Body

application/json

{
  "message": "example",
  "code": "example"
}

Name

Description

code

Type: string

Код ошибки

Example: example

message

Type: string

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

Example: example

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

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