Get the block status

Request

POST

/v2/status

Headers

Name

Description

Authorization

Type: string

A token generated on the side of the Yandex

Example: ``

Partner-Name

Type: string

Partner name

Example: ``

Body

application/json

{
  "vendorInfo": [
    {
      "vendorId": "819711",
      "deliveryType": "ddc"
    }
  ],
  "statuses": [
    "enabled"
  ],
  "limit": 100,
  "offset": 0
}

Name	Description
vendorInfo	Type: VendorInfo Example `[ { "vendorId": "819711", "deliveryType": "ddc" } ]`
limit	Type: integer Issue limit Default: `100`
offset	Type: integer Output offset Default: `0`
statuses	Type: EffectStatuses Example `[ "enabled" ]`

Vendor

Name

Description

deliveryType

Type: string

Delivery type

Enum: ddc, marketplace

vendorId

Type: string

Restaurant ID in the partner's system

Example: 819711

Example

{
  "vendorId": "819711",
  "deliveryType": "ddc"
}

VendorInfo

Type: Vendor[]

Example

[
  {
    "vendorId": "819711",
    "deliveryType": "ddc"
  }
]

EffectStatuses

Type: string[]

Example

[
  "example"
]

Responses

200 OK

Body

application/json

{
  "items": [
    {
      "vendorId": "17205",
      "blockId": "example",
      "externalBlockId": "example",
      "deliveryType": "ddc",
      "availableToCancel": true,
      "status": "enabled",
      "from": "2016-05-12T23:54:32+0100",
      "to": "2016-05-12T23:54:32+0100",
      "source": "Yandex",
      "message": "example"
    }
  ]
}

Name

Description

items

Type: VendorObject[]

Vendor Array

Example

[
  {
    "vendorId": "17205",
    "blockId": "example",
    "externalBlockId": "example",
    "deliveryType": "ddc",
    "availableToCancel": true,
    "status": "enabled",
    "from": "2016-05-12T23:54:32+0100",
    "to": "2016-05-12T23:54:32+0100",
    "source": "Yandex",
    "message": "example"
  }
]

VendorObject

Vendor's object

Name	Description
blockId	Type: string ID of the block in the service Example: `example`
deliveryType	Type: string Block ID Enum: `ddc`, `marketplace`
from	Type: string Date and time of the start of the block Example: `2016-05-12T23:54:32+0100`
vendorId	Type: string Vendor ID Example: `17205`
availableToCancel	Type: boolean The ability to unlock
externalBlockId	Type: string ID of the block in the partner's system Example: `example`
message	Type: string A comment on the blocking (received from a partner) or a description of the blocking from the service Example: `example`
source	Type: string The source of the blockage Example: `Yandex`
status	Type: string Block status Enum: `enabled`, `disabled`
to	Type: string Date and time of the end of the block Example: `2016-05-12T23:54:32+0100`

Example

{
  "vendorId": "17205",
  "blockId": "example",
  "externalBlockId": "example",
  "deliveryType": "ddc",
  "availableToCancel": true,
  "status": "enabled",
  "from": "2016-05-12T23:54:32+0100",
  "to": "2016-05-12T23:54:32+0100",
  "source": "Yandex",
  "message": "example"
}

400 Bad Request

Request error

Body

application/json

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

Name

Description

code

Type: integer

Error code

message

Type: string

Erroe message

Example: example

404 Not Found

The place was not found

Body

application/json

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

Name

Description

code

Type: integer

Error code

message

Type: string

Erroe message

Example: example

500 Internal Server Error

Internal server error

Body

application/json

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

Name

Description

code

Type: integer

Error code

message

Type: string

Erroe message

Example: example

Was the article helpful?

Restaurant blocking

Unblocking restaurants