9.2 Request to open the rover cover

  1. HTTP Request
  2. Query Parameters
  3. Header Parameters
  4. Request Body
    1. Representation
    2. Fields
  5. Responses
    1. Code 200
    2. Code 400
      1. Representation
      2. Fields
    3. Code 404
      1. Representation
      2. Fields
    4. Code 409
      1. Representation
      2. Fields
  6. Example

If the claim is delivered by a rover (robot),
you can use this method to open the cover of the robot to
load/receive the order.

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/robot/open-request\
?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

Header Parameters

Accept-Language *

string

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

Accept-Language *

string

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

Request Body

{
  "delay": integer,
  "point_id": integer
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

delay *

integer

Open the cover after how many seconds (int64)

point_id *

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

delay *

integer

Open the cover after how many seconds (int64)

point_id *

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

Responses

Code 200

The task to open the cover is accepted for processing

Code 400

The order isn't delivered by a rover

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

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_allowed

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_allowed

message *

string

Human-readable error message

Code 404

Claim 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 has a wrong status or the point is no longer relevant

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

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. no_performer_info
  2. inappropriate_point
  3. state_mismatch

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. no_performer_info
  2. inappropriate_point
  3. state_mismatch

message *

string

Human-readable error message

Example

Request:

curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/robot/open-request?claim_id={string}" \
-H "Accept-Language: {string}" \
-d '{
  "point_id": 6987
}'
Copied to clipboard