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

<div class="openapi">

# Skip a point in the multi-point claim

The method initiates the return of the order by the courier to the initial point of dispatch. The operation can be performed only if the courier has already picked up the order.
<br>
If there are multiple destination points on the route, the point specified in the request will be skipped, and the courier will return the item back to the dispatcher after completing the route.


## 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/return
```



</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}

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "point_id": 372036854775807,
    "comment": "The consumer rejected the order",
    "need_return_items": false
}
```


{% endcut %}


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

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

The reason why the point needs to be skipped

*Example:*{.openapi-description-annotation} `The consumer rejected the order`

*Max length:*{.openapi-description-annotation} `1000`
 
||

||
 point_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

Integer point ID (int64) generated on the Yango Delivery side.
It is in the route_points[].id field. Applicable to source, destination, and return points.

*Example:*{.openapi-description-annotation} `372036854775807`
 
||

||
 need_return_items {.openapi-table-parameter-name} 
|
 **Type:** boolean

Return the item to the initial point of dispatch 
|||#{.openapi-table}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

Return initiated

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Incorrect point

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "state_mismatch",
    "message": "Invalid action regarding the claim"
}
```


{% endcut %}


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

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

Error code

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

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

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

Error description

*Example:*{.openapi-description-annotation} `Invalid action regarding the claim`
 
|||#{.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>

<div class="openapi__response__code__409">

## 409 Conflict

We haven't found a courier yet. You can cancel the request

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "state_mismatch",
    "message": "Invalid action regarding the claim"
}
```


{% endcut %}


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

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

Error code

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

*Enum:*{.openapi-description-annotation} `not_allowed`, `state_transition_forbidden`, `state_mismatch`
 
||

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

Error description

*Example:*{.openapi-description-annotation} `Invalid action regarding the claim`
 
|||#{.openapi-table}

</div>

</div>

<div class="openapi__response__code__410">

## 410 Gone

Inactive claim

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "inappropriate_status",
    "message": "Invalid action regarding the claim"
}
```


{% endcut %}


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

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

Error code

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

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

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

Error description

*Example:*{.openapi-description-annotation} `Invalid action regarding the claim`
 
|||#{.openapi-table}

</div>

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

</div>



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