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
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 Restaurant search query filters Example |
|
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/ Example |
OriginId
Type: string
Example: restaurant1
DeliveryType
Delivery type
Type: string
Enum: native, marketplace
Service
Type: string
Enum: YE, MD
BusyModeStatusFilters
Restaurant search query filters
|
Name |
Description |
|
delivery_type |
Type: DeliveryType Delivery type Enum: |
|
origin_ids |
Type: OriginId[] List of restaurant IDs in the partner's system Min items: Max items: Example |
|
service |
Type: Service Enum: |
Example
{
"origin_ids": [
"restaurant1"
],
"delivery_type": "marketplace",
"service": "YE"
}
Cursor
Cursor for getting restaurants with an active high demand status
Type: string
Example: example
Limit
Limit on the number of restaurants to be returned
Type: integer
Default: 500
Min value: 1
Max value: 500
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: Cursor Cursor for getting restaurants with an active high demand status Example: |
|
limit |
Type: Limit Limit on the number of restaurants to be returned Default: Min value: Max value: Example: |
Example
{
"cursor": "example",
"limit": 500
}
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": "example"
}
|
Name |
Description |
|
busy_places |
Type: BusyPlace[] List of restaurants with information about high demand Example |
|
cursor |
Type: Cursor Cursor for getting restaurants with an active high demand status Example: |
BusyPlace
|
Name |
Description |
|
delivery_type |
Type: DeliveryType Delivery type Enum: |
|
extra_minutes |
Type: integer Additional cooking time in minutes |
|
origin_id |
Type: OriginId Example: |
|
services |
Type: Service[] The list of services in which the restaurant is represented Example |
|
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: |
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
Request error
Body
application/json
{
"message": "example",
"code": "example"
}
|
Name |
Description |
|
code |
Type: string Error code Example: |
|
message |
Type: string Error message Example: |
500 Internal Server Error
Internal server error
Body
application/json
{
"message": "example",
"code": "example"
}
|
Name |
Description |
|
code |
Type: string Error code Example: |
|
message |
Type: string Error message Example: |