4.1. Get cancellation identifier
Returns information on whether cancellation is possible. You can use the operation to get information about a claim created via v1/claims/create.
HTTP Request
POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/cancel-info\
?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
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 |
* Required parameter
Responses
Code 200
OK
{ "cancel_state": string }
Copied to clipboard
Representation
Fields
cancel_state * | string Allowed values
|
cancel_state * | string Allowed values
|
* Required parameter
Code 400
Invalid request
{ "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 404
Claim 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
Example
Responses:
{ "cancel_state": "free" }
Copied to clipboard
{ "code": "bad_request", "message": "Invalid request body" }
Copied to clipboard
{ "code": "not_found", "message": "Claim not found" }
Copied to clipboard