Get the editing result after confirmation

The method returns a response about the status of changes requested via the method claims/apply-changes/request.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/apply-changes/result

Service URL

Query parameters

Name

Description

claim_id*

Type: string

Claim ID received at the claim creation stage

Min length: 32

Max length: 64

request_id*

Type: string

Unique edit request ID (idempotency token)

Min length: 1

Max length: 63

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Responses

200 OK

Body

application/json

{
    "changes": [
        {
            "id": 0,
            "kind": "string",
            "status": "new",
            "error": {
                "code": "apply_change_error",
                "message": "State mismatch error",
                "details": "bad item at pos 2"
            }
        }
    ]
}

Name	Description
changes*	Type: ChangeResponse[]

ChangeResponse

Name	Description
id*	Type: integer<int64> Unique change ID (int64)
kind*	Type: string Change type
status*	Type: ChangeStatus Change processing status Enum: `new`, `pending`, `applied`, `failed`
error	Type: ErrorWithDetails Error description (for the failed status)

ChangeStatus

Change processing status

Type	Description
ChangeStatus	Enum: `new`, `pending`, `applied`, `failed`

ErrorWithDetails

Error information

Name	Description
code*	Type: string Error code Example: `apply_change_error` Enum: `apply_change_error`, `inappropriate_point`, `invalid_destination_point`, `invalid_item_destination_point`, `invalid_item_source_point`, `invalid_source_point`, `not_allowed`, `invalid_phone_incorrect_symbol`, `invalid_phone_must_start_plus_symbol`, `invalid_phone_size_incorrect`, `country_phone_code_not_supported`, `invalid_post_payment`, `max_order_cost_exceeded`, `cargo_payments_update_error`
message*	Type: string Error description Example: `State mismatch error`
details	Type: string Non-localized error message Example: `bad item at pos 2`

404 Not Found

Change 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

Get the editing result after confirmation

Request

Query parameters

Headers

Responses

200 OK

Body

ChangeResponse

ChangeStatus

ErrorWithDetails

404 Not Found

Body

Was the article helpful?