Предварительная оценка без создания заявки
Request
POST
b2b.taxi.yandex.net/b2b/cargo/integration/v2/check-price
Адрес сервиса
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Предпочитаемый язык ответа Например: Example: |
Body
application/json
{
"items": [
{
"size": {
"length": 0.1,
"width": 0.2,
"height": 0.3
},
"weight": 2.105,
"quantity": 1,
"pickup_point": 1,
"dropoff_point": 2
}
],
"route_points": [
{
"id": 1,
"coordinates": [
0.1,
0.1
],
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"country": "Россия",
"city": "Санкт-Петербург",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1"
}
],
"requirements": {
"taxi_class": "cargo",
"cargo_type": "lcv_m",
"cargo_loaders": 1,
"pro_courier": false,
"cargo_options": [
"thermobag"
],
"same_day_data": {
"delivery_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
}
}
},
"skip_door_to_door": false
}
|
Name |
Description |
|
route_points |
Type: RoutePointWithAddress[] Точки маршрута. Отсортированы в порядке посещения А-Б1....БN Min items: Example
|
|
items |
Type: Item[] Параметры товаров Min items: Example
|
|
requirements |
Type: Requirements Требования к доставке (класс авто, опции) Example
|
|
skip_door_to_door |
Type: boolean Отключить доставку до двери (выключить опцию "От двери до двери"). Возможные значения:
Default: |
CargoItemSizes
Габариты товара в метрах. В полях следует передавать актуальные значения.
Если габариты не были переданы, заказ оформляется с учетом
максимально допустимых габаритов для выбранного тарифа.
Если фактические характеристики товара превысят допустимые,
курьер вправе отказаться от выполнения такого заказа на месте.
В этом случае будет удержана стоимость подачи.
Курьер (courier): до 0.80 м × 0.50 м × 0.50 м
Экспресс (express): до 1.00 м × 0.60 м × 0.50 м
Грузовой (cargo):
- Маленький кузов: до 1.70 м × 0.96 м × 0.90 м
- Средний кузов: до 2.60 м × 1.30 м × 1.50 м
- Большой кузов: до 3.80 м × 1.80 м × 1.80 м
|
Name |
Description |
|
height |
Type: number Высота в метрах Min value: Max value: |
|
length |
Type: number Длина в метрах Min value: Max value: |
|
width |
Type: number Ширина в метрах Min value: Max value: |
Example
{
"length": 0.1,
"width": 0.2,
"height": 0.3
}
Item
|
Name |
Description |
|
quantity |
Type: integer Количество единиц товара Min value: |
|
dropoff_point |
Type: integer Идентификатор точки (int64), куда нужно доставить товар. |
|
pickup_point |
Type: integer Идентификатор точки (int64), откуда нужно забрать товар. |
|
size |
Type: CargoItemSizes Габариты товара в метрах. В полях следует передавать актуальные значения. Если габариты не были переданы, заказ оформляется с учетом Если фактические характеристики товара превысят допустимые, Курьер (courier): до 0.80 м × 0.50 м × 0.50 м
Example
|
|
weight |
Type: number Вес товара в килограммах. |
Example
{
"size": {
"length": 0.1,
"width": 0.2,
"height": 0.3
},
"weight": 2.105,
"quantity": 1,
"pickup_point": 1,
"dropoff_point": 2
}
Point
Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке.
Type: number[]
Min items: 2
Max items: 2
Example
[
0.1,
0.1
]
AddressFullname
Полный адрес с указанием города, улицы и номера дома.
Номер квартиры, подъезда и этаж указывать не нужно.
Type: string
Example: Санкт-Петербург, Большая Монетная улица, 1к1А
RoutePointWithAddress
|
Name |
Description |
|
building |
Type: string Строение Example: |
|
city |
Type: string Город Example: |
|
coordinates |
Type: Point Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке. Min items: Max items: Example
|
|
country |
Type: string Страна Example: |
|
fullname |
Type: AddressFullname Полный адрес с указанием города, улицы и номера дома. Example: |
|
id |
Type: integer Числовой id точки(int64). Параметр обязательный, если в заказе несколько точек доставки |
|
porch |
Type: string Подъезд (может быть A) Example: |
|
sflat |
Type: string Квартира Example: |
|
sfloor |
Type: string Этаж Example: |
|
street |
Type: string Улица Example: |
Example
{
"id": 1,
"coordinates": [
0.1,
0.1
],
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"country": "Россия",
"city": "Санкт-Петербург",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1"
}
CargoType
Тип (размер) кузова для грузового тарифа.
Возможные значения:
- van ("Маленький кузов")
- lcv_m ("Средний кузов")
- lcv_l ("Большой кузов")
- lcv_xl ("Кузов XL")
Точный список возможных значений для конкретной геоточки уточняйте с помощью метода получения тарифов tariffs
Type: string
Enum: van, lcv_m, lcv_l, lcv_xl
CargoOptions
Список дополнительных опций тарифа.
Возможные отдельные опции:
- auto_courier (курьер только на автомобиле)
- thermobag (курьер с термосумкой)
Пример списка опций: ["auto_courier"].
Точный список возможных значений для конкретной геоточки
уточните с помощью метода получения тарифов tariffs
Type: string[]
Example
[
"thermobag"
]
TimeInterval
Временной интервал
|
Name |
Description |
|
from |
Type: string<date-time> Начало интервала Example: |
|
to |
Type: string<date-time> Окончание интервала (дата и время) Example: |
Example
{
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
}
Requirements
Требования к доставке (класс авто, опции)
|
Name |
Description |
||
|
cargo_loaders |
Type: integer Число грузчиков для грузового тарифа. Точный список возможных значений для конкретной геоточки |
||
|
cargo_options |
Type: CargoOptions Список дополнительных опций тарифа. Возможные отдельные опции:
Пример списка опций: ["auto_courier"]. Точный список возможных значений для конкретной геоточки Example
|
||
|
cargo_type |
Type: CargoType Тип (размер) кузова для грузового тарифа.
Enum: |
||
|
pro_courier |
Type: boolean Включить опцию "Профи" для тарифов "Экспресс" и "Курьер". |
||
|
same_day_data |
Type: object
Опции доставки "В течение дня" Example
|
||
|
taxi_class |
Type: string Класс автомобиля для доставки. Точный список возможных значений для конкретной геоточки Example: |
Example
{
"taxi_class": "cargo",
"cargo_type": "lcv_m",
"cargo_loaders": 1,
"pro_courier": false,
"cargo_options": [
"thermobag"
],
"same_day_data": {
"delivery_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
}
}
}
Responses
200 OK
OK
Body
application/json
{
"price": "12.50",
"currency_rules": {
"code": "RUB",
"text": "руб.",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"sign": "₽"
},
"requirements": {
"taxi_class": "cargo",
"cargo_type": "lcv_m",
"cargo_loaders": 1,
"pro_courier": false,
"cargo_options": [
"thermobag"
],
"same_day_data": {
"delivery_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
}
}
},
"distance_meters": 10,
"eta": 10,
"zone_id": "moscow"
}
|
Name |
Description |
|
price |
Type: Money Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
requirements |
Type: Requirements Требования к доставке (класс авто, опции) Example
|
|
currency_rules |
Type: CurrencyRules Правила отображения валюты Example
|
|
distance_meters |
Type: RouteDistance Расстояние в метрах для указанного маршрута, от первой точки до последней точки Example: |
|
eta |
Type: number Расчетное врем прибытия в минутах |
|
zone_id |
Type: string Идентификатор (ID) зоны доставки Example: |
Money
Стоимость доставки в формате десятичной дроби Decimal(18, 4)
Type: string
Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$
Example: 12.50
Currency
Трехзначный код валюты, в которой ведется расчет
Type: string
Min length: 3
Max length: 3
Example: RUB
CurrencyRules
Правила отображения валюты
|
Name |
Description |
|
code |
Type: Currency Трехзначный код валюты, в которой ведется расчет Min length: Max length: Example: |
|
template |
Type: string Шаблон для отображения валюты Example: |
|
text |
Type: string Сокращенное наименование валюты Example: |
|
sign |
Type: string Символ валюты Example: |
Example
{
"code": "RUB",
"text": "руб.",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"sign": "₽"
}
RouteDistance
Расстояние в метрах для указанного маршрута, от первой точки до последней точки
Type: number
400 Bad Request
Неверный запрос
Body
application/json
{
"code": "bad_request",
"message": "bad request"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
409 Conflict
Нет подходящих машин | Не удалось построить маршрут
Body
application/json
{
"code": "estimating.requirement_unavailable",
"message": "requirement unavailable"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
429 Too Many Requests
Слишком много запросов
Body
application/json
{
"code": "too_many_requests",
"message": "Слишком много запросов"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
No longer supported, please use an alternative and newer version.