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

Створити експрес-накладну до відділення (рядком)

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

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

Текст запиту

Параметр	Тип	Опис
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.00)
CitySender*	string[36]	Ідентифікатор (REF) міста відправника
Sender*	string[36]	Ідентифікатор (REF) відправника
SenderAddress*	string[36]	Ідентифікатор (REF) адреси відправника. REF адреси брати з відповіді методу Список адрес контрагента
ContactSender*	string[36]	Ідентифікатор (REF) контактної особи відправника. REF брати з відповіді методу Список контактних осіб контрагента
SendersPhone*	string[36]	Телефон відправника у форматі: +380660000000, 380660000000, 0660000001
RecipientsPhone*	string[36]	Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001
NewAddress*	string[36]	Використання нового адресного довідника 1- ТАК, 0 - НІ
RecipientCityName*	string[36]	Ідентифікатор міста отримувача (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientArea*	string[36]	Ідентифікатор області (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientAreaRegions*	string[36]	Ідентифікатор району (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientAddressName*	string[36]	Ідентифікатор номера відділення (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientHouse*	string[36]	Ідентифікатор номера будинку (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientFlat*	string[36]	Ідентифікатор квартири (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
RecipientName*	string[36]	Ідентифікатор ПІБ отримувача (ЗАЗНАЧАЄТЬСЯ РЯДКОМ) - для приватної особи; Ідентифікатор назви організації отримувача (ЗАЗНАЧАЄТЬСЯ РЯДКОМ) - для організації
RecipientType*	string[36]	Тип отримувача Organization/PrivatePerson
SettlementType*	string[36]	Тип населеного пункту (значення для параметру брати з методу «getSettlements» у параметрі «SettlementTypeDescription») або значення "SettlementTypeCode" з відповіді на запит онлайн пошуку населених пунктів "searchSettlements"
OwnershipForm	string[36]	Ідентифікатор форми власності
RecipientContactName	string[36]	Ідентифікатор ПІБ отримувача (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)
EDRPOU*	string[36]	Ідентифікатор ЄДРПОУ (ЗАЗНАЧАЄТЬСЯ РЯДКОМ)

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

                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "InternetDocument",
   "calledMethod": "save",
   "methodProperties": {"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","RecipientsPhone" : "380660000000","NewAddress" : "1","RecipientCityName" : "Київ","RecipientArea" : "","RecipientAreaRegions" : "","RecipientAddressName" : "1","RecipientHouse" : "","RecipientFlat" : "","RecipientName" : "Іванов Іван Іванович","RecipientType" : "PrivatePerson","SettlementType" : ""місто" або "м.","OwnershipForm" : "00000000-0000-0000-0000-000000000000","RecipientContactName" : "Іванов Іван Іванович","EDRPOU" : "12345678"   }
}

                                  

    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>InternetDocument</modelName>
                <calledMethod>save</calledMethod>
                <methodProperties>
                    <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>
                    <RecipientsPhone>380660000000</RecipientsPhone>
                    <NewAddress>1</NewAddress>
                    <RecipientCityName>Київ</RecipientCityName>
                    <RecipientArea></RecipientArea>
                    <RecipientAreaRegions></RecipientAreaRegions>
                    <RecipientAddressName>1</RecipientAddressName>
                    <RecipientHouse></RecipientHouse>
                    <RecipientFlat></RecipientFlat>
                    <RecipientName>Іванов Іван Іванович</RecipientName>
                    <RecipientType>PrivatePerson</RecipientType>
                    <SettlementType>\"місто\" або \"м.</SettlementType>
                    <OwnershipForm>00000000-0000-0000-0000-000000000000</OwnershipForm>
                    <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
                    <EDRPOU>12345678</EDRPOU>
                </methodProperties>
            </file>

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

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

Параметр	Тип	Опис
Ref	string[36]	Ідентификатор (REF) експрес-накладной
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>
                    <RecipientsPhone></RecipientsPhone>
                    <NewAddress></NewAddress>
                    <RecipientCityName></RecipientCityName>
                    <RecipientArea></RecipientArea>
                    <RecipientAreaRegions></RecipientAreaRegions>
                    <RecipientAddressName></RecipientAddressName>
                    <RecipientHouse></RecipientHouse>
                    <RecipientFlat></RecipientFlat>
                    <RecipientName></RecipientName>
                    <RecipientType></RecipientType>
                    <SettlementType></SettlementType>
                    <EDRPOU></EDRPOU>
                </methodProperties>
            </file>