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.
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
POST
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/return
Service URL
Query parameters
|
Name |
Description |
|
claim_id |
Type: string Claim ID received at the claim creation stage Min length: Max length: Example: `` |
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Preferred response language. Examples: "en" — English Example: |
Body
application/json
{
"point_id": 372036854775807,
"comment": "The consumer rejected the order",
"need_return_items": true
}
|
Name |
Description |
|
comment |
Type: string The reason why the point needs to be skipped Max length: Example: |
|
point_id |
Type: ClaimPointId ID of the point that needs to be skipped Integer point ID (int64) generated on the Yandex Delivery side. Example: |
|
need_return_items |
Type: boolean Return the item to the initial point of dispatch |
ClaimPointId
Integer point ID (int64) generated on the Yandex Delivery side.
It is in the route_points[].id field. Applicable to source, destination, and return points.
Type: integer
Responses
200 OK
Return initiated
400 Bad Request
Incorrect point
Body
application/json
{
"code": "state_mismatch",
"message": "Invalid action regarding the claim"
}
|
Name |
Description |
|
code |
Type: string Error code Const: Example: |
|
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 Const: Example: |
|
message |
Type: string Error description Example: |
409 Conflict
We haven't found a courier yet. You can cancel the request
Body
application/json
{
"code": "state_mismatch",
"message": "Invalid action regarding the claim"
}
|
Name |
Description |
|
code |
Type: string Error code Enum: |
|
message |
Type: string Error description Example: |
410 Gone
Inactive claim
Body
application/json
{
"code": "inappropriate_status",
"message": "Invalid action regarding the claim"
}
|
Name |
Description |
|
code |
Type: string Error code Const: Example: |
|
message |
Type: string Error description Example: |
No longer supported, please use an alternative and newer version.