---
metadata:
  - name: generator
    content: Diplodoc Platform v5.15.5
alternate:
  - https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsCancelInfo.md
---
> **Documentation Index:** Fetch the complete configuration index at https://delivery.yango.com/docs/en/llms.txt

<div class="openapi">

# 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](https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsCreate.md).


## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method} 
```text translate=no
b2b.delivery.yango.tech/b2b/cargo/integration/v2/claims/cancel-info
```



</div>

Service URL

</div>

</div>

### Query parameters

#|||
 **Name** 
|
 **Description** 
||

||
 claim_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Claim ID received at the claim creation stage<br>

*Min length:*{.openapi-description-annotation} `32`

*Max length:*{.openapi-description-annotation} `64`
 
|||#{.openapi-table}

### Headers

#|||
 **Name** 
|
 **Description** 
||

||
 Accept-Language<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Preferred response language. Examples: "en" — English<br>Example: `en` 
|||#{.openapi-table}

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "cancel_state": "free",
    "price": "12.50",
    "price_with_vat": "12.50",
    "currency": "string"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 cancel_state<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [CancelInfoCancelState](#cancelinfocancelstate)

Terms of cancellation

*Example:*{.openapi-description-annotation} `free`

*Enum:*{.openapi-description-annotation} `free`, `paid`, `unavailable`
 
||

||
 currency {.openapi-table-parameter-name} 
|
 **Type:** string

Payment currency 
||

||
 price {.openapi-table-parameter-name} 
|
 **Type:** string

Delivery cost in Decimal(18, 4) format

*Example:*{.openapi-description-annotation} `12.50`

*Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`
 
||

||
 price_with_vat {.openapi-table-parameter-name} 
|
 **Type:** string

Delivery cost in Decimal(18, 4) format

*Example:*{.openapi-description-annotation} `12.50`

*Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### CancelInfoCancelState

Terms of cancellation

#|||
 **Type** 
|
 **Description** 
||

||
 [CancelInfoCancelState](#cancelinfocancelstate) 
|
 

*Example:*{.openapi-description-annotation} `free`

*Enum:*{.openapi-description-annotation} `free`, `paid`, `unavailable`
 
|||#{.openapi-table}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad request

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "bad_request",
    "message": "Incorrect request body"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `bad_request`

*Enum:*{.openapi-description-annotation} `bad_request`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error description

*Example:*{.openapi-description-annotation} `Incorrect request body`
 
|||#{.openapi-table}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Claim not found

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "not_found",
    "message": "Claim not found"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `not_found`

*Enum:*{.openapi-description-annotation} `not_found`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error description

*Example:*{.openapi-description-annotation} `Claim not found`
 
|||#{.openapi-table}

</div>

</div>
<!-- markdownlint-disable-file -->

</div>



[*Deprecated]: No longer supported, please use an alternative and newer version.