Калькулятор доставки

Параметр	Тип	Описание
`deliveryCompanyId`	number	ID компании доставки.
`deliveryCompanyName`	string	Название компании доставки.
`deliveryCompanyLogo`	string \| null	URL логотипа компании доставки.
`tariffName`	string \| null	Название тарифа доставки.
`pickupCompanyId`	number	ID компании отгрузки.
`deliveryDriver`	string	Внутреннее название драйвера компании доставки.
`deliveryDays.min`	number	Минимальный срок доставки в днях.
`deliveryDays.max`	number	Максимальный срок доставки в днях.
`deliveryPlanDays.min`	number	Минимальный срок доставки в днях, без учёта выходных дней.
`deliveryPlanDays.max`	number	Максимальный срок доставки в днях, без учёта выходных дней.
`deliveryDate.from`	string	Минимальная дата доставки.
`deliveryDate.to`	string	Максимальная дата доставки.
`services`	object	Дополнительные услуги. Ключами объекта выступают ID услуг.
`priceCommissionDeclared`	number	Стоимость страховки в рублях.
`percentCommissionDeclared`	number	Процентная ставка страховки.
`priceCommissionCod`	number	Комиссия наложенного платежа наличными в рублях.
`percentCommissionCod`	number	Процентная ставка наложенного платежа наличными.
`priceCommissionCodCard`	number	Комиссия наложенного платежа картой в рублях.
`percentCommissionCodCard`	number	Процентная ставка наложенного платежа картой.
`priceCommissionAcquiring`	number	Комиссия за эквайринг в рублях.
`percentCommissionAcquiring`	number	Процентная ставка за эквайринг.
`isPost`	boolean	Является ли данная доставка доставкой почтой.
`specificity`	array	Особенности службы доставки.
Только для доставки Почтой России и компаний курьерской доставки:
`cashPaymentAvailable`	boolean	Доступна ли оплата наличными при получении.
`cardPaymentAvailable`	boolean	Доступна ли оплата картой при получении.
`priceDelivery`	number	Чистая стоимость доставки.
`totalPrice`	number	Итоговая стоимость доставки, включающая в себя стоимость доп. услуг и комиссии.
Только для компаний курьерской доставки:
`isExpress`	boolean	Является ли данная доставка экспресс-доставкой.
`timeSelectAvailable`	boolean	Доступен ли выбор даты и времени доставки.
Только для компаний, доставляющих в пункт выдачи:
`points`	array	Массив точек самовывоза.

