Местоположение курьера

Метод возвращает координаты, скорость и направления движения курьера заявки.

Request

GET

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/performer-position

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

Query parameters

Name

Description

claim_id

Type: string

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

Min length: 32

Max length: 64

Example: ``

Responses

200 OK

Информация о местоположении курьера

Body

application/json

{
  "position": {
    "lat": -90,
    "lon": -180,
    "timestamp": 0,
    "accuracy": 0.5,
    "speed": 0.5,
    "direction": 0.5
  },
  "route_points": [
    {
      "id": 1,
      "type": "source",
      "visit_order": 1,
      "sharing_link": "example"
    }
  ]
}

Name

Description

position

Type: object

lat	Type: number Широта Min value: `-90` Max value: `90`
lon	Type: number Долгота Min value: `-180` Max value: `180`
timestamp	Type: integer Время снятия сигнала GPS, unix-time
accuracy	Type: number Точность GPS. Пока запрещена к передаче т.к. не решили с единицами измерения.
direction	Type: number Направление. Угол от 0 градусов до 360 градусов от направления на север, по часовой стрелке. 0 - север, 90 - восток, 180 - юг, 270 - запад.
speed	Type: number Средняя скорость, в м/с

Расширенный формат геопозиции курьера

Example

{
  "lat": -90,
  "lon": -180,
  "timestamp": 0,
  "accuracy": 0.5,
  "speed": 0.5,
  "direction": 0.5
}

route_points

Type: PointWithSharingLink[]

Точки маршрута со ссылками на отслеживание

Example

[
  {
    "id": 1,
    "type": "source",
    "visit_order": 1,
    "sharing_link": "example"
  }
]

PointType

Тип точки:

source - точка отправления, где курьер забирает товар
destination – точки назначения, где курьер передает товар
return - точка возврата товара (добавляется автоматически и по умолчанию совпадает с точкой отправления, но также можно определить другую точку)

Type: string

Enum: source, destination, return

PointWithSharingLink

Name	Description
id	Type: integer Целочисленный идентификатор точки (int64)
type	Type: PointType Тип точки: source - точка отправления, где курьер забирает товар destination – точки назначения, где курьер передает товар return - точка возврата товара (добавляется автоматически и по умолчанию совпадает с точкой отправления, но также можно определить другую точку) Enum: `source`, `destination`, `return`
visit_order	Type: integer Порядок посещения точки (нумерация начинается с 1) (int64)
sharing_link	Type: string Ссылка для отслеживания маршрута. Доступна только для точек с типом 'destination' Example: `example`

Example

{
  "id": 1,
  "type": "source",
  "visit_order": 1,
  "sharing_link": "example"
}

404 Not Found

Исполнитель или местоположение курьера не найдены

Body

application/json

{
  "code": "not_found",
  "message": "Заявка не найдена"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, not_found

message

Type: string

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

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

409 Conflict

Заявка в неактивном статусе или нет информации об исполнителе

Body

application/json

{
  "code": "inappropriate_status",
  "message": "Недопустимое действие над заявкой"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, unknown_performer_position, inappropriate_status

message

Type: string

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

Example: Недопустимое действие над заявкой

429 Too Many Requests

Слишком много запросов

Body

application/json

{
  "code": "too_many_requests",
  "message": "Слишком много запросов"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, too_many_requests

message

Type: string

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

Example: Слишком много запросов

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

2.1 Телефон

2.3 Время прибытия