Получение статуса блокировок

Метод позволяет Партнёру получить статус блокировок магазинов из системы Яндекс Еды.

Request

POST

/v2/status

Headers

Name

Description

Authorization

Type: string

Токен, сформированный на стороне Яндекс Еды.

Example: ``

Partner-Name

Type: string

Имя Партнёра.

Example: ``

Body

application/json

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

Name	Description
vendorInfo	Type: VendorInfo Example `[ { "vendorId": "819711", "deliveryType": "ddc" } ]`

VendorInfoItems

Name

Description

vendorId

Type: string

Id магазина в системе Партнёра.

Example: 819711

deliveryType

Type: string

Тип доставки.

Enum: ddc, marketplace

Example

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

VendorInfo

Type: VendorInfoItems[]

Example

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

Responses

200 OK

Body

application/json

{
  "items": [
    {
      "vendorId": "17205",
      "blockId": "example",
      "deliveryType": "ddc",
      "availableToCancel": true,
      "from": "2016-05-12T23:54:32+0100",
      "to": "2016-05-12T23:54:32+0100",
      "source": "delivery club",
      "message": "Технические причины"
    }
  ]
}

Name

Description

items

Type: ItemBlockStatusResponse[]

Example

[
  {
    "vendorId": "17205",
    "blockId": "example",
    "deliveryType": "ddc",
    "availableToCancel": true,
    "from": "2016-05-12T23:54:32+0100",
    "to": "2016-05-12T23:54:32+0100",
    "source": "delivery club",
    "message": "Технические причины"
  }
]

ItemBlockStatusResponse

Name	Description
blockId	Type: string Идентификатор блокировки в сервисе Example: `example`
deliveryType	Type: string Тип доставки Enum: `ddc`, `marketplace`
from	Type: string Дата и время начала блокировки Example: `2016-05-12T23:54:32+0100`
source	Type: string Источник блокировки (имя Партнёра или delivery club для собственных блокировок Яндекс Еды). Example: `delivery club`
vendorId	Type: string Id магазина в системе Партнёра Example: `17205`
availableToCancel	Type: boolean Возможность разблокировки
message	Type: string Комментарий к блокировке, передается только для внутренних блокировок Яндекс Еды. Example: `Технические причины`
to	Type: string Дата и время окончания блокировки Example: `2016-05-12T23:54:32+0100`

Example

{
  "vendorId": "17205",
  "blockId": "example",
  "deliveryType": "ddc",
  "availableToCancel": true,
  "from": "2016-05-12T23:54:32+0100",
  "to": "2016-05-12T23:54:32+0100",
  "source": "delivery club",
  "message": "Технические причины"
}

400 Bad Request

Ошибка в запросе.

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

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

Example: example

details

Type: object

Example

{}

404 Not Found

Магазин не найден.

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

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

Example: example

details

Type: object

Example

{}

500 Internal Server Error

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

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

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

Example: example

details

Type: object

Example

{}

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

Блокировка магазинов

Разблокировка магазинов