3.04. Получение информации о заявках во временном интервале

Получение информации о заявках, созданных в заданный временной интервал.

Request

POST

b2b.taxi.tst.yandex.net/api/b2b/platform/requests/info

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

POST

b2b-authproxy.taxi.yandex.net/api/b2b/platform/requests/info

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

Body

application/json
{
    "from": "2021-10-25T15:00:00.000000Z",
    "to": "2021-10-25T15:00:00.000000Z",
    "request_ids": [
        "string"
    ]
}

Name

Description

from

Type: string
or integer

Начало временного интервала создания заказов

request_ids

Type: string[]

Список идентификаторов заказов

to

Type: string
or integer

Конец временного интервала создания заказов

Responses

200 OK

OK

Body

application/json
{
    "requests": [
        {
            "request_id": "string",
            "request": {
                "info": {
                    "operator_request_id": "string",
                    "comment": "string"
                },
                "source": {
                    "platform_station": {
                        "platform_id": "string"
                    },
                    "interval_utc": {
                        "from": "2021-10-25T15:00:00.000000Z",
                        "to": "2021-10-25T15:00:00.000000Z"
                    }
                },
                "destination": {
                    "type": "platform_station",
                    "platform_station": {
                        "platform_id": "string"
                    },
                    "custom_location": {
                        "latitude": 0,
                        "longitude": 0,
                        "details": {
                            "geoId": "213",
                            "country": "Россия",
                            "region": "Москва",
                            "subRegion": "string",
                            "locality": "Москва",
                            "street": "Пролетарский проспект",
                            "house": "19",
                            "housing": "string",
                            "apartment": "string",
                            "building": "string",
                            "comment": "string",
                            "full_address": "Москва, Пролетарский проспект, 19",
                            "postal_code": "string"
                        }
                    },
                    "interval_utc": {
                        "from": "2021-10-25T15:00:00.000000Z",
                        "to": "2021-10-25T15:00:00.000000Z"
                    }
                },
                "items": [
                    {
                        "count": 0,
                        "name": "string",
                        "article": "string",
                        "marking_code": "string",
                        "uin": "string",
                        "billing_details": {
                            "inn": "string",
                            "nds": 0,
                            "unit_price": 0,
                            "assessed_unit_price": 0
                        },
                        "physical_dims": {
                            "dx": 0,
                            "dy": 0,
                            "dz": 0,
                            "predefined_volume": 0
                        },
                        "place_barcode": "string"
                    }
                ],
                "places": [
                    {
                        "physical_dims": {
                            "weight_gross": 0,
                            "dx": 0,
                            "dy": 0,
                            "dz": 0,
                            "predefined_volume": 0
                        },
                        "barcode": "string",
                        "description": "string"
                    }
                ],
                "billing_info": {
                    "payment_method": "already_paid",
                    "delivery_cost": 0,
                    "variable_delivery_cost_for_recipient": [
                        {
                            "min_cost_of_accepted_items": 0,
                            "delivery_cost": 0
                        }
                    ]
                },
                "recipient_info": {
                    "first_name": "string",
                    "last_name": "string",
                    "partonymic": "string",
                    "phone": "string",
                    "email": "string"
                },
                "last_mile_policy": "time_interval",
                "particular_items_refuse": false,
                "available_actions": {
                    "update_dates_available": false,
                    "update_address_available": false,
                    "update_courier_to_pickup_available": false,
                    "update_pickup_to_courier_available": false,
                    "update_pickup_to_pickup_available": false,
                    "update_items": false,
                    "update_recipient": false,
                    "update_places": false
                }
            },
            "state": {
                "status": "CREATED",
                "description": "Заказ создан в операторе",
                "timestamp": "1704056400",
                "timestamp_utc": "string",
                "reason": "SHOP_CANCELLED"
            },
            "full_items_price": 0,
            "sharing_url": "string",
            "courier_order_id": "string",
            "self_pickup_node_code": {
                "type": "pickup",
                "code": "00000"
            }
        }
    ]
}

Name

Description

requests*

Type: RequestReport[]

RequestReport

Name

Description

full_items_price*

Type: integer

Общая стоимость всех предметов в заказе

request*

Type: object

request_id*

Type: string

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

state*

Type: RequestState

Текущий статус заказа

courier_order_id

Type: string

Номер заказа в системе оператора

self_pickup_node_code

Type: SelfPickupNodeCode

Информация по коду получения

sharing_url

Type: string

Ссылка на страницу с трекингом заказа для получателя

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

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

SelfPickupNodeCode

Name

Description

code

Type: string

Код получения

Example: 00000

type

Type: string

Тип кода

Example: pickup

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

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