5.2. Get courier's point
Returns the coordinates, speed, and direction of the claim performer.
HTTP Request
GET b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/performer-position\
?claim_id={string}
Query Parameters
claim_id * | string Claim ID, received upon creation of claim |
claim_id * | string Claim ID, received upon creation of claim |
* Required parameter
Responses
Code 200
Information about performer's position
{ "position": { "accuracy": number, "direction": number, "lat": number, "lon": number, "speed": number, "timestamp": integer }, "route_points": [ { "id": integer, "sharing_link": string, "type": string, "visit_order": integer } ] }
Copied to clipboard
Representation
Fields
position * | object Extended format of driver's geolocation |
position. | number GPS accuracy. Currently not allowed to be passed because no decision on |
position. | number Direction. Angle from 0 degrees to 360 degrees from North direction, |
position. | number Latitude Minimum value: |
position. | number Longitude Minimum value: |
position. | number Average speed, in m/s |
position. | integer GPS signal pickup time, unix-time (int64) |
route_points[] | array Route points with links to route tracking |
route_points[]. | integer Integer ID of the point (int64) |
route_points[]. | string Link to track the route |
route_points[]. | string point type:
|
route_points[]. | integer Order of visiting the point (int64) |
position * | object Extended format of driver's geolocation |
position. | number GPS accuracy. Currently not allowed to be passed because no decision on |
position. | number Direction. Angle from 0 degrees to 360 degrees from North direction, |
position. | number Latitude Minimum value: |
position. | number Longitude Minimum value: |
position. | number Average speed, in m/s |
position. | integer GPS signal pickup time, unix-time (int64) |
route_points[] | array Route points with links to route tracking |
route_points[]. | integer Integer ID of the point (int64) |
route_points[]. | string Link to track the route |
route_points[]. | string point type:
|
route_points[]. | integer Order of visiting the point (int64) |
* Required parameter
Code 404
Performer's or contractor's position not found
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 409
The claim is inactive or there is no information about the performer
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 429
Too many requests
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Example
Responses:
{ "route_points": [ { "id": 1, "type": "source", "visit_order": 1 } ] }
Copied to clipboard
{ "code": "not_found", "message": "Claim not found" }
Copied to clipboard
{ "code": "inappropriate_status", "message": "Invalid action on the claim" }
Copied to clipboard
{ "code": "too_many_requests", "message": "Too many requests" }
Copied to clipboard