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

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

Request

GET

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

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

GET

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

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

Query parameters

Name	Description
request_code	Type: string Номер заказа в системе заказчика.
request_id	Type: string ID заявки в логистической платформе
slim	Type: boolean Флаг получения обновленной версии ответа.

Responses

200 OK

Body

application/json

{
    "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",
                "cargo_types": "[\"80\"]",
                "fitting": false
            }
        ],
        "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",
            "patronymic": "string",
            "phone": "string",
            "email": "string"
        },
        "last_mile_policy": "time_interval",
        "particular_items_refuse": false,
        "forbid_unboxing": 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

full_items_price*

Type: integer

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

request*

Type: object

billing_info*	Type: BillingInfo Данные для биллинга
destination*	Type: DestinationRequestNode Информация о точке получения заказа
info*	Type: RequestInfo Базовый набор метаданных по запросу
items*	Type: RequestResourceItem[] Информация о предметах в заказе Min items: `1`
last_mile_policy*	Type: LastMilePolicy Требуемый способ доставки Enum: `time_interval`, `self_pickup`
places*	Type: ResourcePlace[] Информация о местах в заказе Min items: `1`
recipient_info*	Type: Contact Данные о получателе
source*	Type: SourceRequestNode Информация о точке отправления заказа
available_actions	Type: AvailableActions Доступные изменения заказа.
forbid_unboxing	Type: boolean Запрет на вскрытие транспортной упаковки Default: `false`
particular_items_refuse	Type: boolean Разрешен ли частичный выкуп `true` — разрешен частичный выкуп заказа `false` — частичный выкуп заказа недоступен Значение по умолчанию: false Default: `false`

request_id*

Type: string

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

state*

Type: RequestState

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

courier_order_id

Type: string

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

self_pickup_node_code

Type: SelfPickupNodeCode

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

sharing_url

Type: string

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

BillingInfo

Name	Description
payment_method*	Type: PaymentMethod Метод оплаты Enum: `already_paid`, `card_on_receipt`
delivery_cost	Type: integer Сумма, которую нужно взять с получателя за доставку. Актуально только для заказов с постоплатой (тип оплаты `card_on_receipt`)
variable_delivery_cost_for_recipient	Type: VariableDeliveryCostForRecipientItem[] Список стоимостей доставки в зависимости от суммы выкупленных товаров. Позволяет управлять скидками на доставку для получателя. Скидка применяется только для заказов с постоплатой и частичным выкупом.

DestinationRequestNode

Name	Description
type*	Type: string Тип целевой точки. Для доставки до двери — `custom_location` (2), для доставки до ПВЗ — `platform_station` (1) Enum: `platform_station`, `custom_location`
custom_location	Type: CustomLocation Полное описание целевого адреса доставки
interval_utc	Type: TimeIntervalUTC Временной интервал (в UTC)
platform_station	Type: PlatformStation Описание целевой станции в случае, если она зарегистрирована в платформе

RequestInfo

Name

Description

operator_request_id*

Type: string

Идентификатор заказа у отправителя

comment

Type: string

Опциональный коментарий

RequestResourceItem

Name	Description
article*	Type: string Артикул
billing_details*	Type: ItemBillingDetails Данные по биллингу для предмета
count*	Type: integer Количество
name*	Type: string Название
place_barcode*	Type: string Штрихкод коробки, к которой относится товар
cargo_types	Type: string[] Типы товаров в заказе. Используйте этот параметр, чтобы обозначить особые требования по обращению с товаром Example: `["80"]` Min items: `1`
fitting	Type: boolean Разрешена ли примерка товара. Значение по умолчанию: `false`. Если у заказа признак `particular_items_refuse` принимает значение `true`, то значение параметра `fitting` также по умолчанию будет `true`. Default: `false`
marking_code	Type: string Код маркировки
physical_dims	Type: ItemPhysicalDimensions Физические параметры объекта
uin	Type: string Уникальный идентификатор

LastMilePolicy

Типы полиси доставки последней мили. Может принимать значение только из enum.
time_interval: Доставка до двери в указанный интервал
self_pickup: Доставка до пункта выдачи

Type	Description
LastMilePolicy	Enum: `time_interval`, `self_pickup`

ResourcePlace

