API

Функция /2.0/order/calculate

Назначение: Расчет стоимости.

Поля запроса:

Параметр	Описание	Тип	Обязательный	Пример
city_pickup_code	Код города откуда	строка	Да	660000100000
city_delivery_code	Код города куда	строка	Да	770000000000
declared_price	Объявленная стоимость груза (руб)	integer	Да	100
confirmation_price	Наличие документов подтверждающих стоимость	boolean	Да (если declared_price более 50 000), по умолчанию 0	1
customer	Заказчик	debitor integer(10)	Нет	customer[debitor] = 0000000000
sender	Отправитель	debitor integer(10)	Нет	sender[debitor] = 0000000000
receiver	Получатель	debitor integer(10)	Нет	receiver[debitor] = 0000000000
type	Тип перевозки	строка	Да по умолчанию 01	XS
service	массив кодов услуг	массив кодов услугв в составе places	Нет	places[0]service[0] = T001 places[0]service[1] = S026
height	Высота груза (см) позиции	decimal(10,2)	Да (если не указан volume)	places[0][height] = 100 places[1][height] = 120
width	Ширина груза (см) позиции	decimal(10,2)	Да (если не указан volume)	places[0][width] = 100 places[1][width] = 120
length	Длина груза (см) позиции	decimal(10,2)	Да (если не указан volume)	places[0][length] = 100 places[1][length] = 120
volume	Объем М³ позиции	массив decimal(10,3)	Да (если не указаны height, width, length)	places[1][volume] = 1 places[0][volume] = 2
pick_up	Забор груза по городу	integer( 1 - да 0 - нет )	Нет по умолчанию 0	1
delivery	Доставка груза по городу	integer( 1 - да 0 - нет )	Нет по умолчанию 0	1
have_doc	Есть документы подтверждающие стоимость груза	integer( 1 - да 0 - нет )	Да (если стоимость груза равна или более 50 000 руб. )	1
cargo_type_code	Код характера груза	строка	Нет (по умолчанию 03)	01
currency_code	Валюта результата расчета	массив строка	Нет (по умолчанию RUB)	currency_code[0] = KZT currency_code[1] = RUB
all_places_same	Все места одинаковы по размеру	boolean	Нет (по умолчанию 0)	1

Описание типа debitor

