Расчет стоимости доставки #
Адрес метода #
Параметры запроса #
| Раздел | Параметр | Описание | Тип | Обязательный | Пример |
|---|---|---|---|---|---|
| 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 | |
| pointInId | ID пункта приема заказов из метода /lists/points (если нужно указать конкретный пункт отгрузки на склад службы доставки) | число | нет | 63035 | |
| pointOutId | ID пункта выдачи заказов из метода /lists/points (если нужно указать конкретный пункт доставки до ПВЗ) | число | нет | 140803 | |
| tariffIds | Тарифы служб доставок по которым будет осуществляться расчет | массив чисел | нет | 53 | |
| places | |||||
| width | Ширина единицы товара в сантиметрах | число | да | 1200 | |
| height | Высота единицы товара в сантиметрах | число | да | 40 | |
| length | Длина единицы товара в сантиметрах | число | да | 30 | |
| weight | Вес единицы товара в граммах | число | да | 25 | |
| extraParams | |||||
| dpd.providerConnectId | ID подключения провайдера, по которому нужно произвести расчет. | число | нет | 1234 | |
| from | да | ||||
| cityGuid | ID города в базе ФИАС | строка | да, если не указан city или addressString | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| region | Регион | строка | нет | Москва | |
| city | Название города | строка | да, если не указан cityGuid или addressString | Москва | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | строка | да | RU | |
| addressString | Полный адрес отправителя для вычисления координат lat lng | строка | да (если не указаны cityGuid и city) | Москва, Хлебный пер. 19А | |
| lat | Широта отправителя | число | нет | 55.755297 | |
| lng | Долгота отправителя | число | нет | 37.593740 | |
| index | Почтовый индекс | число | нет | 344000 | |
| to | да | ||||
| cityGuid | ID города в базе ФИАС | строка | да, если не указан city или addressString | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| region | Регион | строка | нет | Москва | |
| city | Название города | строка | да, если не указан cityGuid или addressString | Москва | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | строка | да | RU | |
| addressString | Полный адрес получателя для вычисления координат lat lng | строка | да (если не указаны cityGuid и city) | Москва, ул. Машкова 21 | |
| lat | Широта получателя | число | нет | 55.764683 | |
| lng | Долгота получателя | число | нет | 37.653810 | |
| index | Почтовый индекс | число | нет | 344000 |
В поля pointInId и pointOutId можно указать только один ID пункта приема/выдачи заказа. Указанный ID должен соответствовать указанной службе доставке. Если в запросе передать codCost > 0 и доставка предполагается до ПВЗ, то нужно убедиться, что точка переданная в pointOutId поддерживает наложенный платеж (cod=1).
Значение поля tariffIds позволяет произвести калькуляцию по указанным тарифам. Например, если передать по тарифу от cdek (54) и boxberry (44): “tariffIds”: [44, 54], то в ответе будут отображены только указанные тарифы и только если по ним есть расчет от СД.
Дополнительные параметры extraParams. К примеру, можно рассчитать DPD по какому-то определенному подключению (договору), передав dpd.providerConnectId = id из /connections/getListConnections
Заполнение поля 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 | |
| (Устарело) Максимальное количество дней на осуществление доставки. | число | нет | 3 | ||
| (Устарело) Минимальное количество дней на осуществление доставки. | число | нет | 2 | ||
| workDaysMax | Максимальное количество рабочих дней на осуществление доставки. | число | нет | 3 | |
| workDaysMin | Минимальное количество рабочих дней на осуществление доставки. | число | нет | 2 | |
| calendarDaysMax | Максимальное количество календарных дней на осуществление доставки. | число | нет | 3 | |
| calendarDaysMin | Минимальное количество календарных дней на осуществление доставки. | число | нет | 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 | |
| (Устарело) Максимальное количество дней на осуществление доставки. | число | нет | 3 | ||
| (Устарело) Минимальное количество дней на осуществление доставки. | число | нет | 2 | ||
| workDaysMax | Максимальное количество рабочих дней на осуществление доставки. | число | нет | 3 | |
| workDaysMin | Минимальное количество рабочих дней на осуществление доставки. | число | нет | 2 | |
| calendarDaysMax | Максимальное количество календарных дней на осуществление доставки. | число | нет | 3 | |
| calendarDaysMin | Минимальное количество календарных дней на осуществление доставки. | число | нет | 2 | |
| tariffId | ID тарифа | число | нет | 19 | |
| pointIds | Массив идентификаторов доступных ПВЗ для каждого из тарифов | массив чисел | нет | 234 |
Пример данных ответа #
| |
| |