Changelog

The method returns the change history of the claim. You can find out about the changes in order status and price. For terminal statuses, the "resolution" field is returned, with possible values being ''success'' and ''failed''.

Request

POST

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

Service URL

Body

application/json

{
    "cursor": "string"
}

Name

Description

cursor

Type: string

A string with the ID of the last
change. If the cursor
isn't added, all changes
with a certain limit
will be approved

Responses

200 OK

Body

application/json

{
    "cursor": "string",
    "events": [
        {
            "operation_id": 1,
            "claim_id": "3b8d1af142664fde824626a7c19e2bd9",
            "change_type": "status_changed",
            "updated_ts": "2020-01-01T00:00:00+00:00",
            "new_status": "new",
            "new_price": "20.00",
            "new_currency": "AED",
            "resolution": "success",
            "revision": 1,
            "client_id": "95d010b2471041499b8cb1bfa282692f",
            "current_point_id": 372036854775807
        }
    ]
}

Name

Description

cursor*

Type: string

Last change ID

events*

Type: Event[]

Information about the order change

Event

Information about the order change

Name	Description
change_type*	Type: string Change type. Possible values: status_changed — status change. price_changed — price change. Example: `status_changed`
claim_id*	Type: string Claim ID (claim_id) Example: `3b8d1af142664fde824626a7c19e2bd9`
operation_id*	Type: integer<int64> Operation ID (int64) Example: `1`
revision*	Type: integer<int64> Claim change version (int64) Example: `1`
updated_ts*	Type: string<date-time> Event time in ISO 8601 format Example: `2020-01-01T00:00:00+00:00`
client_id	Type: string Customer ID Example: `95d010b2471041499b8cb1bfa282692f`
current_point_id	Type: integer<int64> 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: `372036854775807`
new_currency	Type: string Order currency code Example: `AED`
new_price	Type: string Order price Example: `20.00`
new_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`
resolution	Type: ClaimStatusResolution Terminal status resolution Example: `success` Enum: `success`, `failed`

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

ClaimStatusResolution

Terminal status resolution

Type

Description

ClaimStatusResolution

Example: success

Enum: success, failed

400 Bad Request

BAD REQUEST

Body

application/json

{
    "code": "invalid_cursor",
    "message": "Incorrect cursor format"
}

Name

Description

code*

Type: string

Error code

Enum: invalid_cursor

message*

Type: string

Error description

Example: Incorrect cursor format

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

Changelog

Request

Body

Responses

200 OK

Body

Event

ClaimStatus

ClaimStatusResolution

400 Bad Request

Body

429 Too Many Requests

Body

Was the article helpful?