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": "example"
}

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

Example: example

Responses

200 OK

Body

application/json

{
  "cursor": "example",
  "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": "RUB",
      "resolution": "success",
      "revision": 1,
      "client_id": "95d010b2471041499b8cb1bfa282692f",
      "current_point_id": 372036854775807
    }
  ]
}

Name

Description

cursor

Type: string

Last change ID

Example: example

events

Type: Event[]

Example

[
  {
    "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": "RUB",
    "resolution": "success",
    "revision": 1,
    "client_id": "95d010b2471041499b8cb1bfa282692f",
    "current_point_id": 372036854775807
  }
]

ClaimStatus

Claim status. To learn more, see Status model

Type: string

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

Enum: success, failed

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

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 Operation ID (int64)
revision	Type: integer Claim change version (int64)
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: 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. Example: `372036854775807`
new_currency	Type: string Order currency code Example: `RUB`
new_price	Type: string Order price Example: `20.00`
new_status	Type: ClaimStatus Claim status. To learn more, see Status model 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 Enum: `success`, `failed`

Example

{
  "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": "RUB",
  "resolution": "success",
  "revision": 1,
  "client_id": "95d010b2471041499b8cb1bfa282692f",
  "current_point_id": 372036854775807
}

400 Bad Request

BAD REQUEST

Body

application/json

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

Name

Description

code

Type: string

Error code

Const: invalid_cursor

Example: example

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

Const: too_many_requests

Example: too_many_requests

message

Type: string

Error description

Example: Too many requests

Was the article helpful?

6.2 Get information on multiple claims

7. Same-day delivery