---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsCancelInfo.md
  - https://yandex.com/support/delivery-profile/ru/api/express/openapi/IntegrationV2ClaimsCancelInfo.md
  - href: en/api/express/openapi/IntegrationV2ClaimsCancelInfo.md
    type: text/markdown
    title: Markdown version
  - href: ../../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/delivery-profile/en/llms.txt

<div class="openapi">

# Terms of cancellation

<!-- markdownlint-disable-file -->

The method returns information about the possibility of cancellation.
Use this method to get information on the claim created via [claims/create](https://yandex.com/support/delivery-profile/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.taxi.yandex.net/b2b/cargo/integration/v2/claims/cancel-info
```

</div>

Service URL

</div>

</div>

### Query parameters

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

_claim_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Claim ID received at the claim creation stage

_Min length:_{.json-schema-reset .json-schema-assertion} `32`

_Max length:_{.json-schema-reset .json-schema-assertion} `64`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Headers

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

_Accept-Language_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Preferred response language. Examples: "en" — English

_Example:_{.json-schema-reset .json-schema-example} `en`
{.table-cell}
||
|#{.json-schema-properties}

## 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": null,
  "currency": "example"
}
```

{% endcut %}

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

_cancel_state_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [CancelInfoCancelState](#entity-CancelInfoCancelState)

Terms of cancellation

_Enum:_{.json-schema-reset .json-schema-value} `free`, `paid`, `unavailable`
{.table-cell}
||
||

_currency_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Payment currency

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Money](#entity-Money)

Delivery cost in Decimal(18, 4) format

_Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`

_Example:_{.json-schema-reset .json-schema-example} `12.50`
{.table-cell}
||
||

_price_with_vat_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Money](#entity-Money)

Delivery cost in Decimal(18, 4) format

_Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`

_Example:_{.json-schema-reset .json-schema-example} `12.50`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### CancelInfoCancelState {#entity-CancelInfoCancelState}

Terms of cancellation

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `free`, `paid`, `unavailable`

</div>

<div class="openapi-entity">

### Money {#entity-Money}

Delivery cost in Decimal(18, 4) format

**Type**: string

_Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`

_Example:_{.json-schema-reset .json-schema-example} `12.50`

</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_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Const:_{.json-schema-reset .json-schema-value} `bad_request`

_Example:_{.json-schema-reset .json-schema-example} `bad_request`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error description

_Example:_{.json-schema-reset .json-schema-example} `Incorrect request body`
{.table-cell}
||
|#{.json-schema-properties}

</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_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Const:_{.json-schema-reset .json-schema-value} `not_found`

_Example:_{.json-schema-reset .json-schema-example} `not_found`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error description

_Example:_{.json-schema-reset .json-schema-example} `Claim not found`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

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