Check the possibility of delivery by rover along the specified route

Check the possibility of delivery by rover along the specified route

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/robot/available

Service URL

Body

application/json
{
  "route_points": [
    {
      "coordinates": [
        0.5,
        0.5
      ],
      "type": "source"
    }
  ]
}

Name

Description

route_points

Type: object[]

coordinates

Type: number[]

An array of two real numbers: longitude, latitude — exactly in that order.

Min items: 2

Max items: 2

Example
[
  0.5,
  0.5
]

type

Type: 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: source, destination, return

List of points of the proposed route

Max items: 100

Example
[
  {
    "coordinates": [
      0.5,
      0.5
    ],
    "type": "source"
  }
]

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: source, destination, return

Responses

200 OK

Availability status

Body

application/json
{
  "available": true
}

Name

Description

available

Type: boolean

'true' — delivery by rover is available 'false' — delivery by rover isn't available