Ссылки для отслеживания курьера

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

Request

GET

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/tracking-links

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

Query parameters

Name

Description

claim_id*

Type: string

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

Min length: 32

Max length: 64

Responses

200 OK

Ссылки для отслеживания курьера

Body

application/json

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

Name

Description

route_points*

Type: PointWithSharingLink[]

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

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: unknown_error, 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_error, unknown_tracking_links, 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: unknown_error, too_many_requests

message*

Type: string

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

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

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

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

2.5 Фото с маршрута