Прогнозируемое время прибытия курьера

Возвращает список точек и оценку времени прибытия на точку курьером.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/points-eta

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

Query parameters

Name

Description

claim_id*

Type: string

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

Min length: 32

Max length: 64

Headers

Name

Description

Accept-Language*

Type: string

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

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

Example: ru

Responses

200 OK

Оценка времени прибытия курьера на точки

Body

application/json

{
    "id": "741cedf82cd464fa6fa16d87155c636",
    "route_points": [
        {
            "id": 1,
            "address": {
                "fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
                "shortname": "Большая Монетная улица, 1к1А",
                "coordinates": [
                    0
                ],
                "country": "Россия",
                "city": "Санкт-Петербург",
                "building_name": "БЦ На Большой Монетной",
                "street": "Большая Монетная улица",
                "building": "23к1А",
                "porch": "A",
                "sfloor": "1",
                "sflat": "1",
                "door_code": "169",
                "door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
                "doorbell_name": "Магидович",
                "comment": "Домофон не работает",
                "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
                "description": "Санкт-Петербург, Россия"
            },
            "type": "source",
            "visit_order": 1,
            "visit_status": "pending",
            "visited_at": {
                "expected": "2022-12-29T18:02:01Z",
                "expected_waiting_time_sec": 0,
                "actual": "2022-12-29T18:02:01Z"
            }
        }
    ],
    "performer_position": [
        52.569089,
        39.60258
    ]
}

Name	Description
id*	Type: string Идентификатор(ID) заявки, полученный на этапе создания заявки Example: `741cedf82cd464fa6fa16d87155c636` Min length: `32` Max length: `64`
route_points*	Type: PointWithEta[] Точки маршрута расчетным временем прибытия курьера.
performer_position	Type: number[] Позиция курьера, для которой был рассчитан ETA Example: `52.569089,39.60258` Min items: `2` Max items: `2`

PointWithEta

Name	Description
address*	Type: CargoPointAddress Адрес точки
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`
visit_status*	Type: PointVisitStatus Статус посещения точки: pending - точка еще не посещена; arrived - курьер прибыл на точку; visited - курьер передал/забрал груз на точке; skipped - точка пропущена (в случае, если не смог принять товар). Example: `pending` Enum: `pending`, `arrived`, `visited`, `skipped`
visited_at*	Type: PointVisitTime Оценка времени посещения

CargoPointAddress

Адрес точки

Name	Description
fullname*	Type: string Полный адрес с указанием города, улицы и номера дома. Номер квартиры, подъезда и этаж указывать не нужно. Example: `Санкт-Петербург, Большая Монетная улица, 1к1А`
building	Type: string Строение Example: `23к1А`
building_name	Type: string Название апартаментов (здания) Example: `БЦ На Большой Монетной`
city	Type: string Город Example: `Санкт-Петербург`
comment	Type: string Комментарий для курьера. Для точки отправки используйте шаблон: "Доставка из магазина <>. Сообщите менеджеру, что заказ для Яндекс Доставки. Назовите номер заказа <> и заберите посылку. Заказ оплачен безналично, при передаче заказа нельзя требовать с получателя деньги за доставку." Для точек доставки в комментарии передавайте пожелания получателя. Например, "домофон не работает" / "шлагбаум закрыт, позвонить за 10 минут" / "не звонить, спит ребенок". Example: `Домофон не работает` Max length: `7000`
coordinates	Type: number[] Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке. Указываются округленные значения координат. Min items: `2` Max items: `2`
country	Type: string Страна Example: `Россия`
description	Type: string Географическая область, уточняющая краткий адрес до глобального соответствия Example: `Санкт-Петербург, Россия`
door_code	Type: string Код домофона Example: `169`
door_code_extra	Type: string Дополнительные указания по домофонам Example: `код на вход во двор #1234, код от апартаментов #4321`
doorbell_name	Type: string Имя на дверном звонке Example: `Магидович`
porch	Type: string Подъезд (может быть A) Example: `A`
sflat	Type: string Квартира Example: `1`
sfloor	Type: string Этаж Example: `1`
shortname	Type: string Краткий адрес в пределах города (как на Таксометре) Example: `Большая Монетная улица, 1к1А`
street	Type: string Улица Example: `Большая Монетная улица`
uri	Type: string URI геообъекта на картах Example: `ymapsbm1://geo?ll=38.805%2C55.084`

PointType

Тип точки:

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

Type

Description

PointType

Example: source

Enum: source, destination, return

PointVisitStatus

Статус посещения точки:

pending - точка еще не посещена;
arrived - курьер прибыл на точку;
visited - курьер передал/забрал груз на точке;
skipped - точка пропущена (в случае, если не смог принять товар).

Type

Description

PointVisitStatus

Example: pending

Enum: pending, arrived, visited, skipped

PointVisitTime

Информация о времени посещения точки

Name	Description
actual	Type: string<date-time> Фактическое время посещения точки. Заполняется только для посещенных точек.
expected	Type: string<date-time> Расчетное время посещения. Может быть заполнено только для непосещенных точек.
expected_waiting_time_sec	Type: integer<int64> Расчетное время ожидания в точке. (int64)

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, inappropriate_status, no_performer_info, unknown_performer_position

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.2 Локация

2.4 Ссылки для отслеживания