Портал для розробників-InternetDocument-save

Створити експрес-накладну

Метод «save», працює в моделі «InternetDocument», цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).

Якщо вибрано тип доставки "CargoType": "Documents", доступні такі параметри ваги: 0,1 або 0,5 або 1. У всіх інших випадках повернеться помилка.

У цьому запиті можливе вказівку зворотної доставки. Достатньо вказати параметр методу «BackwardDeliveryData». Більш детально переглянути різні варіанти зворотної доставки можна у розділі Створити ЕН зі зворотною доставкою.

Можливий варіант створення експрес-накладної з оплатою від "Третьої особи", у такому разі необхідно замінити параметр «PayerType» на:

"PayerType": "ThirdPerson",

"ThirdPerson": "5953fb16-08d8-11e4-8958-0025909b4e33",

Для платника ThirdPerson форма оплати може бути лише "Безготівковий розрахунок"

Після створення інтернет документа в програмному середовищі API, ЕН з'являється у списку ЕН в особистому кабінеті.

Текст запиту

Параметр	Тип	Опис
SenderWarehouseIndex	string[36]	Цифрова адреса відділення відправника
RecipientWarehouseIndex	string[36]	Цифрова адреса відділення одержувача
PayerType*	string[36]	Тип платника (Sender, Recipient, ThirdPerson)
PaymentMethod*	string[36]	Форма розрахунку Cash/NonCash
DateTime*	string[36]	Дата відпраки у форматі дд.мм.рррр
CargoType*	string[36]	Тип вантажу
VolumeGeneral	string[36]	Загальний об'єм, м.куб (min - 0.0004), обов'язково зазначати, якщо не передається параметр OptionsSeat
Weight*	string[36]	Фактична вага, в кг min - 0,1
ServiceType*	string[36]	Технологія доставки DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors
SeatsAmount*	string[36]	Кількість місць відправлення, ціле число
Description*	string[36]	Текстове поле, вводиться для додаткогвого опису відправлення
Cost*	string[36]	Оціночна вартість, ціле число (якщо не зазначити вартість то АРІ автоматично проставить мінімальну оціночну вартість =300.01)
CitySender*	string[36]	Ідентифікатор міста відправника
Sender*	string[36]	Ідентифікатор відправника
SenderAddress*	string[36]	Ідентифікатор адреси відправника. REF адреси брати з відповіді методу Список адрес контрагента
ContactSender*	string[36]	Ідентифікатор контактної особи відправника. REF брати з відповіді методу Список контактних осіб контрагента
SendersPhone*	string[36]	Телефон відправника у форматі: +380660000000, 380660000000, 0660000001
CityRecipient*	string[36]	Ідентифікатор міста отримувача
Recipient*	string[36]	Ідентифікатор отримувача
RecipientAddress*	string[36]	Ідетнифікатор адреси отримувача/Ідентифікатор поштомату
ContactRecipient*	string[36]	Ідентифікатор контактної особи
RecipientsPhone*	string[36]	Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001

* Позначення обов’язкового параметру

                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "InternetDocument",
   "calledMethod": "save",
   "methodProperties": {"SenderWarehouseIndex" : "101/102","RecipientWarehouseIndex" : "101/102","PayerType" : "ThirdPerson","PaymentMethod" : "NonCash","DateTime" : "дд.мм.рррр","CargoType" : "Cargo","VolumeGeneral" : "0.45","Weight" : "0.5","ServiceType" : "DoorsWarehouse","SeatsAmount" : "2","Description" : "Додатковий опис відправлення","Cost" : "15000","CitySender" : "00000000-0000-0000-0000-000000000000","Sender" : "00000000-0000-0000-0000-000000000000","SenderAddress" : "00000000-0000-0000-0000-000000000000","ContactSender" : "00000000-0000-0000-0000-000000000000","SendersPhone" : "380660000000","CityRecipient" : "00000000-0000-0000-0000-000000000000","Recipient" : "00000000-0000-0000-0000-000000000000","RecipientAddress" : "00000000-0000-0000-0000-000000000000","ContactRecipient" : "00000000-0000-0000-0000-000000000000","RecipientsPhone" : "380660000000"   }
}

                                  

    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>InternetDocument</modelName>
                <calledMethod>save</calledMethod>
                <methodProperties>
                    <SenderWarehouseIndex>101\/102</SenderWarehouseIndex>
                    <RecipientWarehouseIndex>101\/102</RecipientWarehouseIndex>
                    <PayerType>ThirdPerson</PayerType>
                    <PaymentMethod>NonCash</PaymentMethod>
                    <DateTime>дд.мм.рррр</DateTime>
                    <CargoType>Cargo</CargoType>
                    <VolumeGeneral>0.45</VolumeGeneral>
                    <Weight>0.5</Weight>
                    <ServiceType>DoorsWarehouse</ServiceType>
                    <SeatsAmount>2</SeatsAmount>
                    <Description>Додатковий опис відправлення</Description>
                    <Cost>15000</Cost>
                    <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
                    <Sender>00000000-0000-0000-0000-000000000000</Sender>
                    <SenderAddress>00000000-0000-0000-0000-000000000000</SenderAddress>
                    <ContactSender>00000000-0000-0000-0000-000000000000</ContactSender>
                    <SendersPhone>380660000000</SendersPhone>
                    <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
                    <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
                    <RecipientAddress>00000000-0000-0000-0000-000000000000</RecipientAddress>
                    <ContactRecipient>00000000-0000-0000-0000-000000000000</ContactRecipient>
                    <RecipientsPhone>380660000000</RecipientsPhone>
                </methodProperties>
            </file>

Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.

Тіло відповіді на запит

Параметр	Тип	Опис
Ref	string[36]	Ідентификатор експрес-накладной
CostOnSite	string[36]	Вартість доставки
EstimatedDeliveryDate	string[36]	Прогнозована дата доставки
IntDocNumber	string[36]	Номер експрес-накладной
TypeDocument	string[36]	Тип експрес-накладной

                                  
{
  "success": true,
  "data": [{"Ref" : "00000000-0000-0000-0000-000000000000","CostOnSite" : "45","EstimatedDeliveryDate" : "дд.мм.рррр","IntDocNumber" : "20600000002545","TypeDocument" : "InternetDocument"  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

                                   
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <CostOnSite>45</CostOnSite>
        <EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
        <IntDocNumber>20600000002545</IntDocNumber>
        <TypeDocument>InternetDocument</TypeDocument>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Спробувати API

Створити експрес-накладну

Додаткові параметри

                                   
    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>InternetDocument</modelName>
                <calledMethod>save</calledMethod>
                <methodProperties>
                    <PayerType></PayerType>
                    <PaymentMethod></PaymentMethod>
                    <DateTime></DateTime>
                    <CargoType></CargoType>
                    <Weight></Weight>
                    <ServiceType></ServiceType>
                    <SeatsAmount></SeatsAmount>
                    <Description></Description>
                    <Cost></Cost>
                    <CitySender></CitySender>
                    <Sender></Sender>
                    <SenderAddress></SenderAddress>
                    <ContactSender></ContactSender>
                    <SendersPhone></SendersPhone>
                    <CityRecipient></CityRecipient>
                    <Recipient></Recipient>
                    <RecipientAddress></RecipientAddress>
                    <ContactRecipient></ContactRecipient>
                    <RecipientsPhone></RecipientsPhone>
                </methodProperties>
            </file>