5.2. Get courier's point

  1. HTTP Request
  2. Query Parameters
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 404
      1. Representation
      2. Fields
    3. Code 409
      1. Representation
      2. Fields
    4. Code 429
      1. Representation
      2. Fields
  4. Example

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

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

Collapse all
Expand all

Fields

position *

object

Extended format of driver's geolocation

position.accuracy

number

GPS accuracy. Currently not allowed to be passed because no decision on
units of measurement has been taken yet.

position.direction

number

Direction. Angle from 0 degrees to 360 degrees from North direction,
clockwise. 0 - North, 90 - East, 180 - South,
270 - West.

position.lat *

number

Latitude

Minimum value: -90.
Maximum value: 90.

position.lon *

number

Longitude

Minimum value: -180.
Maximum value: 180.

position.speed

number

Average speed, in m/s

position.timestamp *

integer

GPS signal pickup time, unix-time (int64)

route_points[]

array

Route points with links to route tracking

route_points[].id *

integer

Integer ID of the point (int64)

route_points[].sharing_link

string

Link to track the route
Only available at 'destination' points

route_points[].type *

string

point type:

  • source: the pickup point where the courier picks up the items - destination: the destination point where the courier delivers the items - return: the point where the items are returned (added automatically and by default is the same as the pickup point, but another point can be defined too)
Allowed values
  1. source
  2. destination
  3. return

route_points[].visit_order *

integer

Order of visiting the point (int64)

position *

object

Extended format of driver's geolocation

position.accuracy

number

GPS accuracy. Currently not allowed to be passed because no decision on
units of measurement has been taken yet.

position.direction

number

Direction. Angle from 0 degrees to 360 degrees from North direction,
clockwise. 0 - North, 90 - East, 180 - South,
270 - West.

position.lat *

number

Latitude

Minimum value: -90.
Maximum value: 90.

position.lon *

number

Longitude

Minimum value: -180.
Maximum value: 180.

position.speed

number

Average speed, in m/s

position.timestamp *

integer

GPS signal pickup time, unix-time (int64)

route_points[]

array

Route points with links to route tracking

route_points[].id *

integer

Integer ID of the point (int64)

route_points[].sharing_link

string

Link to track the route
Only available at 'destination' points

route_points[].type *

string

point type:

  • source: the pickup point where the courier picks up the items - destination: the destination point where the courier delivers the items - return: the point where the items are returned (added automatically and by default is the same as the pickup point, but another point can be defined too)
Allowed values
  1. source
  2. destination
  3. return

route_points[].visit_order *

integer

Order of visiting the point (int64)

Code 404

Performer's or contractor's position not found

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

Code 409

The claim is inactive or there is no information about the performer

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. unknown_performer_position
  2. inappropriate_status

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. unknown_performer_position
  2. inappropriate_status

message *

string

Human-readable error message

Code 429

Too many requests

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. too_many_requests

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. too_many_requests

message *

string

Human-readable error message

Example

Responses:

{
  "route_points": [
    {
      "id": 1,
      "type": "source",
      "visit_order": 1
    }
  ]
}
Copied to clipboard