Courier's location
The method returns the coordinates, speed, and movement directions of the claim's courier.
Request
GET
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/performer-position
Service URL
Query parameters
|
Name |
Description |
|
claim_id* |
Type: string Claim ID received at the claim creation stage Min length: Max length: |
Responses
200 OK
Information about the courier's location
Body
application/json
{
"position": {
"lat": 0,
"lon": 0,
"timestamp": 0,
"accuracy": 0,
"speed": 0,
"direction": 0
},
"route_points": [
{
"id": 1,
"type": "source",
"visit_order": 1,
"sharing_link": "string"
}
]
}
|
Name |
Description |
|
position* |
Type: object Extended format of the courier's geolocation |
|
route_points |
Type: PointWithSharingLink[] Route points with tracking links |
PointWithSharingLink
|
Name |
Description |
|
id* |
Type: integer<int64> Integer point ID (int64) Example: |
|
type* |
Type: PointType Point type:
Example: Enum: |
|
visit_order* |
Type: integer<int64> The order in which the points are visited (numbering starts with 1) (int64) Example: |
|
sharing_link |
Type: string Route tracking link. Available |
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 |
|
Example: Enum: |
404 Not Found
Executor or courier's location not found
Body
application/json
{
"code": "not_found",
"message": "Claim not found"
}
|
Name |
Description |
|
code* |
Type: string Error code Example: Enum: |
|
message* |
Type: string Error description Example: |
409 Conflict
Inactive claim or no information about the executor
Body
application/json
{
"code": "inappropriate_status",
"message": "Invalid action regarding the claim"
}
|
Name |
Description |
|
code* |
Type: string Error code Example: Enum: |
|
message* |
Type: string Error description Example: |
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: Enum: |
|
message* |
Type: string Error description Example: |