Terms of cancellation
The method returns information about the possibility of cancellation.
Use this method to get information on the claim created via claims/create.
Request
POST
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/cancel-info
Service URL
Query parameters
|
Name |
Description |
|
claim_id* |
Type: string Claim ID received at the claim creation stage Min length: Max length: |
Headers
|
Name |
Description |
|
Accept-Language* |
Type: string Preferred response language. Examples: "en" — English |
Responses
200 OK
OK
Body
application/json
{
"cancel_state": "free",
"price": "12.50",
"price_with_vat": "12.50",
"currency": "string"
}
|
Name |
Description |
|
cancel_state* |
Type: CancelInfoCancelState Terms of cancellation Example: Enum: |
|
currency |
Type: string Payment currency |
|
price |
Type: string Delivery cost in Decimal(18, 4) format Example: Pattern: |
|
price_with_vat |
Type: string Delivery cost in Decimal(18, 4) format Example: Pattern: |
CancelInfoCancelState
Terms of cancellation
|
Type |
Description |
|
Example: Enum: |
400 Bad Request
Bad request
Body
application/json
{
"code": "bad_request",
"message": "Incorrect request body"
}
|
Name |
Description |
|
code* |
Type: string Error code Example: Enum: |
|
message* |
Type: string Error description Example: |
404 Not Found
Claim not found
Body
application/json
{
"code": "not_found",
"message": "Claim not found"
}
|
Name |
Description |
|
code* |
Type: string Error code Example: Enum: |
|
message* |
Type: string Error description Example: |