Courier's estimated time of arrival

Returns a list of points and estimated time of arrival of the courier at the point.

Request

POST

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

Service URL

Query parameters

Name

Description

claim_id*

Type: string

Claim ID received at the claim creation stage

Min length: 32

Max length: 64

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English
Example: en

Responses

200 OK

Estimating the courier's time of arrival at the points

Body

application/json

{
    "id": "741cedf82cd464fa6fa16d87155c636",
    "route_points": [
        {
            "id": 1,
            "address": {
                "fullname": "One Central Building 5, Trade Center Second, Dubai",
                "shortname": "One Central Building 5, Trade Center Second",
                "coordinates": [
                    0
                ],
                "country": "UAE",
                "city": "Dubai",
                "building_name": "Dubai",
                "street": "Trade Center Second",
                "building": "building number",
                "porch": "A",
                "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": "Yango Dubai Office, One Central Building 5, Trade Center Second, Dubai"
            },
            "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 Claim ID Example: `741cedf82cd464fa6fa16d87155c636` Min length: `32` Max length: `64`
route_points*	Type: PointWithEta[] Route points with an estimated time of arrival of the courier.
performer_position	Type: number[] Courier location for which the ETA was calculated Example: `52.569089,39.60258` Min items: `2` Max items: `2`

PointWithEta

Name	Description
address*	Type: CargoPointAddress Point address
id*	Type: integer<int64> Integer point ID (int64) Example: `1`
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) Example: `source` Enum: `source`, `destination`, `return`
visit_order*	Type: integer<int64> The order in which the points are visited (numbering starts with 1) (int64) Example: `1`
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). Example: `pending` Enum: `pending`, `arrived`, `visited`, `skipped`
visited_at*	Type: PointVisitTime Estimating the time of arrival

CargoPointAddress

Point address

Name	Description
fullname*	Type: string 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: `One Central Building 5, Trade Center Second, Dubai`
building	Type: string Building Example: `building number`
building_name	Type: string Apartment building name Example: `Dubai`
city	Type: string City Example: `Dubai`
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 Yango 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". Example: `The intercom doesn't work` Max length: `7000`
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`
country	Type: string Country Example: `UAE`
description	Type: string A geographic area that turns a short address into a global match Example: `Yango Dubai Office, One Central Building 5, Trade Center Second, Dubai`
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: `One Central Building 5, Trade Center Second`
street	Type: string Street Example: `Trade Center Second`
uri	Type: string URI of the geo object on maps Example: `ymapsbm1://geo?ll=38.805%2C55.084`

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)

Type

Description

PointType

Example: source

Enum: source, destination, return

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).

Type

Description

PointVisitStatus

Example: pending

Enum: pending, arrived, visited, skipped

PointVisitTime

Information about the point visit time

Name	Description
actual	Type: string<date-time> Actual point visit time. Filled in only for visited points.
expected	Type: string<date-time> Estimated time of arrival. Can be filled in only for unvisited points.
expected_waiting_time_sec	Type: integer<int64> Estimated waiting time at the point. (int64)

404 Not Found

Claim not found

Body

application/json

{
    "code": "not_found",
    "message": "Claim not found"
}

Name

Description

code*

Type: string

Error code

Example: not_found

Enum: not_found

message*

Type: string

Error description

Example: Claim not found

409 Conflict

Possible reasons for the error:
— Claim is inactive.
— There's no executor yet.
— Couldn't detect the courier's location.

Body

application/json

{
    "code": "inappropriate_status",
    "message": "Invalid action regarding the claim"
}

Name

Description

code*

Type: string

Error code

Example: inappropriate_status

Enum: inappropriate_status, no_performer_info, unknown_performer_position

message*

Type: string

Error description

Example: Invalid action regarding the claim

429 Too Many Requests

Too many requests

Body

application/json

{
    "code": "too_many_requests",
    "message": "Too many requests"
}

Name

Description

code*

Type: string

Error code

Example: too_many_requests

Enum: too_many_requests

message*

Type: string

Error description

Example: Too many requests

Was the article helpful?

2.2 Location

2.4 Tracking links