DeliveryCalculation. Новый калькулятор стоимости доставки (РФ/Экспорт из РФ)

Позволяет получить стоимость доставки заказа по направлениям:

Отделение → Отделение / Индекс (для КД РФ) / Город
Город → Город / Отделение / Индекс (для КД РФ)

с учётом стоимости постоянных услуг, предусмотренных Вашим договором.

Метод служит только для расчета стоимости доставки и не осуществляет проверку. В случае передачи, например:

почтового индекса/города по которому не осуществляется КД,
кода пункта выдачи не осуществляющего выдачу посылок,
кода пункта выдачи не существующего в Boxberry,

все или часть услуг не будут рассчитаны и полученная стоимость доставки будет неточной.

Возможность Курьерской доставки определяется по почтовому индексу получателя, поэтому для РФ необходимо проверять индекс методами API ListZips или ZipCheck.

Тип запроса: POST

Формат данных: JSON

Входящие параметры:

Параметр		Тип данных	Обязательно к заполнению	Описание	Пример
token		string	●	Токен для доступа к api-сервисам	d6f33e419c16131e5325cbd84d5d6000
method		string	●	Название метода	DeliveryCalculation
SenderCityId		string	да, если не передан TargetStart нет - во всех иных случаях	Город отправления	68
RecipientCityId		string	Обязательный параметр для расчета доставки в другие страны	Город получения.	7954
DeliveryType		string		Тип доставки, возможные значения: 1 - Доставка до ПВЗ 2 - Курьерская доставка если не заполнено в ответе возвращаются все типы доставки	1
TargetStart		string		Отделение отправления	02617
TargetStop		string		Отделение получения	16681
OrderSum		float		Объявленная стоимость заказа, руб.	777.5
DeliverySum		float		Стоимость доставки объявленная получателю ИМ, руб.	0
PaySum		float		Сумма, которую необходимо взять с получателя, руб.	777.5
Zip		string		Индекс получателя (Передавать только для РФ. Если заказ международный, то индекс не передавать.) *если передан, то в ответе будет вариант для КД
BoxSizes			●	Массив массо-габаритных характеристик для каждого места в заказе
	Width	int		Ширина, см	15
	Height	int		Высота, см	25
	Depth	int		Длина, см	35
	Weight	decimal	●	Вес, гр.	900
UseShopSettings		string		Расчет с учетом настроек установленных в ЛК ИМ: "Настройки средств интеграции - Расчеты - Включить настройки расчета". Возможные значения: 1 - получить расчет с учетом индивидуальных настроек 0 - получить расчет без настроек	0
CmsName		string		название CMS. Параметр предназначен для разработчиков CMS, проводящих интеграцию с Boxberry. Применяется только в JSON. *для учета данного параметра в статистике также должен быть передан параметр url	bitrix wordpress cscart
Url		string		url сайта. Параметр предназначен для разработчиков CMS, проводящих интеграцию с Boxberry. Применяется только в JSON.	site.ru
Version		string		версия интеграции/модуля	2.2

Параметры ответа:

Параметр		Тип данных	Обязательно	Описание	Пример
DeliveryCosts		array	●	Массив вариантов расчетов для разных типов доставки
	PriceService	float	●	Рассчитывается как TotalPrice – PriceBase	323.2
	TotalPrice	float		Стоимость всех начисленных услуг с учетом скидки, Руб В т. ч. расходы на оказание транспортно-экспедиционных услуг, лицензионный платеж за использование программного продукта «BWS. Интернет-магазинам» и вознаграждение экспедитора	538.45
	DeliveryTypeId	int	●	Тип услуги доставки: 1 склад-склад 2 склад-дверь	1
	DeliveryPeriod	int	●	Срок доставки, дни	2
	PriceBase	float	●	Стоимость базовой услуги	215.25

Справочник ошибок:

№	Текст ошибки	Описание ошибки
1	"Необходимо указать Отделение получения или Почтовый индекс"	Параметры target и zip одновременно отсутствуют, переданы пустые или = 0
2	"Некорректный почтовый индекс"	Параметр zip состоит НЕ из 6 цифр И НЕ равен 0
3	"Необходимо указать вес хотя бы одного места"	Параметр weight отсутствует, передан пустой или = 0
4	"Необходимо указать Отделение отправления"	Параметр targetstart не передан, передан пустой или = 0 И В ЛК в разделе «Мой профиль» - «Информация о магазине» не установлен пункт приема для отправлений.
5	"Ошибка авторизации"	Параметр token не передан или не соответствует токену пользователя ЛКИМ
6	"Необходимо указать параметры хотя бы одного места"	Массив BoxSizes отсутствует или передан пустой

Пример запроса

curl 'https://api.boxberry.ru/json.php' --header 'Content-Type: application/json' --data '{
    "token": "d6f33e419c16131e5325cbd84d5d6000",
    "method": "DeliveryCalculation",
    "SenderCityId": "68",
    "RecipientCityId": "16",
    "DeliveryType": "1",
    "TargetStart": "010",
    "TargetStop": "1003",
    "OrderSum": 100.01,
    "DeliverySum": 589.20,
    "PaySum": 1500.99,
    "Zip": "620072",
    "BoxSizes": [
        {
            "Width": 10,
            "Height": 10,
            "Depth": 10,
            "Weight": 1000
        },
        {
            "Width": 20,
            "Height": 20,
            "Depth": 20,
            "Weight": 20000
        }
    ],
    "UseShopSettings": "1",
    "CmsName": "Bitrix",
    "Url": "site.ru",
    "Version": "2.0"
}'

Пример успешного ответа

{
    "error": false,
    "result": {
        "DeliveryCosts": [
            {
                "PriceService": 1186.53,
                "TotalPrice": 250,
                "PriceBase": 1066,
                "DeliveryTypeId": 1,
                "DeliveryPeriod": 3
            }
        ]
    }
}

Пример ответа с ошибкой

{
    "error": true,
    "message": "Некорректный почтовый индекс"
}

Быстрые ссылки

Дерево страниц