Получение состояний обмена роботом

Возвращает состояния обмена посылкой роботом доставщиком на точках маршрута.

На основе ответа можно определить:

состояние обмена на каждой точке маршрута
требуется ли подтверждение завершения обмена на каждой точке маршрута
номер секции в отсеке робота, если они есть

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v1/robot/handover/info

Адрес сервиса

Query parameters

Name

Description

claim_id

Type: string

ID заявки, полученный на этапе создания заявки

Min length: 32

Max length: 64

Example: ``

Headers

Name

Description

Accept-Language

Type: string

Предпочитаемый язык ответа

Например:
ru — русский
en — английский

Example: ru

Responses

200 OK

success

Body

application/json

{
  "handovers": [
    {
      "type": "with_confirmation",
      "status": "pending",
      "section": 1,
      "claim_point_id": 372036854775807
    }
  ]
}

Name	Description
handovers	Type: HandoverInfoItem[] Example `[ { "type": "with_confirmation", "status": "pending", "section": 1, "claim_point_id": 372036854775807 } ]`

HandoverType

Тип обмена посылкой с роботом

with_confirmation - с подтверждением завершения обмена
without_confirmation - без подтверждения завершения обмена,
(при зарытии крышки обмен считается завершенным)

Type: string

Enum: with_confirmation, without_confirmation

HandoverStatus

Type: string

Enum: pending, ready, initializing, exchanging, finishing, completed, skipped

ClaimPointId

Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.

Type: integer

HandoverInfoItem

Name	Description
status	Type: HandoverStatus Enum: `pending`, `ready`, `initializing`, `exchanging`, `finishing`, `completed`, `skipped`
type	Type: HandoverType Тип обмена посылкой с роботом with_confirmation - с подтверждением завершения обмена without_confirmation - без подтверждения завершения обмена, (при зарытии крышки обмен считается завершенным) Enum: `with_confirmation`, `without_confirmation`
claim_point_id	Type: ClaimPointId Целочисленный идентификатор точки (int64), генерируемый на стороне Яндекс Доставки. Содержится в поле route_points[].id. Применимо к точкам с типом source, destination, return. Example: `372036854775807`
section	Type: integer Номер секции в отсеке робота. Если значение null - значит у робота только один отсек без разделителей.

Example

{
  "type": "with_confirmation",
  "status": "pending",
  "section": 1,
  "claim_point_id": 372036854775807
}

400 Bad Request

Некорректный запрос

Body

application/json

{
  "code": "state_mismatch",
  "message": "State mismatch error"
}

Name

Description

code

Type: string

Код ошибки

Example: state_mismatch

message

Type: string

Описание ошибки

Example: State mismatch error

404 Not Found

Заявка не найдена

Body

application/json

{
  "code": "state_mismatch",
  "message": "State mismatch error"
}

Name

Description

code

Type: string

Код ошибки

Example: state_mismatch

message

Type: string

Описание ошибки

Example: State mismatch error

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

9.1 Начало обмена посылкой с роботом

9.3 Подтверждение завершения обмена с роботом