---
metadata:
  - name: generator
    content: Diplodoc Platform v5.55.3
alternate:
  - https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsPointsEta.md
  - https://yandex.com/support/delivery-profile/ru/api/express/openapi/IntegrationV2ClaimsPointsEta.md
  - href: en/api/express/openapi/IntegrationV2ClaimsPointsEta.md
    type: text/markdown
    title: Markdown version
  - href: ../../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/delivery-profile/en/llms.txt

<div class="openapi">

# Courier's estimated time of arrival

<!-- markdownlint-disable-file -->

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

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/points-eta
```

</div>

Service URL

</div>

</div>

### Query parameters

#|
|| **Name** | **Description** ||
||

_claim_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Claim ID received at the claim creation stage

_Min length:_{.json-schema-reset .json-schema-assertion} `32`

_Max length:_{.json-schema-reset .json-schema-assertion} `64`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Headers

#|
|| **Name** | **Description** ||
||

_Accept-Language_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Preferred response language. Examples: "en" — English

_Example:_{.json-schema-reset .json-schema-example} `en`
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

Estimating the courier's time of arrival at the points

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "id": "741cedf82cd464fa6fa16d87155c636",
  "route_points": [
    {
      "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",
        "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": [
    52.569089,
    39.60258
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ClaimId](#entity-ClaimId)

Claim ID

Claim ID obtained at the claim creation stage

_Min length:_{.json-schema-reset .json-schema-assertion} `32`

_Max length:_{.json-schema-reset .json-schema-assertion} `64`

_Example:_{.json-schema-reset .json-schema-example} `741cedf82cd464fa6fa16d87155c636`
{.table-cell}
||
||

_route_points_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PointWithEta](#entity-PointWithEta)[]

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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",
      "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"
    }
  }
]
```

{% endcut %}
{.table-cell}
||
||

