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

Функция /1.0/order/create
Назначение: Оформление заказа
Поля запроса:
ПараметрОписаниеТипОбязательныйПример
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
cargo_type_codeКод характера грузаstringНет (по умолчанию 03)01
declared_priceОбъявленная стоимость груза (руб)integerДа1000
confirmation_priceНаличие документов подтверждающих стоимостьboolean

Да (если declared_price более 50 000),

по умолчанию 0

1
serviceмассив кодов услугstringНетservice[0] = T001
service[1] = 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
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Нет

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 - физик
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

 

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

ПараметрОписаниеТип
01Счет-фактураstring (2)
02CHTstring (2)
03Накладнаяstring (2)
04УПДstring (2)
09TTHstring (2)
10ТОРГ12string (2)
15Договорstring (2)
16Заверение о наличии СНТstring (2)

Поля ответа:
ПараметрОписаниеТипПример
statusСтатус операции (1 успешно завершена, 0 - произошла ошибка)integer1
resultРезультатresult 
messageСообщениеstringСпасибо. Скоро с Вами свяжется наш оператор.

 

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

ПараметрОписаниеТипПример
sale_numberНомер заказаinteger(10)1105872363
cargo_numberНомер грузаstringАМТИРК0015786923

Пример запроса:
{
    "city_pickup_code": "660000100000",
    "city_delivery_code": "000000000001",
    "declared_price": 100,
    "sender": {
        "debitor": "000XXXXXXX"
    },
    "receiver": {
        "debitor": "000XXXXXXX"
    },
    "customer": {
        "debitor": "000XXXXXXX"
    },
    "service[0]": "T001",
    "service[1]": "S026",
    "currency_code[0]": "KZT",
    "currency_code[1]": "RUB",
    "places": [
        {
            "count_place": 2,
            "height": 100,
            "width": 100,
            "length": 100,
            "weight": 100
        },
        {
            "count_place": 4,
            "weight": 200,
            "volume": 4
        }
    ],
    "insurance": 1,
    "insurance_agent_code": 8000152423
}
Пример ответа:
{
    "result": {
        "sale_number": 1105872363,
        "cargo_number": "АМТИРК0015786923"
    },
    "status": 1,
    "message": "Спасибо. Скоро с Вами свяжется наш оператор."
}