Створити експрес-накладну на поштомат "Нова Пошта"
Метод «save», працює в моделі «InternetDocument», цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).
При створенні ЕН на відділення типу поштамат обов'язково вказуються параметри розмірів.
Обмеження:
- Поштомат може бути лише відділенням одержувача;
- Відправляти на поштамат можна тільки типи вантажу Посилка (Parcel) та Документи (Documents);
- Максимальне значення оцінної вартості для відправки на поштомат (параметр Cost) – 6000 грн.;
- Максимально допустимі габарити вантажу: Ширина 40 см; Довжина 60 см; Висота 30 см;
- Максимально допустима вага вантажу 20 кг;
- При створенні відправлення на поштомат можна вказувати лише одне місце на одне відправлення.
Після створення інтернет документа в програмному середовищі API, ЕН з'являється у списку ЕН в особистому кабінеті.
Текст запиту
| Параметр | Тип | Опис |
|---|---|---|
| PayerType* | string[36] | Тип платника (Sender, Recipient, ThirdPerson) |
| PaymentMethod* | string[36] | Форма розрахунку Cash/NonCash |
| DateTime* | string[36] | Дата відправки у форматі дд.мм.рррр |
| CargoType* | string[36] | Тип вантажу тільки Посилка (Parcel) або Документи (Documents) |
| Weight* | string[36] | Фактична вага, в кг min - 0,1 |
| ServiceType* | string[36] | Технологія доставки DoorsWarehouse, WarehouseWarehouse |
| SeatsAmount* | string[36] | Кількість місць відправлення, ціле число |
| Description* | string[36] | Текстове поле, вводиться для додаткогвого опису відправлення |
| Cost* | string[36] | Оціночна вартість, ціле число (якщо не зазначити вартість то АРІ автоматично проставить мінімальну оціночну вартість =300.00) |
| CitySender* | string[36] | Ідентифікатор (REF) міста відправника |
| Sender* | string[36] | Ідентифікатор (REF) відправника |
| SenderAddress* | string[36] | Ідентифікатор (REF) адреси відправника |
| ContactSender* | string[36] | Ідентифікатор (REF) контактної особи відправника |
| SendersPhone* | string[36] | Телефон відправника у форматі: +380660000000, 380660000000, 0660000001 |
| CityRecipient* | string[36] | Ідентифікатор(REF) міста отримувача |
| Recipient* | string[36] | Ідентифікатор (REF) отримувача |
| RecipientAddress* | string[36] | Ідентифікатор (REF) поштомату |
| ContactRecipient* | string[36] | Ідентифікатор (REF) контактної особи |
| RecipientsPhone* | string[36] | Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001 |
| OptionsSeat* | array | Параметр вантажу для кожного місця відправлення: "volumetricVolume":"1" - об'єм одного місця в см; "volumetricWidth":"30" - ширина одного місця в см; "volumetricLength":"30" - довжина одного місця в см; "volumetricHeight":"30" - висота одного місця в см |
* Позначення обов’язкового параметру
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {"PayerType" : "ThirdPerson","PaymentMethod" : "NonCash","DateTime" : "дд.мм.рррр","CargoType" : "Cargo","Weight" : "0.5","ServiceType" : "DoorsWarehouse","SeatsAmount" : "2","Description" : "Додатковий опис відправлення","Cost" : "6000","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","OptionsSeat" : [{"volumetricVolume":"1","volumetricWidth":"30","volumetricLength":"30","volumetricHeight":"30","weight":"20"}] }
}
Відповідь 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": []
}