# Cancel the claim The method cancels the confirmed claim. You can cancel the claim using this method before the item is handed over to the courier. After that, you can cancel the order only by contacting the support service.
Claim cancellation can be paid or free. Free cancellation is available before the courier arrives at the departure point and paid cancellation is available before the courier starts moving to the pick-up point. To determine the type of cancellation, use the operation for getting information about the claim [claims/cancel-info](https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsCancelInfo.md) (field ''cancel_state'').
In the case of free cancellation, the claim status changes to cancelled. In case of paid cancellation, its status changes to cancelled_with_payment. ## Request

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

Service URL

### Query parameters #||| **Name** | **Description** || || claim_id* {.openapi-table-parameter-name} | **Type:** string Claim ID received at the claim creation stage
*Min length:*{.openapi-description-annotation} `32` *Max length:*{.openapi-description-annotation} `64` |||#{.openapi-table} ### Headers #||| **Name** | **Description** || || Accept-Language* {.openapi-table-parameter-name} | **Type:** string Preferred response language. Examples: "en" — English
Example: `en` |||#{.openapi-table}

### Body {% cut "application/json" %} ```json translate=no { "version": 1, "cancel_state": "free" } ``` {% endcut %} #||| **Name** | **Description** || || cancel_state* {.openapi-table-parameter-name} | **Type:** [CancelState](#cancelstate) Cancellation status (paid or free) *Example:*{.openapi-description-annotation} `free` *Enum:*{.openapi-description-annotation} `free`, `paid` || || version* {.openapi-table-parameter-name} | **Type:** integer<int64> Canceled claim version (int64) *Example:*{.openapi-description-annotation} `1` |||#{.openapi-table}

### CancelState Cancellation status (paid or free) #||| **Type** | **Description** || || [CancelState](#cancelstate) | *Example:*{.openapi-description-annotation} `free` *Enum:*{.openapi-description-annotation} `free`, `paid` |||#{.openapi-table}

## Responses

## 200 OK Claim canceled

### Body {% cut "application/json" %} ```json translate=no { "id": "741cedf82cd464fa6fa16d87155c636", "status": "new", "version": 1, "user_request_revision": "string", "skip_client_notify": false } ``` {% endcut %} #||| **Name** | **Description** || || id* {.openapi-table-parameter-name} | **Type:** string Claim ID obtained at the claim creation stage *Example:*{.openapi-description-annotation} `741cedf82cd464fa6fa16d87155c636` *Min length:*{.openapi-description-annotation} `32` *Max length:*{.openapi-description-annotation} `64` || || skip_client_notify* {.openapi-table-parameter-name} | **Type:** boolean || || status* {.openapi-table-parameter-name} | **Type:** [ClaimStatus](#claimstatus) Claim status. To learn more, see [Status model](https://delivery.yango.com/docs/en/api/express/claim-process.md) *Example:*{.openapi-description-annotation} `new` *Enum:*{.openapi-description-annotation} `new`, `estimating`, `estimating_failed`, `ready_for_approval`, `accepted`, `performer_lookup`, `performer_draft`, `performer_found`, `performer_not_found`, `pickup_arrived`, `ready_for_pickup_confirmation`, `pickuped`, `delivery_arrived`, `ready_for_delivery_confirmation`, `delivered`, `delivered_finish`, `returning`, `return_arrived`, `ready_for_return_confirmation`, `returned`, `returned_finish`, `failed`, `cancelled`, `cancelled_with_payment`, `cancelled_by_taxi`, `cancelled_with_items_on_hands` || || user_request_revision* {.openapi-table-parameter-name} | **Type:** string The current version of changes in the claim entered by the user || || version* {.openapi-table-parameter-name} | **Type:** integer<int64> Claim version from the request (int64) *Example:*{.openapi-description-annotation} `1` |||#{.openapi-table}

### ClaimStatus Claim status. To learn more, see [Status model](https://delivery.yango.com/docs/en/api/express/claim-process.md) #||| **Type** | **Description** || || [ClaimStatus](#claimstatus) | *Example:*{.openapi-description-annotation} `new` *Enum:*{.openapi-description-annotation} `new`, `estimating`, `estimating_failed`, `ready_for_approval`, `accepted`, `performer_lookup`, `performer_draft`, `performer_found`, `performer_not_found`, `pickup_arrived`, `ready_for_pickup_confirmation`, `pickuped`, `delivery_arrived`, `ready_for_delivery_confirmation`, `delivered`, `delivered_finish`, `returning`, `return_arrived`, `ready_for_return_confirmation`, `returned`, `returned_finish`, `failed`, `cancelled`, `cancelled_with_payment`, `cancelled_by_taxi`, `cancelled_with_items_on_hands` |||#{.openapi-table}

## 400 Bad Request Bad request

### Body {% cut "application/json" %} ```json translate=no { "code": "bad_request", "message": "Incorrect request body" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `bad_request` *Enum:*{.openapi-description-annotation} `bad_request` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Incorrect request body` |||#{.openapi-table}

## 404 Not Found Claim not found

### Body {% cut "application/json" %} ```json translate=no { "code": "not_found", "message": "Claim not found" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `not_found` *Enum:*{.openapi-description-annotation} `not_found` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Claim not found` |||#{.openapi-table}

## 409 Conflict Attempting to cancel the invalid claim version

### Body {% cut "application/json" %} ```json translate=no { "code": "inappropriate_status", "message": "Invalid action regarding the claim" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `inappropriate_status` *Enum:*{.openapi-description-annotation} `inappropriate_status`, `free_cancel_is_unavailable`, `state_mismatch` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Invalid action regarding the claim` |||#{.openapi-table}