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

Формування запиту на створення ЕН з додатковими послугами

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

1. Формування запиту на створення «ЕН» із послугою «Суботня доставка»

"SaturdayDelivery": "1", - суботня доставка "1" - ТАК "0" – НІ

2. Формування запиту створення «ЕН» з послугою «Контроль оплати»

"AfterpaymentOnGoodsCost": "1005",

3. Формування запиту на створення «ЕН» з послугою «Локал Експрес»

"LocalExpress": "1",

"TimeInterval": "CityDeliveryTimeInterval2", - доступні інтервали 2, 3, 4.

Якщо це значення порожнє, API проставить позначку "Протягом дня" Детальніше про часові інтервали можна ознайомитися у пункті 5 даного розділу. Послуга доступна лише в межах доставки в одному місті.

4. Формування запиту на створення «ЕН» з послугою «Дата доставки»*

(*послуга надається тільки якщо доставка до адреси)

"PreferredDeliveryDate": "07.03.2021",

5. Формування запиту на створення «ЕН» із послугою «Доставка в часові інтервали»*

(*послуга надається тільки якщо доставка до адреси)

"PreferredDeliveryDate": "25.03.2021",

"TimeInterval": "CityDeliveryTimeInterval1/2/3/4",

Послуга «Доставка в часові інтервали» можлива лише при замовленні послуги «Бажана дата доставки». Як завантажити список видів часових інтервалів можна побачити у «Види часових інтервалів».

6. Формування запиту на створення «ЕН» за допомогою послуги «Вказати номери упаковки»

"PackingNumber": "4545" - "4545" номер пакування.

7. Формування запиту на створення «ЕН» із послугою «Вказати внутрішній номер замовлення клієнта»

"InfoRegClientBarcodes": "121212", - "121212" внутрішній номер

8. Формування запиту на створення «ЕН» з описом «Супроводжуючі документи»

"AccompanyingDocuments" : "Договір";

9. Формування запиту на створення «ЕН» з описом «Додаткова інформація про відправлення»

"AdditionalInformation": "Смартфон";

10. Формування запиту на створення «ЕН» з послугою «Підйом на поверх»

"NumberOfFloorsLifting": "3", 3 - номер поверху

"Elevator": "1", 1 – ліфт є, 0 – ліфта немає.

11. Формування запиту на створення «ЕН» з додатковою послугою «Доставка особисто в руки»

"DeliveryByHand": "1", - "1" - ТАК "0" – НІ

"DeliveryByHandRecipients": [ - перелік одержувачів яким можна віддавати відправлення "Могилевська Юлія Костянтинівна", "Колесник Костянтин Олександрович" ],

Під час замовлення послуги можна завантажувати до 15 осіб включно. При цьому перша особа завжди – одержувач (підтягується з «Дані одержувача»), решта 14 (чотирнадцять) – довільні одержувачі.

12. Формування запиту на створення «ЕН» з послугою «Контроль поштучної передачі» (експедирування)

"ForwardingCount":"126" 126 - кількість штук

13. Формування запиту на створення «ЕН» із послугою «Red Box»

"RedBoxBarcode":"0105QD26L" 0105QD26L - код враховує лише верхній регістр

14. Формування запиту на створення «ЕН» з пакуванням

Доступно для технології доставки до відділення. Обрати пакування необхідно за допомогою методу getPackListSpecial:

Приклад: { "modelName": "Common",

"calledMethod": "getPackListSpecial",

"methodProperties": { "Length": 100, // довжина відпрвлення, мм

"Width": 500, // ширина відпрвлення, мм

"Height": 50, // висота відпрвлення, мм

"PackForSale": "1" } }

Ідентифікатор пакування, що повертається у відповіді необхідно передавати в масиві "OptionsSeat"

Пример: "OptionsSeat": [{ // Масив з даними

"weight": 5, // вага відпрвлення, кг

"volumetricWidth": 80, // ширина відпрвлення, см

"volumetricLength": 25, // довжина відпрвлення, см

"volumetricHeight": 25, // висота відпрвлення, см

"packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a" }],

15. Формування запиту на створення «ЕН» з послугою «Ручне оброблення»

Послуга доступна до замовлення у разі створення документа з характеристиками: довжина відправлення (або одного місця) від 1 до 120 см, ширина та висота до 70 см та вагою (фактичною або об'ємною) відправлення (або одного місця) від 0,1 до 30 кг . Оформлення відправлень з категорією «Ручне оброблення» дозволено лише з/на вантажні відділення та адресу. Замовлення послуги можливе лише з передачею габаритів місць з використанням параметра:

"specialCargo":"1", - «Ручне оброблення» "1" - ТАК "0" – НІ

"OptionsSeat": [ { // Масив з даними параметрів вантажу для кожного місця відправлення

"weight": 5, // вага місця, кг

"volumetricHeight":50, // висота місця, см

"volumetricWidth":10, // ширина місця, см

"volumetricLength": 10, / / Довжина місця, см

"cost": "1", // оцінна вартість місця, грн

"description": "1", "specialCargo":"1" }]

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

Текст запиту

Параметр	Тип	Опис
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
RedBoxBarcode	string[36]	Номер штрихкоду RedBox (верхній регістр обов'язковий)
OptionsSeat*	array	Параметр вантажу для кожного місця відправлення

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

                        
 
{
   "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","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","RedBoxBarcode" : "","OptionsSeat" : [{"volumetricVolume":"1","volumetricWidth":"30","volumetricLength":"30","volumetricHeight":"30","weight":"2","packRef":"1499fa4a-d26e-11e1-95e4-0026b97ed48a"}]   }
}

                                  

    <?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>
                    <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>
                    <RedBoxBarcode></RedBoxBarcode>
                    <OptionsSeat><item><volumetricVolume>1</volumetricVolume><volumetricWidth>30</volumetricWidth><volumetricLength>30</volumetricLength><volumetricHeight>30</volumetricHeight><weight>2</weight><packRef>1499fa4a-d26e-11e1-95e4-0026b97ed48a</packRef></item></OptionsSeat>
                </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>
                    <OptionsSeat><array></array></OptionsSeat>
                </methodProperties>
            </file>