API Экспресс-накладная

Работа с экспресс-накладными

Создать экспресс-накладную с обратной доставкой

Формирование запросов с заказом услуги обратной доставки.
Внимание! Плательщиком по обратной доставке может быть только «Отправитель» или «Получатель».

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

1) Формирование запроса с заказом услуги «Обратная доставка документов с различными подтипами»
"BackwardDeliveryData": [
{
"PayerType": "Sender",
"CargoType": "Documents",
"Services": {
"Attorney": true,
"WaybillNewPostWithStamp": true,
"UserActions": "UserCallSender"
} ],

Подтипы документов. Возможное значение: «false» или «true»

Описание Параметр Значение
Доверенность с подписью и печатью Attorney true подпись и печать (доступно только одновременно)
ЕН ТОВ «Нова Пошта» с подписью и печатью WaybillNewPostWithStamp ;
WaybillNewPostWithoutStamp
true печать
ЕН ТОВ «Нова Пошта» с подписью WaybillNewPostWithoutStamp true печать
ЕН ТОВ «Нова Пошта» с печатью WaybillNewPostWithStamp true печать
ТТН государственного образца (№1) с подписью и печатью WaybillStateNumber1WithStamp,
WaybillStateNumber1WithoutStamp
true подпись
ТТН государственного образца (№1) с подписью WaybillStateNumber1WithoutStamp true подпись
ТТН государственного образца (№1) с печатью WaybillStateNumber1WithStamp true печать
Расходная накладная с подписью и печатью CostWaybillWithStamp
CostWaybillWithoutStamp
true подпись
Расходная накладная с подписью CostWaybillWithoutStamp true подпись
Расходная накладная с печатью CostWaybillWithStamp true печать
Международная накладная с подписью InternationalWaybill true подпись (доступна только подпись)
Бланк заказа с подписью OrderForm true подпись (доступна только подпись)
Акт приёма-передачи AktPPVWithStamp,
AktPPVWithoutStamp
true печать,
true подпись

Действия сотрудника НП (UserActions)

Описание Параметр
Не видавати відправлення без документів UserDontGiveDoc
Зателефонувати Відправнику UserCallSender


2) Формирование запроса с заказом услуги «Обратная доставка денег»
"BackwardDeliveryData": [
{
"PayerType": " Sender або Recipient ",
"CargoType": "Money",
"RedeliveryString": "4552"
} ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную обратную доставку и ее сумму.

3) Формирование запроса с заказом услуги «Обратная доставка кредитных документов»
"BackwardDeliveryData": [
{
"PayerType": "Sender",
"CargoType": "CreditDocuments",
"RedeliveryString": " "
} ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную услугу «Обратная доставка кредитных документов»

4)Формирование запроса с заказом услуги «Контроль подписи документов»
"BackwardDeliveryData": [
{
"PayerType": "Sender",
"CargoType": "SignedDocuments",
"RedeliveryString": " "
} ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную услугу «Обратная доставка подписанных документов»

5) Формирование запроса с заказом услуги «Обратная доставка поддонов»

Услуга «Обратная доставка поддонов», временно отключена!


6) Формирование запроса с заказом услуга «Обратная доставка 2-х видов»
"BackwardDeliveryData": [
{
"PayerType": "Sender",
"CargoType": "Money",
"RedeliveryString": "4552"
},
{
"PayerType": "Sender",
"CargoType": "Trays",
"RedeliveryString": "Пiддони( тара)",
"Trays": [
{
"CargoDescription": "d5c36c5c-a29d-11de-a2ca-000c294065a1",
"Amount": "5"
},
{
"CargoDescription": "d5c36c5d-a29d-11de-a2ca-000c294065a1",
"Amount": "3"
} ] } ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную услугу «Обратная доставка 2-х видов»

7) Формирование запроса с заказом услуга «Обратная доставка документов»
"BackwardDeliveryData": [
{
"PayerType": "Sender или Recipient ",
"CargoType": "Documents",
"RedeliveryString": ""
} ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную услугу «Обратная доставка документов»

8) Формирование запроса с заказом услуга «Обратная доставка «Другое»»
"BackwardDeliveryData": [
{
"PayerType": "Sender или Recipient ",
"CargoType": "Other",
"RedeliveryString": ""
} ],

После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную услугу «Обратная доставка «Другое»»

