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

Request

POST

/v2/status

Headers

Name

Description

Authorization

Type: string

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

Example: ``

Partner-Name

Type: string

Имя партнера

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 Лимит выдачи Default: `100`
offset	Type: integer Смещение выдачи Default: `0`
statuses	Type: EffectStatuses Example `[ "enabled" ]`

Vendor

Name

Description

deliveryType

Type: string

Тип доставки

Enum: ddc, marketplace

vendorId

Type: string

Id ресторана в системе партнера

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": "delivery club",
      "message": "example"
    }
  ]
}

Name

Description

items

Type: VendorObject[]

Массив вендоров

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": "delivery club",
    "message": "example"
  }
]

VendorObject

Объект вендора

Name	Description
blockId	Type: string Идентификатор блокировки в сервисе Example: `example`
deliveryType	Type: string Идентификатор блокировки Enum: `ddc`, `marketplace`
from	Type: string Дата и время начала блокировки Example: `2016-05-12T23:54:32+0100`
vendorId	Type: string Идентификатор вендора Example: `17205`
availableToCancel	Type: boolean Возможность разблокировки
externalBlockId	Type: string Идентификатор блокировки у партнера Example: `example`
message	Type: string Комментарий к блокировке (полученный от партнера) или описание блокировки от сервиса Example: `example`
source	Type: string Источник блокировки (имя партнера или delivery club) Example: `delivery club`
status	Type: string Статус блокировки Enum: `enabled`, `disabled`
to	Type: string Дата и время окончания блокировки 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": "delivery club",
  "message": "example"
}

400 Bad Request

Ошибка запроса

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

404 Not Found

Плейс не найден

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

500 Internal Server Error

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

Body

application/json

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

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

Блокировка ресторанов

Разблокировка ресторанов