Retrieve list of restaurants with active high-demand status
High demand can be set through the Yandex Vendor app if
the restaurant is loaded at the moment and the order preparation time has increased.
In the future, it will be possible to install and remove high demand through the API
Note
This method is only available by subscription.
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 Restaurant search query filters |
|
pagination |
Type: BusyModePagination Pagination to obtain the status of high demand in restaurants. More about pagination and cursors at https://slack.engineering/evolving-api-pagination-at-slack/ |
BusyModeStatusFilters
Restaurant search query filters
|
Name |
Description |
|
delivery_type |
Type: DeliveryType Delivery type Example: Enum: |
|
origin_ids |
Type: string[] List of restaurant IDs in the partner's system Example: Min items: Max items: |
|
service |
Type: Service Enum: |
BusyModePagination
Pagination to obtain the status of high demand in restaurants. More about pagination and cursors at https://slack.engineering/evolving-api-pagination-at-slack/
|
Name |
Description |
|
cursor |
Type: string Cursor for getting restaurants with an active high demand status |
|
limit |
Type: integer Limit on the number of restaurants to be returned Default: Min value: Max value: |
DeliveryType
Delivery type
|
Type |
Description |
|
Example: Enum: |
Service
|
Type |
Description |
|
Enum: |
Responses
200 OK
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[] List of restaurants with information about high demand |
|
cursor |
Type: string Cursor for getting restaurants with an active high demand status |
BusyPlace
|
Name |
Description |
|
delivery_type* |
Type: DeliveryType Delivery type Example: Enum: |
|
extra_minutes* |
Type: integer Additional cooking time in minutes |
|
origin_id* |
Type: string Example: |
|
services* |
Type: Service[] The list of services in which the restaurant is represented Enum: |
|
valid_till* |
Type: string<date-time> Date and time in RFC 3339 format with indication of the time zone the belt to which the cooking allowance applies Example: |
400 Bad Request
Request error
Body
application/json
{
"message": "string",
"code": "string"
}
|
Name |
Description |
|
code* |
Type: string Error code |
|
message* |
Type: string Error message |
500 Internal Server Error
Internal server error
Body
application/json
{
"message": "string",
"code": "string"
}
|
Name |
Description |
|
code* |
Type: string Error code |
|
message* |
Type: string Error message |
No longer supported, please use an alternative and newer version.