Приведенный пример из запроса - Формирование запроса с заказом услуги «обратная доставка документов с различными подтипами»

{   
 "apiKey": "[ВАШ КЛЮЧ]",
    "modelName": "InternetDocument",
    "calledMethod": "save",
    "methodProperties": {
        "PayerType": "Sender",
        "PaymentMethod": "Cash",
        "DateTime": "20.07.2016",
        "CargoType": "Cargo",
        "VolumeGeneral": "0.1",
        "Weight": "10",
        "ServiceType": "WarehouseDoors",
        "SeatsAmount": "1",
        "Description": "Гантелі",
        "Cost": "500",
        "CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
        "Sender": "130b0760-c998-11e5-9e52-0025909b4e33",
        "SenderAddress": "7b422fbe-e1b8-11e3-8c4a-0050568002cf",
        "ContactSender": "de339d8c-c999-11e5-83bc-005056886752",
        "SendersPhone": "380443555555",
        "CityRecipient": "db5c88de-391c-11dd-90d9-001a92567626",
        "Recipient": "640a049d-2d3a-11e6-bbb6-005056886752",
        "RecipientAddress": "58428745-0862-11e6-bbb6-005056886752",
        "ContactRecipient": "7f0cfa9e-315f-11e6-bbb6-005056886752",
        "RecipientsPhone": "380637301196",
        "BackwardDeliveryData": [
            {
                "PayerType": "Sender",
                "CargoType": "Documents",
                "Services": {
                    "Attorney": true,
                    "WaybillNewPostWithStamp": true,
                    "UserActions": "UserCallSender"
                }
            }
        ]
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<BackwardDeliveryData>
<item>
<CargoType>Documents</CargoType>
<PayerType>Sender</PayerType>
<RedeliveryString>Документи</RedeliveryString>
<Services>
<Attorney>true</Attorney>
<CostWaybillWithoutStamp>true</CostWaybillWithoutStamp>
<WaybillNewPostWithStamp>true</WaybillNewPostWithStamp>
<WaybillStateNumber1WithoutStamp>false
</WaybillStateNumber1WithoutStamp>
</Services>
</item>
</BackwardDeliveryData>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<DateTime>23.02.2016</DateTime>
<CargoType>Cargo</CargoType>
<VolumeGeneral>0.1</VolumeGeneral>
<Weight>10</Weight>
<ServiceType>WarehouseDoors</ServiceType>
<SeatsAmount>1</SeatsAmount>
<Description>абажур</Description>
<Cost>500</Cost>
<CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
<Sender>6e9acced-d072-11e3-95eb-0050568046cd</Sender>
<SenderAddress>01ae2635-e1c2-11e3-8c4a-0050568002cf</SenderAddress>
<SendersPhone>380678734567</SendersPhone>
<ContactSender>d0b9f592-b600-11e4-a77a-005056887b8d</ContactSender>
<CityRecipient>db5c8892-391c-11dd-90d9-001a92567626</CityRecipient>
<Recipient>d00f2319-b743-11e4-a77a-005056887b8d</Recipient>
<RecipientAddress>511fcfbd-e1c2-11e3-8c4a-0050568002cf</RecipientAddress>
<ContactRecipient>bc7b61ea-b6eb-11e4-a77a-005056887b8d</ContactRecipient>
<RecipientsPhone>380631112223</RecipientsPhone>
</methodProperties>
</root>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор экспресс-накладной
CostOnSite int[36] Стоимость
EstimatedDeliveryDate string[36] Прогноз даты доставки/td>
IntDocNumber int[36] Номер экспресс-накладной
TypeDocument string[36] Тип экспресс-накладной

{
"success": true,
"data": [
{
"Ref": "f6abf2bb-7bc6-11e4-acce-0050568002cf",
"CostOnSite": 90,
"EstimatedDeliveryDate": "03.03.2015",
"IntDocNumber": "20600000002545",
"TypeDocument": "InternetDocument"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root><success>true</success>
<data>
<item>
<Ref>37b36069-da0c-11e5-a70c-005056801333</Ref>
<CostOnSite>93</CostOnSite>
<EstimatedDeliveryDate>24.02.2016</EstimatedDeliveryDate>
<IntDocNumber>20600000057217</IntDocNumber>
<TypeDocument>InternetDocument</TypeDocument>
<RegionCode>П13</RegionCode>
RegionCity>Полтава</RegionCity>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>