_performer_position_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PointsEtaPerformerPosition](#entity-PointsEtaPerformerPosition)

Courier location for which the ETA was calculated

_Min items:_{.json-schema-reset .json-schema-assertion} `2`

_Max items:_{.json-schema-reset .json-schema-assertion} `2`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  52.569089,
  39.60258
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ClaimId {#entity-ClaimId}

Claim ID obtained at the claim creation stage

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `32`

_Max length:_{.json-schema-reset .json-schema-assertion} `64`

_Example:_{.json-schema-reset .json-schema-example} `741cedf82cd464fa6fa16d87155c636`

</div>

<div class="openapi-entity">

### AddressFullname {#entity-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. 


**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A`

</div>

<div class="openapi-entity">

### CargoPointAddress {#entity-CargoPointAddress}

Point address

#|
|| **Name** | **Description** ||
||

_fullname_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [AddressFullname](#entity-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:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A`
{.table-cell}
||
||

_building_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Building

_Example:_{.json-schema-reset .json-schema-example} `23f1A`
{.table-cell}
||
||

_building_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Apartment building name

_Example:_{.json-schema-reset .json-schema-example} `BC of Bol'shaya Monetnaya`
{.table-cell}
||
||

_city_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

City

_Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg`
{.table-cell}
||
||

_comment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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:_{.json-schema-reset .json-schema-assertion} `7000`

_Example:_{.json-schema-reset .json-schema-example} `The intercom doesn't work`
{.table-cell}
||
||

_coordinates_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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:_{.json-schema-reset .json-schema-assertion} `2`

_Max items:_{.json-schema-reset .json-schema-assertion} `2`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0.5,
  0.5
]
```

{% endcut %}
{.table-cell}
||
||

_country_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Country

_Example:_{.json-schema-reset .json-schema-example} `Russia`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Russia`
{.table-cell}
||
||

_door_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Intercom code

_Example:_{.json-schema-reset .json-schema-example} `169`
{.table-cell}
||
||

_door_code_extra_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Additional instructions for intercoms

_Example:_{.json-schema-reset .json-schema-example} `courtyard entrance code #1234, apartment code #4321`
{.table-cell}
||
||

_doorbell_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Name on the doorbell

_Example:_{.json-schema-reset .json-schema-example} `Magidovich`
{.table-cell}
||
||

_porch_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Entrance (may be A)

_Example:_{.json-schema-reset .json-schema-example} `A`
{.table-cell}
||
||

_sflat_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Flat

_Example:_{.json-schema-reset .json-schema-example} `1`
{.table-cell}
||
||

_sfloor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Floor

_Example:_{.json-schema-reset .json-schema-example} `1`
{.table-cell}
||
||

_shortname_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Short address within the city (like on a Taximeter)

_Example:_{.json-schema-reset .json-schema-example} `Bol'shaya Monetnaya Street, 1f1A`
{.table-cell}
||
||

_street_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Street

_Example:_{.json-schema-reset .json-schema-example} `Bol'shaya Monetnaya street`
{.table-cell}
||
||

_uri_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

URI of the geo object on maps

_Example:_{.json-schema-reset .json-schema-example} `ymapsbm1://geo?ll=38.805%2C55.084`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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",
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PointType {#entity-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**: string

_Enum:_{.json-schema-reset .json-schema-value} `source`, `destination`, `return`

</div>

<div class="openapi-entity">

### PointVisitStatus {#entity-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**: string

_Enum:_{.json-schema-reset .json-schema-value} `pending`, `arrived`, `visited`, `skipped`

</div>

<div class="openapi-entity">

### PointVisitTime {#entity-PointVisitTime}

Information about the point visit time

#|
|| **Name** | **Description** ||
||

_actual_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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


_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_expected_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_expected_waiting_time_sec_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Estimated waiting time at the point. (int64)
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "expected": "2025-01-01T00:00:00Z",
  "expected_waiting_time_sec": 0,
  "actual": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PointWithEta {#entity-PointWithEta}

#|
|| **Name** | **Description** ||
||

_address_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [CargoPointAddress](#entity-CargoPointAddress)

Point address

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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",
  "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"
}
```

{% endcut %}
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Integer point ID (int64)
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PointType](#entity-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:_{.json-schema-reset .json-schema-value} `source`, `destination`, `return`
{.table-cell}
||
||

_visit_order_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

The order in which the points are visited (numbering starts with 1) (int64)
{.table-cell}
||
||

_visit_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PointVisitStatus](#entity-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:_{.json-schema-reset .json-schema-value} `pending`, `arrived`, `visited`, `skipped`
{.table-cell}
||
||

_visited_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PointVisitTime](#entity-PointVisitTime)

Estimating the time of arrival

Information about the point visit time

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "expected": "2025-01-01T00:00:00Z",
  "expected_waiting_time_sec": 0,
  "actual": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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",
    "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"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PointsEtaPerformerPosition {#entity-PointsEtaPerformerPosition}

**Type**: number[]

_Min items:_{.json-schema-reset .json-schema-assertion} `2`

_Max items:_{.json-schema-reset .json-schema-assertion} `2`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  52.569089,
  39.60258
]
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Claim not found

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "not_found",
  "message": "Claim not found"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Const:_{.json-schema-reset .json-schema-value} `not_found`

_Example:_{.json-schema-reset .json-schema-example} `not_found`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error description

_Example:_{.json-schema-reset .json-schema-example} `Claim not found`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__409">

## 409 Conflict

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


<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "inappropriate_status",
  "message": "Invalid action regarding the claim"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Enum:_{.json-schema-reset .json-schema-value} `inappropriate_status`, `no_performer_info`, `unknown_performer_position`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error description

_Example:_{.json-schema-reset .json-schema-example} `Invalid action regarding the claim`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__429">

## 429 Too Many Requests

Too many requests

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "too_many_requests",
  "message": "Too many requests"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Const:_{.json-schema-reset .json-schema-value} `too_many_requests`

_Example:_{.json-schema-reset .json-schema-example} `too_many_requests`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error description

_Example:_{.json-schema-reset .json-schema-example} `Too many requests`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.