4.1. Get cancellation identifier

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

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

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

Responses

Code 200

OK

{
  "cancel_state": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

cancel_state *

string

Allowed values
  1. free
  2. paid
  3. unavailable

cancel_state *

string

Allowed values
  1. free
  2. paid
  3. unavailable

Code 400

Invalid request

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

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. bad_request

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. bad_request

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

Example

Responses:

{
  "cancel_state": "free"
}
Copied to clipboard