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

id

Type: ClaimId

Идентификатор заявки

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

Min length: 32

Max length: 64

Example: 741cedf82cd464fa6fa16d87155c636

route_points

Type: PointWithEta[]

Точки маршрута расчетным временем прибытия курьера.

[
  {
    "id": 1,
    "address": {
      "fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
      "shortname": "Большая Монетная улица, 1к1А",
      "coordinates": [
        0.5,
        0.5
      ],
      "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": "2025-01-01T00:00:00Z",
      "expected_waiting_time_sec": 0,
      "actual": "2025-01-01T00:00:00Z"
    }
  }
]

performer_position

Type: PointsEtaPerformerPosition

Позиция курьера, для которой был рассчитан ETA

Min items: 2

Max items: 2

[
  52.569089,
  39.60258
]

fullname

Type: AddressFullname

Полный адрес с указанием города, улицы и номера дома.
Номер квартиры, подъезда и этаж указывать не нужно.

Example: Санкт-Петербург, Большая Монетная улица, 1к1А

building

Type: string

Строение

Example: 23к1А

building_name

Type: string

Название апартаментов (здания)

Example: БЦ На Большой Монетной

city

Type: string

Город

Example: Санкт-Петербург

comment

Type: string

Комментарий для курьера.

Для точки отправки используйте шаблон: "Доставка из магазина <>. Сообщите менеджеру, что заказ для Яндекс Доставки. Назовите номер заказа <> и заберите посылку. Заказ оплачен безналично, при передаче заказа нельзя требовать с получателя деньги за доставку."

Для точек доставки в комментарии передавайте пожелания получателя. Например, "домофон не работает" / "шлагбаум закрыт, позвонить за 10 минут" / "не звонить, спит ребенок".

Max length: 7000

Example: Домофон не работает

coordinates

Type: number[]

Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке.
Указываются округленные значения координат.

Min items: 2

Max items: 2

[
  0.5,
  0.5
]

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

actual

Type: string<date-time>

Фактическое время посещения точки.
Заполняется только для посещенных точек.

Example: 2025-01-01T00:00:00Z

expected

Type: string<date-time>

Расчетное время посещения. Может быть заполнено
только для непосещенных точек.

Example: 2025-01-01T00:00:00Z

expected_waiting_time_sec

Type: integer

Расчетное время ожидания в точке. (int64)

address

Type: CargoPointAddress

Адрес точки

{
  "fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
  "shortname": "Большая Монетная улица, 1к1А",
  "coordinates": [
    0.5,
    0.5
  ],
  "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": "Санкт-Петербург, Россия"
}

id

Type: integer

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

type

Type: PointType

Тип точки:

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

Enum: source, destination, return

visit_order

Type: integer

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

visit_status

Type: PointVisitStatus

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

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

Enum: pending, arrived, visited, skipped

visited_at

Type: PointVisitTime

Оценка времени посещения

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

{
  "expected": "2025-01-01T00:00:00Z",
  "expected_waiting_time_sec": 0,
  "actual": "2025-01-01T00:00:00Z"
}

code

Type: string

Код ошибки

Enum: unknown_error, not_found

message

Type: string

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

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

code

Type: string

Код ошибки

Enum: unknown_error, inappropriate_status, no_performer_info, unknown_performer_position

message

Type: string

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

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

code

Type: string

Код ошибки

Enum: unknown_error, too_many_requests

message

Type: string

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

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