Confirm claim

The method confirms if the claim was successfully evaluated. After the claim is confirmed, its status changes to accepted, and the service starts the process of searching for an executor.

The pricing.offer is valid for a limited period of time (10 minutes).
After it expires, the order status changes to failed if an attempt is made to confirm the order.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/accept

Service URL

Query parameters

Name

Description

claim_id*

Type: string

Claim ID received at the claim creation stage

Min length: 32

Max length: 64

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Body

application/json

{
    "version": 1
}

Name

Description

version*

Type: integer<int64>

Claim version. Changed after the claim was edited (int64)

Example: 1

Responses

200 OK

Claim confirmed

Body

application/json

{
    "id": "741cedf82cd464fa6fa16d87155c636",
    "status": "new",
    "version": 1,
    "user_request_revision": "string",
    "skip_client_notify": false
}

Name	Description
id*	Type: string Claim ID obtained at the claim creation stage Example: `741cedf82cd464fa6fa16d87155c636` Min length: `32` Max length: `64`
skip_client_notify*	Type: boolean
status*	Type: ClaimStatus Claim status. To learn more, see Status model Example: `new` Enum: `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*	Type: string The current version of changes in the claim entered by the user
version*	Type: integer<int64> Claim version from the request (int64) Example: `1`

ClaimStatus

Claim status. To learn more, see Status model

Type

Description

ClaimStatus

Example: new

Enum: 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

404 Not Found

Claim not found

Body

application/json

{
    "code": "not_found",
    "message": "Claim not found"
}

Name

Description

code*

Type: string

Error code

Example: not_found

Enum: not_found

message*

Type: string

Error description

Example: Claim not found

409 Conflict

Attempting to confirm the claim that wasn't evaluated

Body

application/json

{
    "code": "inappropriate_status",
    "message": "Invalid action regarding the claim"
}

Name

Description

code*

Type: string

Error code

Example: inappropriate_status

Enum: inappropriate_status, old_version, offer_expired, state_mismatch

message*

Type: string

Error description

Example: Invalid action regarding the claim

429 Too Many Requests

Too many requests

Body

application/json

{
    "code": "too_many_requests",
    "message": "Too many requests"
}

Name

Description

code*

Type: string

Error code

Example: too_many_requests

Enum: too_many_requests

message*

Type: string

Error description

Example: Too many requests

Confirm claim

Request

Query parameters

Headers

Body

Responses

200 OK

Body

ClaimStatus

404 Not Found

Body

409 Conflict

Body

429 Too Many Requests

Body

Was the article helpful?