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

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

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

Example: ``

Responses

200 OK

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

Body

application/json

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

Name

Description

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_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

Код ошибки

Enum: unknown_error, too_many_requests

message

Type: string

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

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

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

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

3. Код подтверждения