Параметр	Описание	Тип	Обязательный	Пример
debitor	Номер дебитора	integer(10)	Да (если не указаны другие данные дебитора) Если совсем не указан customer[debitor] или другие параметры customer, то заказчиком автоматически будет указан владелец личного кабинета.	customer[debitor] = 0001011311 sender[debitor] = 0001011311 receiver[debitor] = 0001011311
debitor_type	Код города откуда	integer (1 - физик 2 - ип 3 - юрик)	Да (если не указан debitor)	customer[debitor_type] = 1 sender[debitor_type] = 1 receiver[debitor_type] = 1
country_code	Код страны	string	Да (если не указан debitor и debitor_type = 1)	customer[country_code] = RU sender[country_code] = RU receiver[country_code] = RU
real_country	Страна (Физическое лицо)	string	Да (если не указан debitor и debitor_type = 1)	customer[real_country] = RU sender[real_country] = KZ receiver[real_country] = AM
real_city	Город (Физическое лицо)	string	Да (если не указан debitor и debitor_type = 1)	customer[real_city] = Екатеринбург sender[real_city] = Екатеринбург receiver[real_city] = Екатеринбург
real_street	Улица (Физическое лицо)	string	Да (если не указан debitor и debitor_type = 1)	customer[real_street] = Екатеринбург sender[real_street] = Екатеринбург receiver[real_street] = Екатеринбург
real_house	Дом (Физическое лицо)	string	Да (если не указан debitor и debitor_type = 1)	customer[real_house] = 12 sender[real_house] = 12 receiver[real_house] = 12
real_supp	Корпус (Физическое лицо)	string	Нет	customer[real_supp] = Б sender[real_supp] = Б receiver[real_supp] = Б
real_room	Кв\Офис (Физическое лицо)	string	Нет	customer[real_room] = 147 sender[real_room] = 147 receiver[real_room] = 147
real_contact_name	ФИО (Физическое лицо)	string	Да (если не указан debitor и debitor_type = 1)	customer[real_contact_name] = Иванов Иван Иванович sender[real_contact_name] = Иванов Иван Иванович receiver[real_contact_name] = Иванов Иван Иванович
real_contact_phone	Номер телефона (Физическое лицо)	number	Да (если не указан debitor и debitor_type = 1)	customer[real_contact_phone] = 88002345650 sender[real_contact_phone] = 88002345650 receiver[real_contact_phone] = 88002345650
name_ip	ФИО контактного лица (ИП)	string	Да (если не указан debitor и debitor_type = 2)	customer[name_ip] = Иванов Иван Иванович sender[name_ip] = Иванов Иван Иванович receiver[name_ip] = Иванов Иван Иванович
organization_name_ip	ФИО (ИП)	string	Да (если не указан debitor и debitor_type = 2)	customer[organization_name_ip] = Иванов Иван Иванович sender[organization_name_ip] = Иванов Иван Иванович receiver[organization_name_ip] = Иванов Иван Иванович
organization_phone_ip	Номер телефона (ИП)	number	Да (если не указан debitor и debitor_type = 2)	customer[organization_phone_ip] = 88002345650 sender[organization_phone_ip] = 88002345650 receiver[organization_phone_ip] = 88002345650
phone_ip	Телефон контактного лица (ИП)	number	Да (если не указан debitor и debitor_type = 2)	customer[phone_ip] = 88002345650 sender[phone_ip] = 88002345650 receiver[phone_ip] = 88002345650
inn_ip	ИНН (ИП)	integer	Да (если не указан debitor и debitor_type = 2)	customer[inn_ip] = 123456789123 sender[inn_ip] = 123456789123 receiver[inn_ip] = 123456789123
unp_ip	УНП (ИП)	integer	Да (если не указан debitor и debitor_type = 2 и country_code = BY)	customer[unp_ip] = 123456789 sender[unp_ip] = 123456789 receiver[unp_ip] = 123456789
legal_country	Страна (ИП или Юр.лицо)	string	Да (если не указан debitor и debitor_type = 2 или debitor_type = 3)	customer[legal_country] = RU sender[legal_country] = KZ receiver[legal_country] = AM
legal_city	Город (ИП или Юр.лицо)	string	Да (если не указан debitor и debitor_type = 2 или debitor_type = 3)	customer[legal_city] = Екатеринбург sender[legal_city] = Екатеринбург receiver[legal_city] = Екатеринбург
legal_street	Улица (ИП или Юр.лицо)	string	Да (если не указан debitor и debitor_type = 2 или debitor_type = 3)	customer[legal_street] = Высоцкого sender[legal_street] = Уральских рабочих receiver[legal_street] = Фестивальная
legal_house	Дом (ИП или Юр.лицо)	string	Да (если не указан debitor и debitor_type = 2 или debitor_type = 3)	customer[legal_house] = 147 sender[legal_house] = 147 receiver[legal_house] = 147
legal_supp	Корпус (ИП или Юр.лицо)	string	Нет	customer[legal_supp] = Б sender[legal_supp] = Б receiver[legal_supp] = Б
legal_room	Кв\Офис (ИП или Юр.лицо)	string	Нет	customer[legal_room] = 12 sender[legal_room] = 12 receiver[legal_room] = 12
iin	ИИН	integer(12)	Да (если не указан debitor и debitor_type = 2 и country_code = KZ)	customer[iin] = 123456789123 sender[iin] = 123456789123 receiver[iin] = 123456789123
kpp	КПП	integer(9)	Да (если не указан debitor и debitor_type = 3 и country_code = RU)	customer[kpp] = 123456789 sender[kpp] = 123456789 receiver[kpp] = 123456789
name_ur	ФИО контактного лица (Юридическое лицо)	string	Да (если не указан debitor и debitor_type = 3)	customer[name_ur] = Иванов Иван Иванович sender[name_ur] = Иванов Иван Иванович receiver[name_ur] = Иванов Иван Иванович
organization_name_ur	Наименование организации	string	Да (если не указан debitor и debitor_type = 3)	customer[organization_name_ur] = ООО "Кашалот" sender[organization_name_ur] = ООО "Кашалот" receiver[organization_name_ur] = ООО "Кашалот"
organization_phone_ur	Телефон организации	number	Да (если не указан debitor и debitor_type = 3)	customer[organization_phone_ur] = 88002345650 sender[organization_phone_ur] = 88002345650 receiver[organization_phone_ur] = 88002345650
phone_ur	ФИО контактного лица (Юридическое лицо)	number	Да (если не указан debitor и debitor_type = 3)	customer[phone_ur] = 88002345650 sender[phone_ur] = 88002345650 receiver[phone_ur] = 88002345650
unp_ur	УНП (Юридическое лицо)	integer	Да (если не указан debitor и debitor_type = 3 и country_code = BY)	customer[unp_ur] = 123456789 sender[unp_ur] = 123456789 receiver[unp_ur] = 123456789
inn_ur	ИНН (Юридический лицо)	integer	Да (если не указан debitor и debitor_type = 3)	customer[inn_ur] = 123456789 sender[inn_ur] = 123456789 receiver[inn_ur] = 123456789
bin	БИН	integer(12)	Да (если не указан debitor и debitor_type = 3 и country_code = KZ)	customer[bin] = 123456789112 sender[bin] = 123456789112 receiver[bin] = 123456789112