Name	Description
barcode*	Type: string Штрихкод коробки. По умолчанию штрихкод грузоместа подменяется на уникальный на стороне Яндекс Доставки. Чтобы использовать собственные штрихкоды или работать с кастомными маркировками, обратитесь к менеджеру. Для получения актуальных штрихкодов воспользуйтесь методом 3.03. Получение информации о заявке.
physical_dims*	Type: PlacePhysicalDimensions Физические параметры места
description	Type: string Описание коробки

Contact

Name	Description
first_name*	Type: string Имя
phone*	Type: string Номер телефона
email	Type: string Адрес электронной почты
last_name	Type: string Фамилия
patronymic	Type: string Отчество

SourceRequestNode

Name

Description

platform_station*

Type: PlatformStation

Описание целевой станции в случае, если она зарегистрирована в платформе

interval_utc

Type: TimeIntervalUTC

Временной интервал (в UTC)

AvailableActions

Name	Description
update_address_available	Type: boolean Доступность изменения адреса доставки
update_courier_to_pickup_available	Type: boolean Доступность изменения типа доставки с курьерской на доставку до Пункта выдачи
update_dates_available	Type: boolean Доступность изменения даты доставки
update_items	Type: boolean Доступность изменения предметов в заказе
update_pickup_to_courier_available	Type: boolean Доступность изменения типа доставки с доставки до Пункта выдачи на курьерскую
update_pickup_to_pickup_available	Type: boolean Доступность изменения пункта выдачи
update_places	Type: boolean Доступность изменения грузомест в заказе
update_recipient	Type: boolean Доступность изменения информации о получателе заказа

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

PaymentMethod

Type	Description
PaymentMethod	Enum: `already_paid`, `card_on_receipt`

VariableDeliveryCostForRecipientItem

Name

Description

delivery_cost*

Type: integer

Стоимость доставки после применения скидки

Min value: 0

min_cost_of_accepted_items*

Type: integer

Стоимость выкупленных товаров, при достижении которой применяется скидка

Min value: 1

CustomLocation

Информация о произвольной точке. Точка может быть задана либо своими координатами — пара (latitude, longitude), либо адресом

Name	Description
details	Type: LocationDetails Дополнительная информация о расположении станции
latitude	Type: number Широта
longitude	Type: number Долгота

TimeIntervalUTC

Интервал времени в формате UTC.

Name

Description

from

Type: string

UTC timestamp для нижней границы интервала

Example: 2021-10-25T15:00:00.000000Z

Type: string

UTC timestamp для верхней границы интервала

Example: 2021-10-25T15:00:00.000000Z

PlatformStation

Name

Description

platform_id

Type: string

Идентификатор станции в Логистической платформе (например, склад отгрузки или ПВЗ)

ItemBillingDetails

Name	Description
assessed_unit_price*	Type: integer Оценочная цена за единицу товара (передается в копейках)
unit_price*	Type: integer Цена за единицу товара (передается в копейках)
inn	Type: string ИНН
nds	Type: integer Значение НДС. Допустимые значения — `0`, `5`, `7`, `10`, `20`. Если заказ `без НДС`, передавайте значение `-1`

ItemPhysicalDimensions

Указываются либо габариты (dx, dy, dz), либо объем в см3 (predefined_volume)

Name	Description
dx	Type: integer Длина, сантиметры
dy	Type: integer Высота, сантиметры
dz	Type: integer Ширина, сантиметры
predefined_volume	Type: integer Объем (в см3)

PlacePhysicalDimensions

Весогабаритные характеристики грузомест

Name	Description
dx*	Type: integer Длина, сантиметры
dy*	Type: integer Высота, сантиметры
dz*	Type: integer Ширина, сантиметры
weight_gross*	Type: integer Вес брутто, граммы
predefined_volume	Type: integer Объем (в см3)

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`

LocationDetails

Адрес квартиры обязателен при наличии

Name	Description
apartment	Type: string Номер квартиры
building	Type: string Строение
comment	Type: string Комментарий
country	Type: string Страна Example: `Россия`
full_address	Type: string Полный адрес с указанием города, улицы и номера дома Example: `Москва, Пролетарский проспект, 19`
geoId	Type: number Идентификатор города Example: `213`
house	Type: string Номер дома Example: `19`
housing	Type: string Корпус
locality	Type: string Населенный пункт Example: `Москва`
postal_code	Type: string Индекс
region	Type: string Регион Example: `Москва`
street	Type: string Улица Example: `Пролетарский проспект`
subRegion	Type: string Область

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

3.02. Подтверждение заявки

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