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

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

Увага! Платником по зворотній доставці може бути лише "Відправник" або "Одержувач".

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

У параметрі "UserActions" передавати значення "UserCallSender" - "Перезвонити відправнику" для того, щоб у разі відсутності у одержувача повного пакета документів або оформлених неправильно документів, оператор зателефонував відправнику для з'ясування подальших дій.

Можливі підтипи документів:

Attorney - довіреність з підписом та печаткою (доступно лише разом) значення true\false

IsTakeAttorney - забір довіреності, значення "1" - ДА, "0" - НЕТ

WaybillNewPostWithStamp; WaybillNewPostWithoutStamp - ЕН ТОВ "Нова пошта" з підписом та печаткою, значення true\false

WaybillNewPostWithStamp - ЕН ТОВ "Нова пошта" з печаткою, значення true\false

WaybillNewPostWithoutStamp - ЕН ТОВ "Нова пошта" з підписом, значення true\false

WaybillStateNumber1WithStamp; WaybillStateNumber1WithoutStamp - ТТН державного зразка (№1) з підписом та печаткою, значення true\false

WaybillStateNumber1WithStamp - ТТН державного зразка (№1) з печаткою, значення true\false

WaybillStateNumber1WithoutStamp - ТТН державного зразка (№1) з підписом, значення true\false

CostWaybillWithStamp; CostWaybillWithoutStamp - видаткова накладна з підписом та печаткою, значення true\false

CostWaybillWithStamp - видаткова накладна з печаткою, значення true\false

CostWaybillWithoutStamp - видаткова накладна з підписом, значення true\false

InternationalWaybill - міжнародна накладна з підписом, значення true\false

OrderFrom - бланк замовлення з підписом, значення true\false

AktPPVWithStamp, AktPPVWithoutStamp - акт прийому-передачі з підписом та печаткою, значення true\false

"BackwardDeliveryData":

[ { "PayerType": "Sender",

"CargoType": "Documents",

"Services": { "Attorney": true,

"WaybillNewPostWithStamp": true,

"UserActions": "UserCallSender" } ],

2. Формування запиту із замовленням послуги «Зворотна доставка грошей»

"BackwardDeliveryData":

[ { "PayerType": "Sender або Recipient",

"CargoType": "Money",

"RedeliveryString": "4552" } ],

 

3. Формування запиту із замовленням послуги «Контроль підпису документів»

"BackwardDeliveryData":

[ { "PayerType": "Sender",

"CargoType": "SignedDocuments",

"RedeliveryString": " " } ],

4. Формування запиту із замовленням послуги «Зворотна доставка піддонів»

Послуга «Зворотна доставка піддонів» тимчасово відключена!

5. Формування запиту із замовленням послуга «Зворотна доставка 2-х видів»

"BackwardDeliveryData":

[ { "PayerType": "Sender",

"CargoType": "Money",

"RedeliveryString": "4552" },

{ "PayerType": "Sender",

"CargoType": "Trays",

"RedeliveryString": "Піддоні( тара)",

"Trays": [ { "CargoDescription":"d5c36c5c-a29d-11de-a2ca-000c294065a1",

"Amount": "5" },

{ "CargoDescription": "d5c36c5d-a29d-11de-a2ca-000c294065a1",

"Amount": "3" } ]

} ],

6. Формування запиту із замовленням послуга «Зворотна доставка документів»

"BackwardDeliveryData":

[ { "PayerType": "Sender або Recipient",

"CargoType": "Documents",

"RedeliveryString": "" } ],

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

Текст запиту
Параметр Тип Опис
PayerType* string[36] Тип платника (Sender, Recipient, ThirdPerson)
PaymentMethod* string[36] Форма розрахунку Cash/NonCash
DateTime* string[36] Дата відправки у форматі дд.мм.рррр
CargoType* string[36] Тип вантажу
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] Ідентифікатор адреси відправника
ContactSender* string[36] Ідентифікатор контактної особи відправника
SendersPhone* string[36] Телефон відправника у форматі: +380660000000, 380660000000, 0660000001
CityRecipient* string[36] Ідентифікатор міста отримувача
Recipient* string[36] Ідентифікатор отримувача
RecipientAddress* string[36] Ідетнифікатор адреси отримувача
ContactRecipient* string[36] Ідентифікатор контактної особи
RecipientsPhone* string[36] Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001
NewAddress* string[36] Використання нового адресного довідника 1- ТАК, 0 - НІ
OptionsSeat* array Параметр вантажу для кожного місця відправлення
BackwardDeliveryData array Зворотна доставка підтипів документів
* Позначення обов’язкового параметру
                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "InternetDocument",
   "calledMethod": "save",
   "methodProperties": {"PayerType" : "ThirdPerson","PaymentMethod" : "NonCash","DateTime" : "дд.мм.рррр","CargoType" : "Cargo","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","NewAddress" : "1","OptionsSeat" : [{"volumetricVolume":"1","volumetricWidth":"30","volumetricLength":"30","volumetricHeight":"30","weight":"20"}],"BackwardDeliveryData" : [{"PayerType":"Sender","CargoType":"Documents","Services":{"Attorney":true","WaybillNewPostWithStamp":true","UserActions":"UserCallSender"}}]   }
}

                                
                                  




                                

Відповідь 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": []
}