7.2. Order change log

  1. HTTP Request
  2. Request Body
    1. Representation
    2. Fields
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 400
      1. Representation
      2. Fields
    3. Code 429
      1. Representation
      2. Fields
  4. Example

Returns the history of changes to the claim. You can find out about order status changes and price. For terminal statuses, the resolution field is returned. Possible values are success, failed.

HTTP Request

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

Request Body

{
  "cursor": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

cursor

string

String with ID of last change received by client. If cursor is not passed, all changes will be issued for this client with a certain limit

cursor

string

String with ID of last change received by client. If cursor is not passed, all changes will be issued for this client with a certain limit

Responses

Code 200

OK

{
  "cursor": string,
  "events": [
    {
      "change_type": string,
      "claim_id": string,
      "claim_origin": string,
      "client_id": string,
      "current_point_id": integer,
      "new_currency": string,
      "new_price": string,
      "new_status": string,
      "operation_id": integer,
      "resolution": string,
      "revision": integer,
      "updated_ts": string
    }
  ]
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

cursor *

string

ID of last change

events[] *

array

List of order changes

events[].change_type *

string

Type of change. Possible values: status_changed — status change; price_changed — price change.

events[].claim_id *

string

Claim ID claim_id

events[].claim_origin

string

Values from ClaimOriginValue

events[].client_id

string

Client ID

events[].current_point_id

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

events[].new_currency

string

Order currency code

events[].new_price

string

Order price

events[].new_status

string

Claim status

Allowed values
  1. new
  2. estimating
  3. estimating_failed
  4. ready_for_approval
  5. accepted
  6. performer_lookup
  7. performer_draft
  8. performer_found
  9. performer_not_found
  10. pickup_arrived
  11. ready_for_pickup_confirmation
  12. pickuped
  13. delivery_arrived
  14. ready_for_delivery_confirmation
  15. pay_waiting
  16. delivered
  17. delivered_finish
  18. returning
  19. return_arrived
  20. ready_for_return_confirmation
  21. returned
  22. returned_finish
  23. failed
  24. cancelled
  25. cancelled_with_payment
  26. cancelled_by_taxi
  27. cancelled_with_items_on_hands

events[].operation_id *

integer

Operation ID (int64)

events[].resolution

string

Terminal status resolution

Allowed values
  1. success
  2. failed

events[].revision *

integer

Version of the claim changes (int64)

events[].updated_ts *

string

Event time in ISO 8601 format

cursor *

string

ID of last change

events[] *

array

List of order changes

events[].change_type *

string

Type of change. Possible values: status_changed — status change; price_changed — price change.

events[].claim_id *

string

Claim ID claim_id

events[].claim_origin

string

Values from ClaimOriginValue

events[].client_id

string

Client ID

events[].current_point_id

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

events[].new_currency

string

Order currency code

events[].new_price

string

Order price

events[].new_status

string

Claim status

Allowed values
  1. new
  2. estimating
  3. estimating_failed
  4. ready_for_approval
  5. accepted
  6. performer_lookup
  7. performer_draft
  8. performer_found
  9. performer_not_found
  10. pickup_arrived
  11. ready_for_pickup_confirmation
  12. pickuped
  13. delivery_arrived
  14. ready_for_delivery_confirmation
  15. pay_waiting
  16. delivered
  17. delivered_finish
  18. returning
  19. return_arrived
  20. ready_for_return_confirmation
  21. returned
  22. returned_finish
  23. failed
  24. cancelled
  25. cancelled_with_payment
  26. cancelled_by_taxi
  27. cancelled_with_items_on_hands

events[].operation_id *

integer

Operation ID (int64)

events[].resolution

string

Terminal status resolution

Allowed values
  1. success
  2. failed

events[].revision *

integer

Version of the claim changes (int64)

events[].updated_ts *

string

Event time in ISO 8601 format

Code 400

BAD REQUEST

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. invalid_cursor

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. invalid_cursor

message *

string

Human-readable error message

Code 429

TOO MANY REQUESTS

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. too_many_requests

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. too_many_requests

message *

string

Human-readable error message

Example

Responses:

{
  "events": [
    {
      "change_type": "status_changed",
      "claim_id": "3b8d1af142664fde824626a7c19e2bd9",
      "client_id": "95d010b2471041499b8cb1bfa282692f",
      "current_point_id": 6987,
      "new_currency": "RUB",
      "new_price": "20.00",
      "new_status": "new",
      "operation_id": 1,
      "resolution": "success",
      "revision": 1,
      "updated_ts": "2020-01-01T00:00:00+00:00"
    }
  ]
}
Copied to clipboard