Журнал изменений

Метод возвращает историю изменения заявки. Вы можете узнать об изменении статусов и цены заказа. Для терминальных статусов возвращается поле resolution, возможные значения success, failed.

Request

POST

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

Адрес сервиса

Query parameters

Name

Description

limit

Type: integer

Максимальное количество возвращаемых записей

Default: 1000

Min value: 1

Max value: 1000

Body

application/json

{
  "cursor": "example"
}

Name

Description

cursor

Type: string

Строка с идентификатором последнего
изменения. Если cursor
не передан, то будут выданы все изменения
с некоторым лимитом

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

Идентификатор последнего изменения

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

Статус заявки. Подробнее см. в разделе Статусная модель

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

Резолюция терминального статуса

Type: string

Enum: success, failed

ClaimPointId

Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.

Type: integer

Event

Информация об изменении заказа

Name	Description
change_type	Type: string Тип изменения. Возможные значения: status_changed — изменение статуса; price_changed — изменение цены. Example: `status_changed`
claim_id	Type: string Идентификатор заявки claim_id Example: `3b8d1af142664fde824626a7c19e2bd9`
operation_id	Type: integer Идентификатор операции (int64)
revision	Type: integer Версия изменения заявки (int64)
updated_ts	Type: string<date-time> Время события в формате ISO 8601 Example: `2020-01-01T00:00:00+00:00`
client_id	Type: string Идентификатор клиента Example: `95d010b2471041499b8cb1bfa282692f`
current_point_id	Type: ClaimPointId Целочисленный идентификатор точки (int64), генерируемый на стороне Яндекс Доставки. Содержится в поле route_points[].id. Применимо к точкам с типом source, destination, return. Example: `372036854775807`
new_currency	Type: string Код валюты заказа Example: `RUB`
new_price	Type: string Цена заказа Example: `20.00`
new_status	Type: ClaimStatus Статус заявки. Подробнее см. в разделе Статусная модель 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 Резолюция терминального статуса 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": "unknown_error",
  "message": "Неправильный формат cursor"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, invalid_cursor

message

Type: string

Описание ошибки

Example: Неправильный формат cursor

429 Too Many Requests

TOO MANY REQUESTS

Body

application/json

{
  "code": "too_many_requests",
  "message": "Слишком много запросов"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, too_many_requests

message

Type: string

Описание ошибки

Example: Слишком много запросов

Была ли статья полезна?

6.2 Информация по нескольким заявкам

7. Доставка в течение дня