Get the block status
Request
POST
/v2/status
Headers
|
Name |
Description |
|
Authorization |
Type: string A token generated on the side of the Yandex |
|
Partner-Name |
Type: string Partner name |
Body
application/json
{
"vendorInfo": [
{
"vendorId": "819711",
"deliveryType": "ddc"
}
],
"statuses": [
"enabled"
],
"limit": 100,
"offset": 0
}
|
Name |
Description |
|
vendorInfo* |
Type: Vendor[] |
|
limit |
Type: integer Issue limit Default: Example: |
|
offset |
Type: integer Output offset Default: Example: |
|
statuses |
Type: string[] Enum: |
Vendor
|
Name |
Description |
|
deliveryType |
Type: string Delivery type Example: Enum: |
|
vendorId |
Type: string Restaurant ID in the partner's system Example: |
Responses
200 OK
OK
Body
application/json
{
"items": [
{
"vendorId": "17205",
"blockId": "string",
"externalBlockId": "string",
"deliveryType": "ddc",
"availableToCancel": false,
"status": "enabled",
"from": "2016-05-12T23:54:32+0100",
"to": "2016-05-12T23:54:32+0100",
"source": "Yandex",
"message": "string"
}
]
}
|
Name |
Description |
|
items* |
Type: VendorObject[] Vendor Array |
VendorObject
Vendor's object
|
Name |
Description |
|
blockId* |
Type: string ID of the block in the service |
|
deliveryType* |
Type: string Block ID Enum: |
|
from* |
Type: string Date and time of the start of the block Example: |
|
vendorId* |
Type: string Vendor ID Example: |
|
availableToCancel |
Type: boolean The ability to unlock |
|
externalBlockId |
Type: string ID of the block in the partner's system |
|
message |
Type: string A comment on the blocking (received from a partner) or a description of the blocking from the service |
|
source |
Type: string The source of the blockage Example: |
|
status |
Type: string Block status Enum: |
|
to |
Type: string Date and time of the end of the block Example: |
400 Bad Request
Request error
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
404 Not Found
The place was not found
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
500 Internal Server Error
Internal server error
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
No longer supported, please use an alternative and newer version.