Courier's estimated time of arrival

id

Type: ClaimId

Claim ID

Claim ID obtained at the claim creation stage

Min length: 32

Max length: 64

Example: 741cedf82cd464fa6fa16d87155c636

route_points

Type: PointWithEta[]

Route points with an estimated time of arrival of the courier.

[
  {
    "id": 1,
    "address": {
      "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
      "shortname": "Bol'shaya Monetnaya Street, 1f1A",
      "coordinates": [
        0.5,
        0.5
      ],
      "country": "Russia",
      "city": "Saint Petersburg",
      "building_name": "BC of Bol'shaya Monetnaya",
      "street": "Bol'shaya Monetnaya street",
      "building": "23f1A",
      "porch": "A",
      "floor": 1,
      "flat": 1,
      "sfloor": "1",
      "sflat": "1",
      "door_code": "169",
      "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
      "doorbell_name": "Magidovich",
      "comment": "The intercom doesn't work",
      "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
      "description": "Saint Petersburg, Russia"
    },
    "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

Courier location for which the ETA was calculated

Min items: 2

Max items: 2

[
  52.569089,
  39.60258
]

fullname

Type: AddressFullname

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor.

Example: Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A

building

Type: string

Building

Example: 23f1A

building_name

Type: string

Apartment building name

Example: BC of Bol'shaya Monetnaya

city

Type: string

City

Example: Saint Petersburg

comment

Type: string

Comment for the courier.
For the dispatch point, use the template: "Delivery from store <>. Inform the manager that the order is for Yandex Delivery. Provide your order number <> and collect the parcel. The order was paid using cashless payment. So, there's no need to ask the recipient to pay for the delivery when handing over the order."
For delivery points, leave the recipient's wishes in the comments. For example, "the intercom doesn't work" / "the gate is closed, call 10 minutes in advance" / "don't call, the baby is asleep".

Max length: 7000

Example: The intercom doesn't work

coordinates

Type: number[]

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.
Rounded coordinate values are specified.

Min items: 2

Max items: 2

[
  0.5,
  0.5
]

country

Type: string

Country

Example: Russia

description

Type: string

A geographic area that turns a short address into a global match

Example: Saint Petersburg, Russia

door_code

Type: string

Intercom code

Example: 169

door_code_extra

Type: string

Additional instructions for intercoms

Example: courtyard entrance code #1234, apartment code #4321

doorbell_name

Type: string

Name on the doorbell

Example: Magidovich

porch

Type: string

Entrance (may be A)

Example: A

sflat

Type: string

Flat

Example: 1

sfloor

Type: string

Floor

Example: 1

shortname

Type: string

Short address within the city (like on a Taximeter)

Example: Bol'shaya Monetnaya Street, 1f1A

street

Type: string

Street

Example: Bol'shaya Monetnaya street

uri

Type: string

URI of the geo object on maps

Example: ymapsbm1://geo?ll=38.805%2C55.084

actual

Type: string<date-time>

Actual point visit time.
Filled in only for visited points.

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

expected

Type: string<date-time>

Estimated time of arrival. Can be filled in only for unvisited points.

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

expected_waiting_time_sec

Type: integer

Estimated waiting time at the point. (int64)

address

Type: CargoPointAddress

Point address

{
  "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
  "shortname": "Bol'shaya Monetnaya Street, 1f1A",
  "coordinates": [
    0.5,
    0.5
  ],
  "country": "Russia",
  "city": "Saint Petersburg",
  "building_name": "BC of Bol'shaya Monetnaya",
  "street": "Bol'shaya Monetnaya street",
  "building": "23f1A",
  "porch": "A",
  "floor": 1,
  "flat": 1,
  "sfloor": "1",
  "sflat": "1",
  "door_code": "169",
  "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
  "doorbell_name": "Magidovich",
  "comment": "The intercom doesn't work",
  "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
  "description": "Saint Petersburg, Russia"
}

id

Type: integer

Integer point ID (int64)

type

Type: PointType

Point type:

• source: the point of departure where the courier picks up the item
• destination: destination points where the courier delivers the items
• return: item return point (added automatically and matches the point of departure by default, but a different point can also be selected)

Enum: source, destination, return

visit_order

Type: integer

The order in which the points are visited (numbering starts with 1) (int64)

visit_status

Type: PointVisitStatus

Point visit status:

• pending — not yet visited.
• arrived — the courier arrived at the point.
• visited — the courier handed over/picked up the cargo at the point.
• skipped — skipped (if the item wasn't accepted).

Enum: pending, arrived, visited, skipped

visited_at

Type: PointVisitTime

Estimating the time of arrival

Information about the point visit time

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

code

Type: string

Error code

Const: not_found

Example: not_found

message

Type: string

Error description

Example: Claim not found

code

Type: string

Error code

Enum: inappropriate_status, no_performer_info, unknown_performer_position

message

Type: string

Error description

Example: Invalid action regarding the claim

code

Type: string

Error code

Const: too_many_requests

Example: too_many_requests

message

Type: string

Error description

Example: Too many requests