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: Проблемы с доставкой
DIMENSIONS_EXCEEDED: Посылка слишком большая для способа доставки
DIMENSIONS_EXCEEDED_LOCKER: Превышены допустимые габариты постамата
NO_PASSPORT: Нет паспорта
ORDER_IS_DAMAGED: Заказ поврежден
EXTRA_RESCHEDULING: Заказ отменен из-за частых переносов
BROKEN_ITEM: Товар оказался бракованным
ORDER_ITEMS_QUANTITY_MISMATCH: Не совпадает количество товаров
ORDER_WAS_LOST: Заказ утерян
LATE_CONTACT: С пользователем связались слишком поздно
PICKUP_EXPIRED: Срок хранения в пункте выдачи истек
UNKNOWN: Не определён
OTHER: Другая проблема

Type

Description

CancelReason

Enum: SHOP_CANCELLED, USER_CHANGED_MIND, DELIVERY_PROBLEMS, DIMENSIONS_EXCEEDED, DIMENSIONS_EXCEEDED_LOCKER, NO_PASSPORT, ORDER_IS_DAMAGED, EXTRA_RESCHEDULING, BROKEN_ITEM, ORDER_ITEMS_QUANTITY_MISMATCH, ORDER_WAS_LOST, LATE_CONTACT, PICKUP_EXPIRED, UNKNOWN, OTHER

ChangeReason

Причина переноса заявки. Может принимать только значения из enum.
CLIENT_REQUEST: По просьбе клиента
COURIER_COULD_NOT_CONTACT_RECIPIENT: Курьер не смог дозвониться
DELIVERY_DATE_UPDATED_BY_DELIVERY: Задержка обработки заказа партнёром
DELIVERY_DATE_UPDATED_BY_RECIPIENT: По запросу от пользователя
DELIVERY_DATE_UPDATED_BY_SHOP: По запросу от магазина
LAST_MILE_CHANGED_BY_USER: Последняя миля изменена по инициативе пользователя
LOCKER_FULL: Нет свободных ячеек подходящего размера
NO_PASSPORT: Нет паспорта
PICKUPPOINT_TECHNICAL_ISSUES: Технические проблемы в ПВЗ
UNKNOWN: Не определён
OTHER: Другая проблема

Type

Description

ChangeReason

Enum: CLIENT_REQUEST, COURIER_COULD_NOT_CONTACT_RECIPIENT, DELIVERY_DATE_UPDATED_BY_DELIVERY, DELIVERY_DATE_UPDATED_BY_RECIPIENT, DELIVERY_DATE_UPDATED_BY_SHOP, LAST_MILE_CHANGED_BY_USER, LOCKER_FULL, NO_PASSPORT, PICKUPPOINT_TECHNICAL_ISSUES, UNKNOWN, OTHER