Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|
city_pickup_code | Код города откуда | string | Да | 660000100000 |
city_delivery_code | Код города куда | string | Да | 000000000001 |
pickpoint_address_code | Код терминала получения | string | Нет | 2301 |
customer | Заказчик | debitor | Да | |
sender | Отправитель | debitor | Да | |
receiver | Получатель | debitor | Да | |
type | Вид перевозки | integer( 1 - Стандарт 3 - Экспресс ) | да | 01 |
declared_price | Объявленная стоимость груза (руб) | integer | Да | 1000 |
confirmation_price | Наличие документов подтверждающих стоимость | boolean | Да (если declared_price более 50 000), по умолчанию 0 | 1 |
inner_track_number | Внутренний трек-номер груза | string | Нет | TN0123456789 |
service | массив кодов услуг | string | Нет | places[0][service] = T001 places[1][service] = S026 |
height | Высота груза (см) позиции | decimal(10,2) | Да | places[0][height] = 100 places[1][height] = 120 |
width | Ширина груза (см) позиции | decimal(10,2) | Да | places[0][width] = 100 places[1][width] = 120 |
length | Длина груза (см) позиции | decimal(10,2) | Да | places[0][length] = 100 places[1][length] = 120
|
count_place | Количество мест в позиции | массив integer | Да | places[0][count_place] = 1 places[1][count_place] = 2 |
weight | Масса КГ позиции | массив integer | Да | places[0][weight] = 2 places[1][weight] = 4 |
volume | Объем М³ позиции | массив decimal(10,3) | Да | places[1][volume] = 1 places[0][volume] = 2 |
cargo_type_code | Код характера груза (перечень /1.0/order/cargo-type/get-list) | string | Да | places[1][cargo_type_code] = "Z11" places[0][cargo_type_code] = "Z01" |
pick_up | Забор груза | integer( 1 - да 0 - нет ) | Нет | 1 |
pickup_date | Дата забора | дата | Да (если pick_up = 1) | 2018-03-10 |
pickup_time_start | Время начала забора | string | Да (если pick_up = 1) | 12:00 |
pickup_time_end | Время окончания забора | string | Да (если pick_up = 1) | 13:59 |
pickup_comment | Комментарий к забору груза | string (250) | Нет | Предварительно позвонить |
pickup_r | Забор с другого адреса отправителя | integer( 1 - да 0 - нет ) | Нет (по умолчанию 0) | 1 |
pickup_street | Улица другого адреса отправителя | string | Да (если pick_up = 1 и pickup_r = 1) | 8 Марта |
pickup_house | Дом другого адреса отправителя | string | Да (если pick_up = 1 и pickup_r = 1) | 212 |
pickup_supp | Корпус другого адреса отправителя | string | Нет | А |
pickup_room | Офис/кварира другого адреса отправителя | string | Нет | 3 |
deliver | Доставка груза по городу | integer( 1 - да 0 - нет ) | Нет | 1 |
delivery_date | Дата доставки | дата | Да (если deliver = 1) | 2018-03-14 |
delivery_time_start | Время начала доставки | string | Да (если deliver = 1) | 12:00 |
delivery_time_end | Время окончания доставки | string | Да (если deliver = 1) | 14:00 |
delivery_comment | Комментарий к доставке | string (250) | Нет | Предварительно позвонить |
delivery_r | Доставка на другой адрес получателя | integer( 1 - да 0 - нет ) | Нет | 1 |
delivery_street | Улица другого адреса получателя | string | Да (если delivery_r = 1) | 8 Марта |
delivery_house | Дом другого адреса получателя | string | Да (если delivery_r = 1) | 212 |
delivery_supp | Корпус другого адреса получателя | string | Нет | Б |
delivery_room | Офис/кварира другого адреса получателя | string | Нет | 3 |
additional_payment_shipping | Плательщик перевозки | string( AG - заказчик, SE - отправитель, WE - получатель) | Нет (по умолчанию AG) | SE |
additional_payment_pickup | Плательщик забора груза | string( AG - заказчик, SE - отправитель, WE - получатель) | Нет (по умолчанию AG) | SE |
additional_payment_delivery | Плательщик доставки груза | string( AG - заказчик, SE - отправитель, WE - получатель) | Нет (по умолчанию AG) | SE |
insurance | Услуга страхования груза | integer( 1 - да 0 - нет ) | Да (если стоимость груза равна или более 10 000 руб.) | 1 |
insurance_agent_code | Код страхового агента | string | Да (если insurance = 1 ) | 8000152423 |
currency_code | Валюта результата расчета | массив строка | Нет (по умолчанию RUB) | currency_code[0] = KZT currency_code[1] = RUB |
all_places_same | Все места одинаковы по размеру | boolean | Нет (по умолчанию 0) | 1 |
comment | Комментарий | string (250) | Нет | Предварительно позвонить |
document_type | Массив типов документов | document_type | Нет | document_type[0]=01 document_type[1]=01 |
document_number | Массив номеров документов | string (96) | Нет | document_number[0]=XXXXXXXX document_number[1]=XXXXXXXX |
document_date | Массив дат документов | string (Y-m-d) | Нет | document_date[0]=2024-09-02 document_date[1]=2024-09-02 |
document_file | Массив файлов документов | file или строка base64 | Нет | document_file[0]=file.pdf document_file[1]=file.jpg |
Описание типа debitor
Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|
debitor | Номер дебитора | integer(10) | Да (если не указаны другие данные дебитора) Если совсем не указан customer[debitor] или другие параметры customer, то заказчиком автоматически будет указан владелец личного кабинета. | customer[debitor] = 0001011311 sender[debitor] = 0001011311 receiver[debitor] = 0001011311 |
debitor_type | Код города откуда | integer (1 - физик | Да (если не указан 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 |
Параметр | Описание | Тип |
---|---|---|
01 | Счет-фактура | string (2) |
02 | CHT | string (2) |
03 | Накладная | string (2) |
04 | УПД | string (2) |
09 | TTH | string (2) |
10 | ТОРГ12 | string (2) |
15 | Договор | string (2) |
16 | Заверение о наличии СНТ | string (2) |
Параметр | Описание | Тип | Пример |
---|---|---|---|
status | Статус операции (1 успешно завершена, 0 - произошла ошибка) | integer | 1 |
result | Результат | result | |
message | Сообщение | string | Спасибо. Скоро с Вами свяжется наш оператор. |
Описание типа result
Параметр | Описание | Тип | Пример |
---|---|---|---|
sale_number | Номер заказа | integer(10) | 3105877041 |
cargo_number | Номер груза | string | ТЮМРАД0200013090 |
{
"inner_track_number": "",
"city_pickup_code": "720000100000",
"city_delivery_code": "860001500000",
"dispatch_address_code": "",
"document_type": [
"04"
],
"document_number": [
"1"
],
"document_date": [
"2025-07-14"
],
"document_file": [],
"comment": "",
"deliver": "0",
"delivery_comment": "",
"delivery_date": "",
"delivery_time_start": "",
"delivery_time_end": "",
"delivery_r": "0",
"delivery_street": "",
"delivery_house": "",
"delivery_supp": "",
"delivery_room": "",
"real_city": "",
"real_country": "",
"real_street": "",
"real_house": "",
"pick_up": "1",
"pickup_date": "2025-07-14",
"pickup_time_start": "10:00",
"pickup_time_end": "17:00",
"pickup_comment": "",
"pickup_r": "0",
"pickup_street": "",
"pickup_house": "",
"pickup_supp": "",
"pickup_room": "",
"customer": {
"debitor": "000X0XXXXX"
},
"sender": {
"debitor": "000X0XXXXX"
},
"receiver": {
"country_code": "RU",
"debitor_type": "2",
"debitor": "",
"real_contact_name": "",
"real_contact_phone": "",
"real_country": "",
"real_city": "",
"real_street": "",
"real_house": "",
"real_supp": "",
"real_room": "",
"name_ip": "Тест Тест Тест ",
"phone_ip": "79xxxxxxxxx",
"legal_country": "",
"legal_city": "",
"legal_street": "",
"legal_house": "",
"legal_supp": "",
"legal_room": "",
"organization_name_ip": "ИП Тест Тест Тест",
"inn_ip": "X6090XX630X3",
"unp_ip": "",
"iin": "",
"organization_phone_ip": "79xxxxxxxxx",
"name_ur": "",
"phone_ur": "",
"organization_name_ur": "",
"organization_phone_ur": "",
"inn_ur": "",
"kpp": "",
"bin": "",
"unp_ur": ""
},
"type": "01",
"places": [
{
"volume": "0.409",
"weight": "61",
"count_place": "6",
"length": "74.23",
"height": "74.23",
"width": "74.23",
"cargo_type": "Z32",
"places": []
}
],
"declared_price": "100",
"all_places_same": "0",
"confirmation_price": "1",
"service": [],
"insurance": 1,
"insurance_agent_code": "8000152423",
"seal": "0",
"pre_packaging": "0",
"palletizing_transparent": "0",
"palletizing_tint": "0",
"restruct_deliv": "0",
"restruct_pickup": "0",
"palleting": "0",
"additional_payment_shipping": "SE",
"additional_payment_pickup": "SE",
"additional_payment_delivery": "SE",
"additional_payment_shipping_email": "",
"additional_payment_pickup_email": "",
"additional_payment_delivery_email": "",
"pickpoint_address_code": ""
}
{
"result": {
"sale_number": 3105877041,
"cargo_number": "ТЮМРАД0200013090"
},
"status": 1,
"message": "Спасибо. Скоро с Вами свяжется наш оператор."
}