- Request
- Query parameters
- Body
- BillingInfo
- DestinationRequestNode
- RequestInfo
- RequestResourceItem
- LastMilePolicy
- ResourcePlace
- Contact
- SourceRequestNode
- PaymentMethod
- VariableDeliveryCostForRecipientItem
- CustomLocation
- TimeIntervalUTC
- PlatformStation
- ItemBillingDetails
- ItemPhysicalDimensions
- PlacePhysicalDimensions
- LocationDetails
- Responses
- 200 OK
- 400 Bad Request
3.01. Создание заявки
Получение вариантов доставки (офферов) для переданного заказа.
При передаче нескольких идентичных товарных позиций необходимо передавать количество в параметре count
. В противном случае в системе будет записано количество 1.
Request
POST
b2b.taxi.tst.yandex.net/api/b2b/platform/offers/create
Тестовое окружение
POST
b2b-authproxy.taxi.yandex.net/api/b2b/platform/offers/create
Продакшен-окружение
Query parameters
Name |
Description |
send_unix |
Type: boolean Формат времени, в котором нужно отправить интервалы доставки (true - unix, false - utc) |
Body
application/json
{
"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
}
Name |
Description |
billing_info* |
Type: BillingInfo Данные для биллинга |
destination* |
Type: DestinationRequestNode Информация о точке получения заказа |
info* |
Type: RequestInfo Базовый набор метаданных по запросу |
items* |
Type: RequestResourceItem[] Информация о предметах в заказе Min items: |
last_mile_policy* |
Type: LastMilePolicy Требуемый способ доставки Enum: |
places* |
Type: ResourcePlace[] Информация о местах в заказе Min items: |
recipient_info* |
Type: Contact Данные о получателе |
source* |
Type: SourceRequestNode Информация о точке отправления заказа |
particular_items_refuse |
Type: boolean Разрешен ли частичный выкуп Default: |
BillingInfo
Name |
Description |
payment_method* |
Type: PaymentMethod Метод оплаты Enum: |
delivery_cost |
Type: integer Сумма, которую нужно взять с получателя за доставку. Актуально только для заказов с постоплатой (тип оплаты |
variable_delivery_cost_for_recipient |
Type: VariableDeliveryCostForRecipientItem[] Список стоимостей доставки в зависимости от суммы выкупленных товаров. |
DestinationRequestNode
Name |
Description |
type* |
Type: string Тип целевой точки. Для доставки до двери — Enum: |
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 Штрихкод коробки, к которой относится товар |
marking_code |
Type: string Код для маркировки |
physical_dims |
Type: ItemPhysicalDimensions Физические параметры объекта |
uin |
Type: string Уникальный идентификатор |
LastMilePolicy
Типы полиси доставки последней мили. Может принимать значение только из enum.
time_interval: Доставка до двери в указанный интервал
self_pickup: Доставка до пункта выдачи
Type |
Description |
Enum: |
ResourcePlace
Name |
Description |
barcode* |
Type: string Штрихкод коробки. |
physical_dims* |
Type: PlacePhysicalDimensions Физические параметры места |
description |
Type: string Описание коробки |
Contact
Name |
Description |
first_name* |
Type: string Имя |
phone* |
Type: string Номер телефона |
|
Type: string Адрес электронной почты |
last_name |
Type: string Фамилия |
partonymic |
Type: string Отчество |
SourceRequestNode
Name |
Description |
platform_station* |
Type: PlatformStation Описание целевой станции в случае, если она зарегистрирована в платформе |
interval_utc |
Type: TimeIntervalUTC Временной интервал (в UTC) |
PaymentMethod
Type |
Description |
Enum: |
VariableDeliveryCostForRecipientItem
Name |
Description |
delivery_cost* |
Type: integer Стоимость доставки до применения скидки Min value: |
min_cost_of_accepted_items* |
Type: integer Стоимость выкупленных товаров, при достижении которой применяется скидка Min value: |
CustomLocation
Информация о произвольной точке. Точка может быть задана либо своими координатами — пара (latitude
, longitude
), либо адресом
Name |
Description |
details |
Type: LocationDetails Дополнительная информация о расположении станции |
latitude |
Type: number Широта |
longitude |
Type: number Долгота |
TimeIntervalUTC
Интервал времени в формате UTC.
Name |
Description |
from |
Type: string UTC timestamp для нижней границы интервала Example: |
to |
Type: string UTC timetamp для верхней границы интервала Example: |
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 Значение НДС. Допустимые значения — |
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) |
LocationDetails
Адрес квартиры обязателен при наличии
Name |
Description |
apartment |
Type: string Номер квартиры |
building |
Type: string Строение |
comment |
Type: string Комментарий |
country |
Type: string Страна Example: |
full_address |
Type: string Полный адрес с указанием города, улицы и номера дома Example: |
geoId |
Type: number Идентификатор города Example: |
house |
Type: string Номер дома Example: |
housing |
Type: string Корпус |
locality |
Type: string Населенный пункт Example: |
postal_code |
Type: string Индекс |
region |
Type: string Регион Example: |
street |
Type: string Улица Example: |
subRegion |
Type: string Область |
Responses
200 OK
OK
Body
application/json
{
"offers": [
{
"offer_id": "string",
"expires_at": "2021-10-25T15:00:00.000000Z",
"offer_details": {
"delivery_interval": {
"min": "2021-10-25T15:00:00.000000Z",
"max": "2021-10-25T15:00:00.000000Z",
"policy": "time_interval"
},
"pickup_interval": {
"min": 0,
"max": 0
},
"pricing": "192.15 RUB",
"pricing_commission_on_delivery_payment": "2.2%",
"pricing_commission_on_delivery_payment_amount": "9.43 RUB",
"pricing_total": "1400.96 RUB"
}
}
]
}
Name |
Description |
offers* |
Type: Offer[] Min items: |
Offer
Name |
Description |
expires_at |
Type: string Timestamp окончания действия предложения маршрутного листа в Гринвиче. |
offer_details |
Type: OfferDetails Подробности оффера. |
offer_id |
Type: string Идентификатор предложения маршрутного листа (оффера). |
OfferDetails
Name |
Description |
delivery_interval |
Type: DeliveryIntervalUTC Информация об интервале в котором будет произведена доставка. |
pickup_interval |
Type: PickupInterval Информация об интервале в котором будет произведен забор. |
pricing |
Type: string Стоимость за доставку с учетом НДС Example: |
pricing_commission_on_delivery_payment |
Type: string Процент комиссии Example: |
pricing_commission_on_delivery_payment_amount |
Type: string Комиссия Example: |
pricing_total |
Type: string Стоимость за доставку с учетом НДС и комиссии Example: |
DeliveryIntervalUTC
Name |
Description |
max |
Type: string Верхняя граница временного интервала доставки, UTC Timestamp в Гринвиче. Example: |
min |
Type: string Нижняя граница временного интервала доставки, UTC Timestamp в Гринвиче. Example: |
policy |
Type: LastMilePolicy Политика доставки последней мили в предложенном варианте. Enum: |
PickupInterval
Name |
Description |
max |
Type: integer Верхняя граница временного интервала забора, UNIX Timestamp в Гринвиче. |
min |
Type: integer Нижняя граница временного интервала забора, UNIX Timestamp в Гринвиче. |
PickupIntervalUTC
Name |
Description |
max |
Type: string Верхняя граница временного интервала забора, UTC Timestamp в Гринвиче. Example: |
min |
Type: string Нижняя граница временного интервала забора, UTC Timestamp в Гринвиче. Example: |
400 Bad Request
Нет доступных вариантов доставки
Body
application/json
{
"code": "no_delivery_options",
"message": "No delivery options for interval"
}
Name |
Description |
code* |
Type: string Код ошибки Example: |
message* |
Type: string Человекочитаемые детали ошибки Example: |
No longer supported, please use an alternative and newer version.