9.1 Request to check the possibility of delivery by a rover

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/robot/check-availability

Header Parameters

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

* Required parameter

Request Body

{
  "route_points": [
    {
      "coordinates": [
        "number"
      ],
      "type": string
    }
  ]
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

route_points[] *	array List of proposed route points
route_points[].coordinates[] *	array Array of two real numbers [longitude, latitude]. The order is important!
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 source destination return

* Required parameter

Responses

Code 200

The task to open the cover is accepted for processing

{
  "available": boolean
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

available *

boolean

'true': Delivery by a rover is possible
'false': Delivery by a rover isn't possible

* Required parameter

Example

Request:

curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/robot/check-availability" \
-H "Accept-Language: {string}" \
-d '{
  "route_points": [
    {
      "type": "source"
    }
  ]
}'
Copied to clipboard