Параметр	Тип	Описание
`id`	number	ID точки самовывоза.
`name`	string	Название.
`longitude`	string	Долгота.
`latitude`	string	Широта.
`type`	number	Тип ПВЗ.
`description`	string \| null	Описание как пройти к ПВЗ.
`address`	string	Адрес.
`schedule`	array \| null	График работы. Массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`. Формат времени – `HH:MM`.
`metro`	array \| null	Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями: `name` – название станции; `line` – название линии метро; `distance` – расстояние в км.
`district`	string \| null	Район города.
`photos`	array \| null	Массив URL фотографий ПВЗ.
`fittingAvailable`	boolean	Доступна ли услуга “Примерка”.
`checkupAvailable`	boolean	Доступна ли услуга “Осмотр вложения”.
`partialBuyoutAvailable`	boolean	Доступна ли услуга “Частичная выдача”.
`cashPaymentAvailable`	boolean	Доступна ли оплата наличными при получении.
`cardPaymentAvailable`	boolean	Доступна ли оплата картой при получении.
`union`	string	Точки, расположенные на карте слишком близко друг к другу, либо имеющие один и тот же адрес, имеют одинаковые значения данного параметра, что помогает выводить их на карте в виде единого маркера.
`deliveryCompanyId`	number	ID компании доставки.
`deliveryCompanyName`	string	Название компании доставки.
`deliveryDriver`	string	Внутреннее название драйвера компании доставки.
`deliveryDays.min`	number	Минимальный срок доставки в днях.
`deliveryDays.max`	number	Максимальный срок доставки в днях.
`deliveryDate.from`	string	Минимальная дата доставки.
`deliveryDate.to`	string	Максимальная дата доставки.
`deliveryHoldDays`	number	Количество дней, которое заказ будет храниться на ПВЗ.
`priceCommissionCod`	number	Комиссия наложенного платежа наличными в рублях.
`priceDelivery`	number	Чистая стоимость доставки для конкретного ПВЗ.
`totalPrice`	number	Итоговая стоимость доставки для конкретного ПВЗ, включающая в себя стоимость доп. услуг и комиссии.
`isFar`	boolean	Содержит `true` в случаях, когда данный ПВЗ находится не в населённом пункте, который был передан при запросе в калькулятор, а в ближайшем к нему. Такие ПВЗ выводятся, если в запрашиваемом населённом пункте нет ПВЗ.
`zipCode`	string \| null	Почтовый индекс.

Параметр	Тип	Описание
`id`	number	ID услуги.
`name`	string	Название услуги.
`price`	number	Стоимость услуги в рублях.
`checked`	boolean	Является ли данная услуга “выбранной” по умолчанию. Стоимость услуг, у которых этот параметр равен `true`, уже содержится в общей сумме `totalPrice`. Если необходимо получить стоимость доставки без такой услуги, вычтите её стоимость из `totalPrice`. Стоимость услуг со значением `false` не включена в `totalPrice`. Прибавьте их стоимость к `totalPrice`, чтобы получить стоимость доставки с нужными услугами.
`required`	boolean	Является ли данная услуга обязательной. Стоимость обязательных услуг содержится в общей сумме `totalPrice`. Создать заказ без этих услуг нельзя – если их ID не передать при создании заказа, заказ всё равно будет оформлен с ними.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Нет	ID магазина. Если не передан, в запросе требуется задать адрес отправителя в параметре `sender`, а также тип забора в параметре `pickupType`.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`reception.countryCode`	—	string	Код страны получателя. По умолчанию `'RU'`.
`reception.cityFias`	—	string	ФИАС населённого пункта получателя.
`reception.cityName`	—	string	Название населённого пункта получателя.
`reception.cityType`	—	string	Тип населённого пункта (`'г'`, `'д'`, `'пос'` и т.п.) получателя.
`reception.zipCode`	—	string	Почтовый индекс населённого пункта получателя.
`reception.region`	—	string	Регион получателя.
`reception.area`	—	string	Район в регионе получателя.
`reception.street`	—	string	Улица получателя.
`reception.house`	—	string	Дом получателя.
`reception.bulk`	—	string	Корпус получателя.
`reception.flat`	—	string	Квартира получателя.
`sender.countryCode`	—	string	Код страны получателя. По умолчанию `'RU'`.
`sender.cityFias`	—	string	ФИАС населённого пункта отправителя.
`sender.cityName`	—	string	Название населённого пункта отправителя.
`sender.cityType`	—	string	Тип населённого пункта (`'г'`, `'д'`, `'пос'` и т.п.) отправителя.
`sender.zipCode`	—	string	Почтовый индекс населённого пункта отправителя.
`sender.region`	—	string	Регион отправителя.
`sender.area`	—	string	Район в регионе отправителя.
`sender.street`	—	string	Улица отправителя.
`sender.house`	—	string	Дом отправителя.
`sender.bulk`	—	string	Корпус отправителя.
`sender.flat`	—	string	Квартира отправителя.
`pickupType`	—	number `1`, `4`	Тип забора. Требуется передавать только если не был задан магазин через заголовок `Shop-Id`.
`products`	—	array	Товары заказа. Передаются в виде объектов со следующими полями (все параметры передаются за единицу товара): `vendorCode` – артикул; `priceDeclared` – оценочная стоимость в рублях; `priceCod` – наложенный платёж в рублях; `discount` – скидка в рублях; `dimensions.width` – ширина в см; `dimensions.height` – высота в см; `dimensions.length` – длина в см; `volume` – объём в м³; `weight` – вес в кг; `count` – количество товара.
`kits`	—	array	Комплекты товаров заказа. Передаются в виде объектов со следующими полями: `vendorCode` – артикул комплекта; `price` – стоимость комплекта (если передана, переопределяет стоимость товаров в комплекте, распределяясь поровну между всеми товарами комплекта); `count` – количество комплектов.
`priceDeclared`	—	number	Оценочная стоимость.
`priceCod`	—	number	Наложенный платёж.
`priceClient`	—	number	Стоимость доставки с клиента. Комиссия взимается как с наложенного платежа.
`pricePrePayClient`	—	number	Стоимость предоплаты за доставку с клиента. Влияет на комиссию эквайринга.
`discount`	—	number	Общая скидка на заказ (в рублях).
`marketplace.id`	—	number \| null	ID маркетплейса.
`marketplace.warehouseId`	—	number \| null	ID склада маркетплейса.
`marketplace.fbo`	—	boolean	Тип отгрузки FBO (продажа со склада маркетплейса).
`marketplace.fbs`	—	boolean	Тип отгрузки FBS (продажа со склада продавца).
`services`	—	array	ID дополнительных услуг, которые необходимо вывести в данные транспортных компаний (свойство `services` в ответе). Стоимость этих услуг не будет добавлена в общую стоимость доставки `totalPrice`.
`servicesRequired`	—	array	Обязательные дополнительные услуги. Компании, не поддерживающие эти услуги, не будут включены в список результатов. Стоимость этих услуг добавляется в общую стоимость доставки `totalPrice`.
`type`	—	number	Фильтр по типу доставки. Если передан, калькулятор вернёт только доставку указанного типа.
`companyIds`	—	array	Фильтр по компаниям доставки, позволяющий посчитать только отдельные компании. Передаётся в виде массива ID требуемых компаний.
`onlyCheap`	—	boolean	Вывод только вариантов доставки с самой низкой ценой. По умолчанию `false`.
`calcDeclared`	—	boolean	Учёт переданной оценочной стоимости (`priceDeclared`) товаров. По умолчанию `true`.
`calcCod`	—	boolean	Учёт переданного наложенного платежа (`priceCod`) товаров. По умолчанию `true`.
`hidePointFullInfo`	—	boolean	Если передано `true`, массив `points` вместо объектов с полными данными будет содержать только ID ПВЗ.
`applyWidgetSettings`	—	boolean	Применять ли настройки и правила виджетов. По умолчанию `false`.
`applyDefaultDimensions`	—	boolean	Использовать ли габариты из настроек виджетов в качестве габаритов по умолчанию. По умолчанию `false`. При использовании `applyWidgetSettings` опция не имеет смысла, т.к. с `applyWidgetSettings` габариты из настроек виджетов так же будут применяться как габариты по умолчанию.
`timeout`	—	number	Время ожидания ответа от серверов транспортных компаний (в миллисекундах). Компании, данные от которых не были получены за указанное время, не попадут в выдачу. По умолчанию 20 000 мс.
Габариты по местам:
`places`	—	array	Места. Передаются в виде объектов со следующими полями: `dimensions.width` – ширина коробки в см; `dimensions.height` – высота коробки в см; `dimensions.length` – длина коробки в см; `weight` – вес коробки в кг; `count` – количество коробок.
Общие габариты:
`weight`	—	number	Общий вес заказа в кг.
`dimensions.width`	—	number	Общая ширина заказа в см.
`dimensions.height`	—	number	Общая высота заказа в см.
`dimensions.length`	—	number	Общая длина заказа в см.
`itemCount`	—	number	Общее количество мест. По умолчанию 1.
`volume`	—	number	Общий объём в м³.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Да	ID магазина.
`Type`	Да	Тип доставки.
`Company-Id`	Да	ID компании, доставку которой нужно посчитать.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Да	ID магазина.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
type	—	number	Тип доставки. Если передан, будут получены только доставки указанного типа.
reception.cityFias	—	string	ФИАС населённого пункта.
reception.zipCode	—	string	Почтовый индекс населённого пункта.
reception.cityName	—	string	Название населённого пункта.
reception.countryCode	—	string	Код страны.
reception.addressString	—	string	Адрес доставки одной строкой (страна, тип и название населённого пункта).
applyWidgetSettings	—	boolean	Если передано `true`, при определении списка доступных компаний будут применяться настройки и правила виджетов.

¶ Описание моделей данных.

¶ Модель компании доставки `DeliveryCompany`.

¶ Модель точки самовывоза `PickupPoint`.

¶ Модель дополнительной услуги `DeliveryService`.

¶ Расчёт стоимости доставки.

¶ Расчёт стоимости доставки для отдельной транспортной компании.

¶ Получение списка ID транспортных компаний, доставка которыми доступна в выбранный населённый пункт.

¶ Описание моделей данных.

¶ Модель компании доставки DeliveryCompany.

¶ Модель точки самовывоза PickupPoint.

¶ Модель дополнительной услуги DeliveryService.

¶ Расчёт стоимости доставки.

¶ Расчёт стоимости доставки для отдельной транспортной компании.

¶ Получение списка ID транспортных компаний, доставка которыми доступна в выбранный населённый пункт.

¶ Модель компании доставки `DeliveryCompany`.

¶ Модель точки самовывоза `PickupPoint`.

¶ Модель дополнительной услуги `DeliveryService`.