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

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

Request

GET

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

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

Query parameters

Name

Description

claim_id*

Type: string

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

Responses

200 OK

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

Body

application/json
{
    "position": {
        "lat": 0,
        "lon": 0,
        "timestamp": 0,
        "accuracy": 0,
        "speed": 0,
        "direction": 0
    },
    "route_points": [
        {
            "id": 1,
            "type": "source",
            "visit_order": 1,
            "sharing_link": "string"
        }
    ]
}

Name

Description

position*

Type: object

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

route_points

Type: PointWithSharingLink[]

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

Name

Description

id*

Type: integer<int64>

Целочисленный идентификатор точки (int64)

Example: 1

type*

Type: PointType

Тип точки:

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


Example: source
Enum: source, destination, return

visit_order*

Type: integer<int64>

Порядок посещения точки (нумерация начинается с 1) (int64)

Example: 1

sharing_link

Type: string

Ссылка для отслеживания маршрута. Доступна
только для точек с типом 'destination'

PointType

Тип точки:

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

Type

Description

PointType

Example: source
Enum: source, destination, return

404 Not Found

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

Body

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

Name

Description

code*

Type: string

Код ошибки

Example: not_found
Enum: not_found

message*

Type: string

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

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

409 Conflict

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

Body

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

Name

Description

code*

Type: string

Код ошибки

Example: inappropriate_status
Enum: 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

Код ошибки

Example: too_many_requests
Enum: too_many_requests

message*

Type: string

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

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

Предыдущая