Поля ответа:

Параметры ответа массив типа calculateResult где ключом элемента является тип перевозки например XS

Описание типа calculateResult:

Параметр	Описание	Тип
01	Стандарт	calculateResultType
03	Экспресс	calculateResultType
XS	Посылка XS	calculateResultType
S	Посылка S	calculateResultType
M	Посылка M	calculateResultType
L	Посылка L	calculateResultType
TS	Шина S (13-14)	calculateResultType
TM	Шина M (15-16)	calculateResultType
TL	Шина L (17-18)	calculateResultType

Описание типа calculateResultType:

Параметр	Описание	Тип	Пример
name	Название типа перевозки	строка	Стандарт
cost	Общая стоимость перевозки	integer	149070
time	Срок доставки в днях	integer	5
currency_code	Код валюты	строка	KZT
detail	Детализация стоимости	calculateService

Описание типа calculateService:

Параметр	Описание	Тип	Пример
name	Название услуги	строка	Доставка груза
code	Код услуги	строка	S002
price	Стоимость услуги	integer	3850

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

{
    "city_pickup_code": "660000100000",
    "city_delivery_code": "770000000000",
    "declared_price": 100,
    "sender": {
        "debitor": "0001011311"
    },
    "receiver": {
        "debitor": "0001011311"
    },
    "customer": {
        "debitor": "0001011311"
    },
    "type": "01",
    "places": [
        {
            "count_place": 1,
            "height": 100,
            "width": 100,
            "length": 100,
            "weight": 100,
            "service": [
                "S026",
                "T001"
            ]
        },
        {
            "count_place": 4,
            "weight": 10,
            "volume": 4
        }
    ]
}

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

[
    {
        "01": {
            "cost": 23348,
            "name": "Стандарт",
            "time": 6,
            "detail": [
                {
                    "code": "S039",
                    "name": "Груз",
                    "price": 21078
                },
                {
                    "code": "S026",
                    "name": "Мешок S",
                    "price": 60
                },
                {
                    "code": "S025",
                    "name": "ЗТТ (деревянная обрешетка)",
                    "price": 2100
                },
                {
                    "code": "S087",
                    "name": "Упаковка в секьюрити пак",
                    "price": 50
                },
                {
                    "code": "S103",
                    "name": "Возмещение страхования груза по объяв.ст",
                    "price": 60
                },
                {
                    "code": "S118",
                    "name": "Перевозка Екатеринбург-Сургут(Стандарт)",
                    "price": 0
                }
            ],
            "messages_log": [],
            "currency_code": "RUB"
        }
    }
]

API-интеграция