Расчет стоимости доставки #
Адрес метода #
Параметры запроса #
Раздел | Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|---|
weight | Вес всего заказа (в граммах) | число | да | 1500 | |
width | Ширина заказа (в сантиметрах) | число | да | 25 | |
height | Высота заказа (в сантиметрах) | число | да | 20 | |
length | Высота заказа (в сантиметрах) | число | да | 30 | |
assessedCost | Оценочная стоимость (в рублях) | число | да | 100.6 | |
pickupDate | Дата приёма груза (не обязательно, по умолчания берется текущая дата) | строка | нет | 2021-01-27 | |
pickupTypes | Типы забора (см. /lists/pickupTypes), если не переданы берутся оба типа | массив чисел | нет | 1 | |
deliveryTypes | Типы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типа | массив чисел | нет | 1 | |
codCost | Cумма наложенного платежа | число | нет | 0 | |
includeFees | Суммировать ли к итоговой стоимости все сборы СД (страховка и комиссия за НП) | булев(логический) | нет | false | |
providerKeys | Массив ключей служб доставки (не обязательно) | массив строк | нет | dpd | |
timeout | Время (миллисекунды) ожидания ответа от провайдера, результаты по провайдерам которые не успели в указанное время выдаваться не будут. Если не указывать будет ожидаться ответ от всех. | число | нет | 2000 | |
skipTariffRules | Пропускает применение правил редактора тарифов. Полезно, если надо проверить корректность применения правил | булев(логический) | нет | false | |
promoCode | Промокод. В редакторе тарифов можно указать промокод, по которому можно изменять тарифы, например, скидку на стоимотсь доставки. | строка | нет | SALE10 | |
customCode | Используется для идентификации ИМ. В редакторе тарифов можно указать customCode, по которому можно создавать условия на отдельный ИМ, если используется несколько ИМ в одном аккаунте ApiShip. | строка | нет | 145900 | |
places | |||||
width | Ширина единицы товара в сантиметрах | число | да | 1200 | |
height | Высота единицы товара в сантиметрах | число | да | 40 | |
length | Длина единицы товара в сантиметрах | число | да | 30 | |
weight | Вес единицы товара в граммах | число | да | 25 | |
extraParams | |||||
dpd.providerConnectId | ID подключения провайдера, по которому нужно произвести рассчет. | число | нет | 1234 | |
from | |||||
cityGuid | ID города в базе ФИАС | строка | нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
region | Регион | строка | нет | Москва | |
city | Название города | строка | нет | Москва | |
countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | строка | нет | RU | |
addressString | Полный адрес отправителя для вычисления координат lat lng | строка | нет | Москва, Хлебный пер. 19А | |
lat | Широта отправителя | число | нет | 55.755297 | |
lng | Долгота отправителя | число | нет | 37.593740 | |
index | Почтовый индекс | число | нет | 344000 | |
to | |||||
cityGuid | ID города в базе ФИАС | строка | нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
region | Регион | строка | нет | Москва | |
city | Название города | строка | нет | Москва | |
countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | строка | нет | RU | |
addressString | Полный адрес получателя для вычисления координат lat lng | строка | нет | Москва, ул. Машкова 21 | |
lat | Широта получателя | число | нет | 55.764683 | |
lng | Долгота получателя | число | нет | 37.653810 | |
index | Почтовый индекс | число | нет | 344000 |
Заполнение поля cityGuid обязательно, если не заполнено поле city и наоборот.
Заполнение поля addressString обязательно, если не заполнены другие обязательные поля адреса (countryCode, city, region, street, index).
В случае заполнения addressString - адрес будет разобран на составляющие и будут использоваться данные полученные в следствии разбора строки addressString.
При необходимости есть возможность добавление нескольких мест places для расчета доставки.
Пример запроса #
|
|
|
|
Параметры ответа #
Раздел | Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|---|
deliveryToDoor | |||||
providerKey | Название СД | строка | нет | cdek | |
tariffProviderId | ID тарифа | строка | нет | 11 | |
tariffName | Название тарифа | строка | нет | Экспресс лайт склад-дверь | |
pickupTypes | Типы забора (см. /lists/pickupTypes), если не переданы берутся оба типа , | массив чисел | нет | 2 | |
deliveryTypes | Типы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типа | массив чисел | нет | 1 | |
deliveryCost | Стоимость доставки | число | нет | 370 | |
deliveryCostOriginal | Стоимость тарифа до применения правил | число | нет | 450 | |
feesIncluded | Были ли включены сборы СД в общую стоимость(deliveryCost). NULL если невозможно определить | булев | нет | false | |
insuranceFee | Сумма страховых сборов. NULL если невозможно определить | число | нет | 0 | |
cashServiceFee | Сумма сборов за НП. NULL если невозможно определить | число | нет | 0 | |
daysMax | Максимальное количество дней на осуществление доставки. | число | нет | 3 | |
daysMin | Минимальное количество дней на осуществление доставки. | число | нет | 2 | |
tariffId | ID тарифа | число | нет | 19 | |
deliveryToPoint | |||||
providerKey | Название СД | строка | нет | cdek | |
tariffProviderId | ID тарифа | строка | нет | 11 | |
tariffName | Название тарифа | строка | нет | Экспресс лайт склад-склад | |
pickupTypes | Типы забора (см. /lists/pickupTypes), если не переданы берутся оба типа , | массив чисел | нет | 2 | |
deliveryTypes | Типы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типа | массив чисел | нет | 1 | |
deliveryCost | Стоимость доставки | число | нет | 370 | |
deliveryCostOriginal | Стоимость тарифа до применения правил | число | нет | 450 | |
feesIncluded | Были ли включены сборы СД в общую стоимость(deliveryCost). NULL если невозможно определить | булев | нет | false | |
insuranceFee | Сумма страховых сборов. NULL если невозможно определить | число | нет | 0 | |
cashServiceFee | Сумма сборов за наложенный платёж. NULL если невозможно определить | число | нет | 0 | |
daysMax | Максимальное количество дней на осуществление доставки. | число | нет | 3 | |
daysMin | Минимальное количество дней на осуществление доставки. | число | нет | 2 | |
tariffId | ID тарифа | число | нет | 19 | |
pointIds | Массив идентификаторов доступных ПВЗ для каждого из тарифов | массив чисел | нет | 234 |
Пример данных ответа #
|
|
|
|