---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsPerformerPosition.md
  - https://yandex.com/support/delivery-profile/ru/api/express/openapi/IntegrationV2ClaimsPerformerPosition.md
  - href: en/api/express/openapi/IntegrationV2ClaimsPerformerPosition.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 location

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

The method returns the coordinates, speed, and movement directions of the claim's courier.

## Request

<div class="openapi__requests">

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

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/performer-position
```

</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}

## Responses

<div class="openapi__response__code__200">

## 200 OK

Information about the courier's location

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "position": {
    "lat": -90,
    "lon": -180,
    "timestamp": 0,
    "accuracy": 0.5,
    "speed": 0.5,
    "direction": 0.5
  },
  "route_points": [
    {
      "id": 1,
      "type": "source",
      "visit_order": 1,
      "sharing_link": "example"
    }
  ]
}
```

{% endcut %}

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

_position_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Type**: object" %}

#|
||

_lat_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

Latitude

_Min value:_{.json-schema-reset .json-schema-assertion} `-90`

_Max value:_{.json-schema-reset .json-schema-assertion} `90`
{.table-cell}
||
||

_lon_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

Longitude

_Min value:_{.json-schema-reset .json-schema-assertion} `-180`

_Max value:_{.json-schema-reset .json-schema-assertion} `180`
{.table-cell}
||
||

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

GPS signal detection time, unix-time
{.table-cell}
||
||

_accuracy_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

GPS accuracy. Can't be added at the moment because the issue of measurement units hasn't been solved yet.
{.table-cell}
||
||

_direction_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

Direction. The angle from 0 to 360 degrees from the north direction, clockwise. 0 — north, 90 — east, 180 — south, 270 — west.
{.table-cell}
||
||

_speed_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

Average speed, m/s
{.table-cell}
||
|#{.json-schema-properties}

{% endcut %}

Extended format of the courier's geolocation

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

```json translate=no
{
  "lat": -90,
  "lon": -180,
  "timestamp": 0,
  "accuracy": 0.5,
  "speed": 0.5,
  "direction": 0.5
}
```

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

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

Route points with tracking links

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

```json translate=no
[
  {
    "id": 1,
    "type": "source",
    "visit_order": 1,
    "sharing_link": "example"
  }
]
```

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

</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">

### PointWithSharingLink {#entity-PointWithSharingLink}

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

_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}
||
||

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

Route tracking link. Available only for destination points

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

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

```json translate=no
{
  "id": 1,
  "type": "source",
  "visit_order": 1,
  "sharing_link": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Executor or courier's location 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

Inactive claim or no information about the executor

<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} `unknown_performer_position`, `inappropriate_status`
{.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.