3.09. История статусов заявки

Получение информации об истории статусов заказа.

Request

GET

b2b.taxi.tst.yandex.net/api/b2b/platform/request/history

Тестовое окружение

GET

b2b-authproxy.taxi.yandex.net/api/b2b/platform/request/history

Продакшен-окружение

Query parameters

Name

Description

request_id*

Type: string

ID заявки в логистической платформе

Responses

200 OK

OK

Body

application/json
{
    "state_history": [
        {
            "status": "CREATED",
            "description": "Заказ создан в операторе",
            "timestamp": "1704056400",
            "timestamp_utc": "string",
            "reason": "SHOP_CANCELLED"
        }
    ]
}

Name

Description

state_history*

Type: RequestState[]

История изменения статусов заказа

Min items: 1

RequestState

Name

Description

description*

Type: string

Описание статуса

Example: Заказ создан в операторе

status*

Type: string

Статус, описывающий текущее состояние заказа

Example: CREATED

timestamp*

Type: integer

Временная метка в формате UNIX

Example: 1704056400

timestamp_utc*

Type: string

Временная метка в формате UTC

Example: null

reason

Type: CancelReason
or ChangeReason

Детальная причина события (отмены или переноса)

CancelReason

Причина отмены заявки. Может принимать только значения из enum.
SHOP_CANCELLED: Отправитель отменил заказ
USER_CHANGED_MIND: Покупатель передумал
DELIVERY_PROBLEMS: Возникли проблемы с доставкой
ORDER_WAS_LOST: Заказ был утерян
ORDER_IS_DAMAGED: Заказ был поврежден
EXTRA_RESCHEDULING: Заказ отменен из-за частых переносов
BROKEN_ITEM: Товар оказался бракованным
DIMENSIONS_EXCEEDED: Посылка слишком большая для способа доставки
PICKUP_EXPIRED: Срок хранения в пункте выдачи истек
LAST_MILE_CHANGED_BY_USER: Последняя миля изменена по инициативе пользователя
CLIENT_REQUEST: Получатель отменил заказ
DELIVERY_DATE_UPDATED_BY_DELIVERY: Задержка обработки заказа партнером
DELIVERY_DATE_UPDATED_BY_SHOP: По запросу от магазина

Type

Description

CancelReason

Enum: SHOP_CANCELLED, USER_CHANGED_MIND, DELIVERY_PROBLEMS, ORDER_WAS_LOST, ORDER_IS_DAMAGED, EXTRA_RESCHEDULING, BROKEN_ITEM, DIMENSIONS_EXCEEDED, PICKUP_EXPIRED, LAST_MILE_CHANGED_BY_USER, CLIENT_REQUEST, DELIVERY_DATE_UPDATED_BY_DELIVERY, DELIVERY_DATE_UPDATED_BY_SHOP

ChangeReason

Причина переноса заявки. Может принимать только значения из enum.
SHOP_CANCELLED: Отправитель отменил заказ
USER_CHANGED_MIND: Покупатель передумал
DELIVERY_PROBLEMS: Возникли проблемы с доставкой
ORDER_WAS_LOST: Заказ был утерян
ORDER_IS_DAMAGED: Заказ был поврежден
EXTRA_RESCHEDULING: Заказ отменен из-за частых переносов
BROKEN_ITEM: Товар оказался бракованным
DIMENSIONS_EXCEEDED: Посылка слишком большая для способа доставки
PICKUP_EXPIRED: Срок хранения в пункте выдачи истек
LAST_MILE_CHANGED_BY_USER: Последняя миля изменена по инициативе пользователя
CLIENT_REQUEST: Получатель отменил заказ
DELIVERY_DATE_UPDATED_BY_DELIVERY: Задержка обработки заказа партнером
DELIVERY_DATE_UPDATED_BY_SHOP: По запросу от магазина

Type

Description

ChangeReason

Enum: SHOP_CANCELLED, USER_CHANGED_MIND, DELIVERY_PROBLEMS, ORDER_WAS_LOST, ORDER_IS_DAMAGED, EXTRA_RESCHEDULING, BROKEN_ITEM, DIMENSIONS_EXCEEDED, PICKUP_EXPIRED, LAST_MILE_CHANGED_BY_USER, CLIENT_REQUEST, DELIVERY_DATE_UPDATED_BY_DELIVERY, DELIVERY_DATE_UPDATED_BY_SHOP

No longer supported, please use an alternative and newer version.