For the complete documentation index, see llms.txt. This page is also available as Markdown.

Експрес-накладна

Створення, редагування, видалення та отримання даних за експрес-накладною

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

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

post

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

Зверніть увагу: Якщо вибрано тип доставки CargoType: Documents, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.

Створити ЕН зі зворотною доставкою

У цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр BackwardDeliveryData. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».

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

Можна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах PayerType та ThirdPerson:

{
  "PayerType": "ThirdPerson",
  "ThirdPerson": "5953fb16-08d8-11e4-8958-0025909b4e33"
}

Для платника ThirdPerson форма оплати може бути лише «Безготівковий розрахунок».

Планова дата відправки

У параметрі DateTime можна задати планову дату відправки. Значення DateTime не може перевищувати поточну дату більше ніж на 3 місяці.

Накладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 936

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "SenderWarehouseIndex": "101/102",
    "RecipientWarehouseIndex": "101/102",
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "18.09.2026",
    "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"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "19.09.2026",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Зверніть увагу: Якщо вибрано тип доставки CargoType: Documents, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.

Створити ЕН зі зворотною доставкою

У цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр BackwardDeliveryData. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».

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

Можна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах PayerType та ThirdPerson:

<PayerType>ThirdPerson</PayerType>
<ThirdPerson>5953fb16-08d8-11e4-8958-0025909b4e33</ThirdPerson>

Для платника ThirdPerson форма оплати може бути лише «Безготівковий розрахунок».

Планова дата відправки

У параметрі DateTime можна задати планову дату відправки. Значення DateTime не може перевищувати поточну дату більше ніж на 3 місяці.

Накладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1429

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>InternetDocumentGeneral</modelName>
  <calledMethod>save</calledMethod>
  <methodProperties>
    <SenderWarehouseIndex>101/102</SenderWarehouseIndex>
    <RecipientWarehouseIndex>101/102</RecipientWarehouseIndex>
    <PayerType>Sender</PayerType>
    <PaymentMethod>Cash</PaymentMethod>
    <DateTime>18.09.2026</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>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>00000000-0000-0000-0000-000000000000</Ref>
      <CostOnSite>45</CostOnSite>
      <EstimatedDeliveryDate>19.09.2026</EstimatedDeliveryDate>
      <IntDocNumber>20600000002545</IntDocNumber>
      <TypeDocument>InternetDocument</TypeDocument>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

Метод save працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).

За допомогою методу save можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.

Обмеження
  • Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».

  • Відправляти у поштомат можна тільки типи вантажу «Посилка» (Parcel) та «Документи» (Documents).

  • Максимальне значення оціночної вартості для відправки у поштомат (параметр Cost) — 29 000 грн.

  • Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.

  • Максимально допустима вага вантажу — 20 кг.

  • Під час створення відправлення можна вказувати лише одне місце на одне відправлення.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1044

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "SenderWarehouseIndex": "101/102",
    "RecipientWarehouseIndex": "11/3002",
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "18.09.2026",
    "CargoType": "Parcel",
    "Weight": "0.5",
    "ServiceType": "DoorsWarehouse",
    "SeatsAmount": "1",
    "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": "0.027",
        "volumetricWidth": "30",
        "volumetricLength": "30",
        "volumetricHeight": "30",
        "weight": "0.5"
      }
    ]
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "19.09.2026",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод save працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).

За допомогою методу save можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.

Обмеження
  • Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».

  • Відправляти у поштомат можна тільки типи вантажу «Посилка» (Parcel) та «Документи» (Documents).

  • Максимальне значення оціночної вартості для відправки у поштомат (параметр Cost) — 29 000 грн.

  • Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.

  • Максимально допустима вага вантажу — 20 кг.

  • Під час створення відправлення можна вказувати лише одне місце на одне відправлення.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>InternetDocumentGeneral</modelName>
  <calledMethod>save</calledMethod>
  <methodProperties>
    <SenderWarehouseIndex>101/102</SenderWarehouseIndex>
    <RecipientWarehouseIndex>11/3002</RecipientWarehouseIndex>
    <PayerType>Sender</PayerType>
    <PaymentMethod>Cash</PaymentMethod>
    <DateTime>18.09.2026</DateTime>
    <CargoType>Parcel</CargoType>
    <Weight>0.5</Weight>
    <ServiceType>DoorsWarehouse</ServiceType>
    <SeatsAmount>1</SeatsAmount>
    <Description>Додатковий опис відправлення</Description>
    <Cost>6000</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>
    <OptionsSeat>
      <item>
        <volumetricVolume>0.027</volumetricVolume>
        <volumetricWidth>30</volumetricWidth>
        <volumetricLength>30</volumetricLength>
        <volumetricHeight>30</volumetricHeight>
        <weight>0.5</weight>
      </item>
    </OptionsSeat>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>00000000-0000-0000-0000-000000000000</Ref>
      <CostOnSite>45</CostOnSite>
      <EstimatedDeliveryDate>19.09.2026</EstimatedDeliveryDate>
      <IntDocNumber>20600000002545</IntDocNumber>
      <TypeDocument>InternetDocument</TypeDocument>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

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

Є можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).

Приклад формування запиту з типом вантажу «Шини-диски» ("CargoType"="TiresWheels")
"CargoDetails": [ { "CargoDescription": "20f7b626-9add-11e3-b441-0050568002cf", "Amount": "4" } ]
Приклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця ("CargoType"="Pallet")
"OptionsSeat": [ { "volumetricVolume": "10", "volumetricWidth": "10", "volumetricLength": "10", "volumetricHeight": "10", "weight": "10" }, { "volumetricVolume": "10", "volumetricWidth": "10", "volumetricLength": "10", "volumetricHeight": "10", "weight": "10" } ]
Приклад формування запиту з типом вантажу «Документи» ("CargoType"="Documents")

Якщо вибрано тип доставки "CargoType": "Documents", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.

Інтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required
warningsstring[]Required
infostring[]Required
messageCodesstring[]Required
errorCodesstring[]Required
warningCodesstring[]Required
infoCodesstring[]Required
post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 815

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocument",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "дд.мм.рррр",
    "CargoType": "Documents",
    "Weight": "0,1",
    "ServiceType": "WarehouseWarehouse",
    "SeatsAmount": "1",
    "Description": "Документи",
    "Cost": "300",
    "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"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "info": [
    "text"
  ],
  "messageCodes": [
    "text"
  ],
  "errorCodes": [
    "text"
  ],
  "warningCodes": [
    "text"
  ],
  "infoCodes": [
    "text"
  ]
}

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

post

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

Є можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).

Приклад формування запиту з типом вантажу «Шини-диски» ("CargoType"="TiresWheels")
<CargoDetails><item><CargoDescription>20f7b626-9add-11e3-b441-0050568002cf</CargoDescription><Amount>4</Amount></item></CargoDetails>
Приклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця ("CargoType"="Pallet")
<OptionsSeat><item><volumetricVolume>10</volumetricVolume><volumetricWidth>10</volumetricWidth><volumetricLength>10</volumetricLength><volumetricHeight>10</volumetricHeight><weight>10</weight></item><item><volumetricVolume>10</volumetricVolume><volumetricWidth>10</volumetricWidth><volumetricLength>10</volumetricLength><volumetricHeight>10</volumetricHeight><weight>10</weight></item></OptionsSeat>
Приклад формування запиту з типом вантажу «Документи» ("CargoType"="Documents")

Якщо вибрано тип доставки "CargoType": "Documents", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.

Інтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required
warningsstring[]Required
infostring[]Required
messageCodesstring[]Required
errorCodesstring[]Required
warningCodesstring[]Required
infoCodesstring[]Required
post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1237

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>InternetDocument</modelName>
  <calledMethod>save</calledMethod>
  <methodProperties>
    <PayerType>Sender</PayerType>
    <PaymentMethod>Cash</PaymentMethod>
    <DateTime>дд.мм.рррр</DateTime>
    <CargoType>Documents</CargoType>
    <Weight>0,1</Weight>
    <ServiceType>WarehouseWarehouse</ServiceType>
    <SeatsAmount>1</SeatsAmount>
    <Description>Документи</Description>
    <Cost>300</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>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0"?>
<root>
	<success>true</success>
	<data>
		<item>
			<Ref>00000000-0000-0000-0000-000000000000</Ref>
			<CostOnSite>45</CostOnSite>
			<EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
			<IntDocNumber>20600000002545</IntDocNumber>
			<TypeDocument>InternetDocument</TypeDocument>
		</item>
	</data>
	<errors>
		<item>text</item>
	</errors>
	<warnings>
		<item>text</item>
	</warnings>
	<info>
		<item>text</item>
	</info>
	<messageCodes>
		<item>text</item>
	</messageCodes>
	<errorCodes>
		<item>text</item>
	</errorCodes>
	<warningCodes>
		<item>text</item>
	</warningCodes>
	<infoCodes>
		<item>text</item>
	</infoCodes>
</root>

Створити експрес-накладну з додатковими послугами (JSON)

post

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

Є можливість створювати запити з додатковими послугами.

Формування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»
"SaturdayDelivery": "1" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається
Формування запиту на створення ЕН із послугою «Контроль оплати»
"AfterpaymentOnGoodsCost": "1005"
Формування запиту на створення ЕН із послугою «Локал Експрес»

Доступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку "Протягом дня" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.

"LocalExpress": "1",
"TimeInterval": "CityDeliveryTimeInterval2"
Формування запиту на створення ЕН із послугою «Дата доставки»*

*Послуга надається тільки в разі доставки до адреси.

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

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

"PreferredDeliveryDate": "25.03.2021",
"TimeInterval": "CityDeliveryTimeInterval1/2/3/4"
Формування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»
Формування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»
Формування запиту на створення ЕН із описом «Супровідні документи»
Формування запиту на створення ЕН із описом «Додаткова інформація про відправлення»
Формування запиту на створення ЕН із послугою «До дверей»
Формування запиту на створення ЕН із послугою «Від дверей»

Параметр «Ліфт» (Elevator) можна ігнорувати.

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

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

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

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

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

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

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

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1068

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "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"
      }
    ]
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "info": [
    "text"
  ],
  "messageCodes": [
    "text"
  ],
  "errorCodes": [
    "text"
  ],
  "warningCodes": [
    "text"
  ],
  "infoCodes": [
    "text"
  ]
}

Створити експрес-накладну з додатковими послугами (XML)

post

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

Є можливість створювати запити з додатковими послугами.

Формування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»
"SaturdayDelivery": "1" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається
Формування запиту на створення ЕН із послугою «Контроль оплати»
"AfterpaymentOnGoodsCost": "1005"
Формування запиту на створення ЕН із послугою «Локал Експрес»

Доступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку "Протягом дня" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.

"LocalExpress": "1",
"TimeInterval": "CityDeliveryTimeInterval2"
Формування запиту на створення ЕН із послугою «Дата доставки»*

*Послуга надається тільки в разі доставки до адреси.

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

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

"PreferredDeliveryDate": "25.03.2021",
"TimeInterval": "CityDeliveryTimeInterval1/2/3/4"
Формування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»
Формування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»
Формування запиту на створення ЕН із описом «Супровідні документи»
Формування запиту на створення ЕН із описом «Додаткова інформація про відправлення»
Формування запиту на створення ЕН із послугою «До дверей»
Формування запиту на створення ЕН із послугою «Від дверей»

Параметр «Ліфт» (Elevator) можна ігнорувати.

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

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

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

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

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

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

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

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1722

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</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

Успішна відповідь (XML)

<?xml version="1.0"?>
<root>
	<success>true</success>
	<data>
		<item>
			<Ref>00000000-0000-0000-0000-000000000000</Ref>
			<CostOnSite>45</CostOnSite>
			<EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
			<IntDocNumber>20600000002545</IntDocNumber>
			<TypeDocument>InternetDocument</TypeDocument>
		</item>
	</data>
	<errors>
		<item>text</item>
	</errors>
	<warnings>
		<item>text</item>
	</warnings>
	<info>
		<item>text</item>
	</info>
	<messageCodes>
		<item>text</item>
	</messageCodes>
	<errorCodes>
		<item>text</item>
	</errorCodes>
	<warningCodes>
		<item>text</item>
	</warningCodes>
	<infoCodes>
		<item>text</item>
	</infoCodes>
</root>

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

post

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

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1070

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "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"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1813

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</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

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <CostOnSite>45</CostOnSite>
            <EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
            <IntDocNumber>20600000002545</IntDocNumber>
            <TypeDocument>InternetDocument</TypeDocument>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод save працює в моделі InternetDocumentGeneral (або InternetDocument). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1183

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "RecipientAddressNote": "Вільний текст",
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "дд.мм.рррр",
    "CargoType": "Cargo",
    "VolumeGeneral": "0.45",
    "Weight": "0.5",
    "ServiceType": "WarehouseDoors",
    "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": "Київська",
    "RecipientHouse": "1",
    "RecipientFlat": "25",
    "RecipientName": "Іванов Іван Іванович",
    "RecipientType": "PrivatePerson",
    "SettlementType": "Київська",
    "OwnershipForm": "00000000-0000-0000-0000-000000000000",
    "RecipientContactName": "Іванов Іван Іванович",
    "EDRPOU": "12345678"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод save працює в моделі InternetDocumentGeneral (або InternetDocument). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1955

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <RecipientAddressNote>Вільний текст</RecipientAddressNote>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</PaymentMethod>
        <DateTime>дд.мм.рррр</DateTime>
        <CargoType>Cargo</CargoType>
        <VolumeGeneral>0.45</VolumeGeneral>
        <Weight>0.5</Weight>
        <ServiceType>WarehouseDoors</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>Київська</RecipientAddressName>
        <RecipientHouse>1</RecipientHouse>
        <RecipientFlat>25</RecipientFlat>
        <RecipientName>Іванов Іван Іванович</RecipientName>
        <RecipientType>PrivatePerson</RecipientType>
        <SettlementType>Київська</SettlementType>
        <OwnershipForm>00000000-0000-0000-0000-000000000000</OwnershipForm>
        <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
        <EDRPOU>12345678</EDRPOU>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?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>

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

post

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

Увага! Допустимі значення платника: «Відправник» або «Одержувач».

Можливо сформувати запит із додатковими послугами.

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

Щоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі 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"
    }
  }
]
Формування запиту із замовленням послуги «Зворотна доставка грошей»

Приклад:

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

Приклад:

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

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

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

Приклад:

"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"
      }
    ]
  }
]
Формування запиту із замовленням послуги «Зворотна доставка документів»

Приклад:

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1158

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "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

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Увага! Допустимі значення платника: «Відправник» або «Одержувач».

Можливо сформувати запит із додатковими послугами.

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

Щоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі 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"
    }
  }
]
Формування запиту із замовленням послуги «Зворотна доставка грошей»

Приклад:

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

Приклад:

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

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

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

Приклад:

"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"
      }
    ]
  }
]
Формування запиту із замовленням послуги «Зворотна доставка документів»

Приклад:

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1889

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</PaymentMethod>
        <DateTime>дд.мм.рррр</DateTime>
        <CargoType>Cargo</CargoType>
        <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>
        <NewAddress>1</NewAddress>
        <OptionsSeat><item><volumetricVolume>1</volumetricVolume><volumetricWidth>30</volumetricWidth><volumetricLength>30</volumetricLength><volumetricHeight>30</volumetricHeight><weight>20</weight></item></OptionsSeat>
        <BackwardDeliveryData><item><PayerType>Sender</PayerType><CargoType>Documents</CargoType><Services><Attorney>true</Attorney><WaybillNewPostWithStamp>true</WaybillNewPostWithStamp><UserActions>UserCallSender</UserActions></Services></item></BackwardDeliveryData>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?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>

Створити експрес-накладну з поштомата (JSON)

post

Метод save працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). За допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.

Обмеження
  • Відправляти з поштомата можна тільки типи вантажу «Посилка» (Parcel) та «Документи» (Documents).

  • Максимальне значення оціночної вартості для відправки з поштомата (параметр Cost) — 10000 грн.

  • Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.

  • Максимально допустима вага вантажу — 20 кг.

  • У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.

Пакування в поштоматі

Окремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу getPackListSpecial. Отриманий ідентифікатор потрібно передати у параметрі Ref масиву OptionSeat під час створення ЕН.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 1084

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocument",
  "calledMethod": "save",
  "methodProperties": {
    "ContactRecipient": "00000000-0000-0000-0000-000000000000",
    "ContactSender": "00000000-0000-0000-0000-000000000000",
    "ServiceType": "WarehouseDoors",
    "PayerType": "Sender",
    "Weight": "0.5",
    "SenderAddress": "00000000-0000-0000-0000-000000000000",
    "RecipientWarehouseIndex": "11/3002",
    "Sender": "00000000-0000-0000-0000-000000000000",
    "CargoType": "Parcel",
    "SenderWarehouseIndex": "11/3002",
    "RecipientAddress": "00000000-0000-0000-0000-000000000000",
    "CitySender": "00000000-0000-0000-0000-000000000000",
    "Recipient": "00000000-0000-0000-0000-000000000000",
    "Cost": "6000",
    "OptionSeat": [
      {
        "volumetricVolume": "1",
        "volumetricWidth": "30",
        "volumetricLength": "30",
        "volumetricHeight": "30",
        "weight": "20",
        "Ref": "cd00107e-2e73-41eb-9056-85a9931c6223"
      }
    ],
    "CityRecipient": "00000000-0000-0000-0000-000000000000",
    "Description": "Додатковий опис відправлення",
    "DateTime": "дд.мм.рррр",
    "RecipientsPhone": "380660000000",
    "SeatsAmount": "1",
    "SendersPhone": "380660000000",
    "PaymentMethod": "Cash"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "TypeDocument": "InternetDocument",
      "IntDocNumber": "20600000002545",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "CostOnSite": "45",
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити експрес-накладну з поштомата (XML)

post

Метод save працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). За допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.

Обмеження
  • Відправляти з поштомата можна тільки типи вантажу «Посилка» (Parcel) та «Документи» (Documents).

  • Максимальне значення оціночної вартості для відправки з поштомата (параметр Cost) — 10000 грн.

  • Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.

  • Максимально допустима вага вантажу — 20 кг.

  • У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.

Пакування в поштоматі

Окремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу getPackListSpecial. Отриманий ідентифікатор потрібно передати у параметрі Ref масиву OptionSeat під час створення ЕН.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1868

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocument</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <ContactRecipient>00000000-0000-0000-0000-000000000000</ContactRecipient>
        <ContactSender>00000000-0000-0000-0000-000000000000</ContactSender>
        <ServiceType>WarehouseDoors</ServiceType>
        <PayerType>Sender</PayerType>
        <Weight>0.5</Weight>
        <SenderAddress>00000000-0000-0000-0000-000000000000</SenderAddress>
        <RecipientWarehouseIndex>11/3002</RecipientWarehouseIndex>
        <Sender>00000000-0000-0000-0000-000000000000</Sender>
        <CargoType>Parcel</CargoType>
        <SenderWarehouseIndex>11/3002</SenderWarehouseIndex>
        <RecipientAddress>00000000-0000-0000-0000-000000000000</RecipientAddress>
        <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
        <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
        <Cost>6000</Cost>
        <OptionSeat>
          <item>
            <volumetricVolume>1</volumetricVolume>
            <volumetricWidth>30</volumetricWidth>
            <volumetricLength>30</volumetricLength>
            <volumetricHeight>30</volumetricHeight>
            <weight>20</weight>
            <Ref>cd00107e-2e73-41eb-9056-85a9931c6223</Ref>
          </item>
        </OptionSeat>
        <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
        <Description>Додатковий опис відправлення</Description>
        <DateTime>дд.мм.рррр</DateTime>
        <RecipientsPhone>380660000000</RecipientsPhone>
        <SeatsAmount>1</SeatsAmount>
        <SendersPhone>380660000000</SendersPhone>
        <PaymentMethod>Cash</PaymentMethod>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <TypeDocument>InternetDocument</TypeDocument>
        <IntDocNumber>20600000002545</IntDocNumber>
        <EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
        <CostOnSite>45</CostOnSite>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Отримати дані чи видалити експрес-накладну

Розрахувати вартість послуг (JSON)

post

Метод getDocumentPrice працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод розраховує вартість доставки вантажу. Метод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.

Приклад прорахунку вартості шин та дисків
"CargoType": "TiresWheels", // Тип відправлення «Шини та Диски»
"CargoDetails": [{// Масив із даними
"CargoDescription":"d7c456cf-aa8b-11e3-9fa0-0050568002cf", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»
"Amount": "2" //Кількість шин }]
Приклад розрахунку вартості вантажів із передачею параметрів
"OptionsSeat": [{// Масив із даними
"weight": 5, // Вага відправлення, кг
"volumetricWidth": 80, // Ширина відправлення, см
"volumetricLength": 25, // Довжина відправлення, см
"volumetricHeight": 25, // Висота відправлення, см }]
Приклад розрахунку вартості з пакуванням

Також доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві OptionsSeat.

"OptionsSeat": [{// Масив із даними
"weight": 5, // Вага відправлення, кг
"volumetricWidth": 80, // Ширина відправлення, см
"volumetricLength": 25, // Довжина відправлення, см
"volumetricHeight": 25, // Висота відправлення, см
"packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a" }]
Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 618

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "getDocumentPrice",
  "methodProperties": {
    "CitySender": "00000000-0000-0000-0000-000000000000",
    "CityRecipient": "00000000-0000-0000-0000-000000000000",
    "Weight": "0.1",
    "ServiceType": "WarehouseWarehouse",
    "Cost": "300",
    "CargoType": "Cargo",
    "SeatsAmount": "2",
    "RedeliveryCalculate": {
      "CargoType": "Money",
      "Amount": "100"
    },
    "PackCount": "1",
    "PackRef": "00000000-0000-0000-0000-000000000000",
    "Amount": "100",
    "CargoDetails": [
      {
        "CargoDescription": "00000000-0000-0000-0000-000000000000",
        "Amount": "2"
      }
    ],
    "CargoDescription": "00000000-0000-0000-0000-000000000000"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "AssessedCost": "300",
      "Cost": "45",
      "CostRedelivery": "100",
      "TZoneInfo": {
        "TzoneName": "Тарифназона:Тарифназона4",
        "TzoneID": "4"
      },
      "CostPack": "4"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Розрахувати вартість послуг (XML)

post

Метод getDocumentPrice працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод розраховує вартість доставки вантажу. Метод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.

Приклад прорахунку вартості шин та дисків
"CargoType": "TiresWheels", // Тип відправлення «Шини та Диски»
"CargoDetails": [{// Масив із даними
"CargoDescription":"d7c456cf-aa8b-11e3-9fa0-0050568002cf", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»
"Amount": "2" //Кількість шин }]
Приклад розрахунку вартості вантажів із передачею параметрів
"OptionsSeat": [{// Масив із даними
"weight": 5, // Вага відправлення, кг
"volumetricWidth": 80, // Ширина відправлення, см
"volumetricLength": 25, // Довжина відправлення, см
"volumetricHeight": 25, // Висота відправлення, см }]
Приклад розрахунку вартості з пакуванням

Також доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві OptionsSeat.

"OptionsSeat": [{// Масив із даними
"weight": 5, // Вага відправлення, кг
"volumetricWidth": 80, // Ширина відправлення, см
"volumetricLength": 25, // Довжина відправлення, см
"volumetricHeight": 25, // Висота відправлення, см
"packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a" }]
Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1046

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>getDocumentPrice</calledMethod>
    <methodProperties>
        <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
        <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
        <Weight>0.1</Weight>
        <ServiceType>WarehouseWarehouse</ServiceType>
        <Cost>300</Cost>
        <CargoType>Cargo</CargoType>
        <SeatsAmount>2</SeatsAmount>
        <RedeliveryCalculate><CargoType>Money</CargoType><Amount>100</Amount></RedeliveryCalculate>
        <PackCount>1</PackCount>
        <PackRef>00000000-0000-0000-0000-000000000000</PackRef>
        <Amount>100</Amount>
        <CargoDetails><item><CargoDescription>00000000-0000-0000-0000-000000000000</CargoDescription><Amount>2</Amount></item></CargoDetails>
        <CargoDescription>00000000-0000-0000-0000-000000000000</CargoDescription>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <AssessedCost>300</AssessedCost>
        <Cost>45</Cost>
        <CostRedelivery>100</CostRedelivery>
        <TZoneInfo>
            <TzoneName>Тарифназона:Тарифназона4</TzoneName>
            <TzoneID>4</TzoneID>
        </TZoneInfo>
        <CostPack>4</CostPack>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Прогноз дати доставки вантажу (JSON)

post

Метод getDocumentDeliveryDate працює в моделі InternetDocument (або InternetDocumentGeneral). Метод повертає орієнтовну дату доставки у відповіді.

Послуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "getDocumentDeliveryDate",
  "methodProperties": {
    "DateTime": "2024-05-31 15:00:00",
    "ServiceType": "WarehouseWarehouse",
    "CitySender": "00000000-0000-0000-0000-000000000000",
    "CityRecipient": "00000000-0000-0000-0000-000000000000"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "DeliveryDate": {
        "date": "2024-07-10 18:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/Kiev"
      }
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Прогноз дати доставки вантажу (XML)

post

Метод getDocumentDeliveryDate працює в моделі InternetDocument (або InternetDocumentGeneral). Метод повертає орієнтовну дату доставки у відповіді.

Послуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив помилок при виконанні запиту

warningsstring[]Required

Масив попереджень при виконанні запиту

infostring[]Required

Інформаційні повідомлення

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткових відомостей

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 515

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>getDocumentDeliveryDate</calledMethod>
    <methodProperties>
        <DateTime>2024-05-31 15:00:00</DateTime>
        <ServiceType>WarehouseWarehouse</ServiceType>
        <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
        <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <DeliveryDate>
            <date>2024-07-10 18:00:00.000000</date>
            <timezone_type>3</timezone_type>
            <timezone>Europe/Kiev</timezone>
        </DeliveryDate>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Редагувати експрес-накладну (JSON)

post

Метод update працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).

Обов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 930

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "update",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "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"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "IntDocNumber": "20600000002545",
      "TypeDocument": "InternetDocument"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Редагувати експрес-накладну (XML)

post

Метод update працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).

Обов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 1472

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>update</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <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>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <CostOnSite>45</CostOnSite>
            <EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
            <IntDocNumber>20600000002545</IntDocNumber>
            <TypeDocument>InternetDocument</TypeDocument>
        </item>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Отримати список експрес-накладних (JSON)

post

Метод getDocumentList працює в моделі InternetDocument (або InternetDocumentGeneral) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (Ref) в API.

Опис параметрів пошуку та завантаження

У параметрі DateTime можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри DateTimeFrom і DateTimeTo. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі IntDocNumber необхідно вказати відповідний номер.

Якщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.

Параметр GetFullList визначає режим завантаження даних — повним списком або посторінково:

  • 1 — завантажує весь перелік накладних за період (максимум 100 записів загалом через системне обмеження).

  • 0 — вмикає посторінкове завантаження (для отримання понад 100 записів загалом). У цьому режимі обов'язково передавати параметр Page.

Відображення ЕН зі зворотною доставкою

Додатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра RedeliveryMoney.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "getDocumentList",
  "methodProperties": {
    "DateTimeFrom": "дд.мм.рррр",
    "DateTimeTo": "дд.мм.рррр",
    "Page": "1",
    "GetFullList": "1",
    "DateTime": "дд.мм.рррр",
    "IntDocNumber": "20400009196210"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "DateTime": "дд.мм.рррр",
      "PreferredDeliveryDate": "дд.мм.рррр",
      "RecipientDateTime": "дд.мм.рррр",
      "EWDateCreated": "дд.мм.рррр",
      "Weight": "5",
      "SeatsAmount": "2",
      "IntDocNumber": "20400030200931",
      "Cost": "15000",
      "CitySender": "00000000-0000-0000-0000-000000000000",
      "CityRecipient": "00000000-0000-0000-0000-000000000000",
      "SenderAddress": "00000000-0000-0000-0000-000000000000",
      "RecipientAddress": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "PayerType": "Sender",
      "PaymentMethod": "Cash",
      "AfterpaymentOnGoodsCost": "500",
      "PackingNumber": "123456",
      "RejectionReason": "Опис причини переадресування",
      "StateId": "41",
      "StateName": "Відправлення в місті Києві",
      "ScanSheetNumber": ""
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Отримати список експрес-накладних (XML)

post

Метод getDocumentList працює в моделі InternetDocument (або InternetDocumentGeneral) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (Ref) в API.

Опис параметрів пошуку та завантаження

У параметрі DateTime можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри DateTimeFrom і DateTimeTo. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі IntDocNumber необхідно вказати відповідний номер.

Якщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.

Параметр GetFullList визначає режим завантаження даних — повним списком або посторінково:

  • 1 — завантажує весь перелік накладних за період (максимум 100 записів загалом через системне обмеження).

  • 0 — вмикає посторінкове завантаження (для отримання понад 100 записів загалом). У цьому режимі обов'язково передавати параметр Page.

Відображення ЕН зі зворотною доставкою

Додатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра RedeliveryMoney.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 528

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>getDocumentList</calledMethod>
    <methodProperties>
        <DateTimeFrom>дд.мм.рррр</DateTimeFrom>
        <DateTimeTo>дд.мм.рррр</DateTimeTo>
        <Page>1</Page>
        <GetFullList>1</GetFullList>
        <DateTime>дд.мм.рррр</DateTime>
        <IntDocNumber>20400009196210</IntDocNumber>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <DateTime>дд.мм.рррр</DateTime>
            <PreferredDeliveryDate>дд.мм.рррр</PreferredDeliveryDate>
            <RecipientDateTime>дд.мм.рррр</RecipientDateTime>
            <EWDateCreated>дд.мм.рррр</EWDateCreated>
            <Weight>5</Weight>
            <SeatsAmount>2</SeatsAmount>
            <IntDocNumber>20400030200931</IntDocNumber>
            <Cost>15000</Cost>
            <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
            <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
            <SenderAddress>00000000-0000-0000-0000-000000000000</SenderAddress>
            <RecipientAddress>00000000-0000-0000-0000-000000000000</RecipientAddress>
            <CostOnSite>45</CostOnSite>
            <PayerType>Sender</PayerType>
            <PaymentMethod>Cash</PaymentMethod>
            <AfterpaymentOnGoodsCost>500</AfterpaymentOnGoodsCost>
            <PackingNumber>123456</PackingNumber>
            <RejectionReason>Опис причини переадресування</RejectionReason>
            <StateId>41</StateId>
            <StateName>Відправлення в місті Києві</StateName>
            <ScanSheetNumber></ScanSheetNumber>
        </item>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Видалити експрес-накладну (JSON)

post

Метод delete працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод використовується для видалення експрес-накладної (інтернет-документа).

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "delete",
  "methodProperties": {
    "DocumentRefs": "00000000-0000-0000-0000-000000000000"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Видалити експрес-накладну (XML)

post

Метод delete працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод використовується для видалення експрес-накладної (інтернет-документа).

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 320

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>delete</calledMethod>
    <methodProperties>
        <DocumentRefs>00000000-0000-0000-0000-000000000000</DocumentRefs>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Сформувати запит для отримання повного звіту за накладними (JSON)

post

Метод generateReport працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод формує запит для отримання повного звіту за накладними.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "generateReport",
  "methodProperties": {
    "DocumentRefs": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ],
    "Type": "csv",
    "DateTime": "дд.мм.рррр"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "DateTime": "дд.мм.рррр",
      "PreferredDeliveryDate": "дд.мм.рррр",
      "Weight": "1",
      "SeatsAmount": "2",
      "IntDocNumber": "",
      "Cost": "500",
      "CitySender": "00000000-0000-0000-0000-000000000000",
      "CityRecipient": "00000000-0000-0000-0000-000000000000",
      "State": "",
      "SenderAddress": "00000000-0000-0000-0000-000000000000",
      "RecipientAddress": "00000000-0000-0000-0000-000000000000",
      "CostOnSite": "45",
      "PayerType": "Sender",
      "PaymentMethod": "Cash",
      "AfterpaymentOnGoodsCost": "500",
      "PackingNumber": "123456"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Сформувати запит для отримання повного звіту за накладними (XML)

post

Метод generateReport працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод формує запит для отримання повного звіту за накладними.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 503

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>generateReport</calledMethod>
    <methodProperties>
        <DocumentRefs>
            <item>00000000-0000-0000-0000-000000000000</item>
            <item>00000000-0000-0000-0000-000000000000</item>
        </DocumentRefs>
        <Type>csv</Type>
        <DateTime>дд.мм.рррр</DateTime>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <DateTime>дд.мм.рррр</DateTime>
            <PreferredDeliveryDate>дд.мм.рррр</PreferredDeliveryDate>
            <Weight>1</Weight>
            <SeatsAmount>2</SeatsAmount>
            <IntDocNumber></IntDocNumber>
            <Cost>500</Cost>
            <CitySender>00000000-0000-0000-0000-000000000000</CitySender>
            <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
            <State></State>
            <SenderAddress>00000000-0000-0000-0000-000000000000</SenderAddress>
            <RecipientAddress>00000000-0000-0000-0000-000000000000</RecipientAddress>
            <CostOnSite>45</CostOnSite>
            <PayerType>Sender</PayerType>
            <PaymentMethod>Cash</PaymentMethod>
            <AfterpaymentOnGoodsCost>500</AfterpaymentOnGoodsCost>
            <PackingNumber>123456</PackingNumber>
        </item>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Отримати список документів у заявці на виклик кур’єра (JSON)

post

Метод getEWTemplateList працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "getEWTemplateList",
  "methodProperties": {
    "Page": "1",
    "Limit": "1",
    "PickupNumber": "102-00258214",
    "State": "00000000-0000-0000-0000-000000000000",
    "IsPickupTable": "true"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "PayerType": "Recipient",
      "ScanSheetRef": "",
      "BackwardDeliveryCargoType": "Гроші",
      "EWNumber": null,
      "Number": "20400009196210",
      "RecipientCityRef": "",
      "OriginalGeoData": [
        {
          "RecipientAddressName": " ",
          "RecipientArea": " ",
          "RecipientAreaRegions": " ",
          "RecipientCityName": " ",
          "RecipientFlat": " ",
          "RecipientHouse": " "
        }
      ],
      "RecipientContactPhone": "380000000000",
      "ElevatorRecipient": "0",
      "StateId": "1",
      "DeliveryPharma": "",
      "TimeIntervalString": "",
      "Note": null,
      "RecipientDateTime": null,
      "PaymentMethod": "Cash",
      "RecipientPost": null,
      "ChangedDataEW": "0",
      "ScanSheetNumber": "",
      "IntDocNumber": "20400009196210",
      "SaturdayDelivery": null,
      "BackwardDeliverySum": "200",
      "RecipientStreetRef": "",
      "SecurePayment": "0",
      "ThirdPerson": null,
      "EWDateCreated": "2025-02-11 11:29:00",
      "CitySenderDescription": "Київ",
      "bCardPaymentPayed": "false",
      "SenderDescription": "Р.Б",
      "ScanSheetPrinted": "",
      "RecipientContactPerson": "Шульга Іван Тестович",
      "RecipientWarehouseRef": "",
      "ExpressWaybill": null,
      "SenderAddress": "7b422fc3-e1b8-11e3-8c4a-0050568002cf",
      "ScheduledDeliveryDate": null,
      "RedBoxBarcode": "",
      "Forwarding": null,
      "RecipientsPhone": "380000000000",
      "AfterpaymentOnGoodsCost": "5.00",
      "RecipientDescription": "Приватна особа",
      "Cost": "200",
      "CityRecipientDescription": "Київ",
      "StateName": "Тест",
      "bCardPaymentCancelled": "false",
      "CarCall": null,
      "RecipientAddress": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
      "DeliveryFrom": "Branch",
      "InfoRegClientBarcodes": "50",
      "WarehouseIllusha": "0",
      "AgeIdentification": "0",
      "IsTakeAttorney": "",
      "Promocode": "",
      "CargoType": "Documents",
      "LoyaltyCard": "00000000-0000-0000-0000-000000000000",
      "MarketplacePartnerDescription": "Бізнес-кабінет",
      "NumberOfFloorsLifting": "1",
      "DeliveryDateFrom": null,
      "EstimatedDeliveryDate": "2025-02-12 12:00:00",
      "ServiceType": "WarehouseWarehouse",
      "DeliveryByHand": "0",
      "DeliveryTo": "Branch",
      "Sender": "cae836a5-1aaa-11ec-80fb-b8830365bd04",
      "StatePayId": "0",
      "PackingNumber": "",
      "RecipientAddressDescription": "Склад ОП (Відділення №500): шосе Столичне, 103",
      "DateTime": "2025-02-11 11:29:22",
      "Ref": "a01c20b5-e85a-11ef-b619-005056bdc0e9",
      "RegionCode": "в500",
      "SettlementSender": "e718a680-4b33-11e4-ab6d-005056801329",
      "ForwardingCount": "0",
      "BackwardDeliveryMoney": "200",
      "ContactSender": "3d308a7a-e216-11ee-8ced-005056b2dbe1",
      "Vip": null,
      "LightReturn": "false",
      "Description": "Тестова посилка",
      "MarketplacePartnerToken": "005056887b8d-b5da-11e6-9f54-cea38574",
      "SameDayDelivery": "",
      "StatePayName": "",
      "PreferredDeliveryDate": "0001-01-01 00:00:00",
      "ExpressPallet": "",
      "CardPaymentRef": null,
      "StatementOfAcceptanceTransferCargoID": null,
      "CargoReturnRefusal": "0",
      "RecipientCounterpartyType": "PrivatePerson",
      "SenderContactPerson": "Іванова Алла Тестовна",
      "RejectionReason": null,
      "DateLastUpdatedStatus": "2025-02-11 11:29:22",
      "OwnershipForm": "",
      "LastModificationDate": null,
      "Recipient": "0494f0cd-0aa7-11ee-8ced-005056b2dbe1",
      "BackwardDeliveryData": [
        {
          "CargoType": "Гроші",
          "CargoTypeRef": "Money",
          "RedeliveryString": "200",
          "Type": " ",
          "TypeRef": " ",
          "PayerType": "Відправник",
          "PayerTypeRef": "Sender",
          "CustomBackwardDeliveryParameter": " ",
          "CustomBackwardDeliveryParameterRef": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "SettlementRecipient": "e718a680-4b33-11e4-ab6d-005056801329",
      "CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
      "TimeInterval": "",
      "MoneyTransferPayerType": "Sender",
      "WarehouseSender": null,
      "Weight": "0.50",
      "AviaDelivery": "",
      "DateLastPrint": null,
      "ReceiptDate": null,
      "OnlineCreditStatus": null,
      "DeletionMark": "false",
      "SettlmentAddressData": [
        {
          "SenderWarehouseRef": "7b422fc3-e1b8-11e3-8c4a-0050568002cf",
          "RecipientWarehouseRef": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
          "SenderWarehouseNumber": "3",
          "SenderWarehouseIndex": "ddd",
          "SenderAddressRef": "7b422fc3-e1b8-11e3-8c4a-0050568002cf",
          "RecipientWarehouseNumber": "500",
          "RecipientWarehouseIndex": "11/500",
          "RecipientAddressRef": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
          "SenderSettlementRef": "e718a680-4b33-11e4-ab6d-005056801329",
          "RecipientSettlementRef": "e718a680-4b33-11e4-ab6d-005056801329",
          "SenderSettlementDescription": "Київ",
          "RecipientSettlementDescription": "Київ",
          "SenderSettlementStreetDescription": " ",
          "RecipientSettlementStreetDescription": " ",
          "SenderSettlementStreetRef": " ",
          "RecipientSettlementStreetRef": " ",
          "SenderHouseNumber": " ",
          "RecipientHouseNumber": " ",
          "SenderFlatNumber": " ",
          "RecipientFlatNumber": " ",
          "SenderAddressNote": " ",
          "RecipientAddressNote": " "
        }
      ],
      "CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626",
      "TimeIntervalRef": "",
      "WarehouseRecipient": null,
      "ContactRecipient": "009a9819-ae1d-11ee-8ced-005056b2dbe1",
      "AdditionalInformation": "",
      "EDRPOU": "26565486",
      "FillingWarranty": "0",
      "AfterpaymentSum": "0.01",
      "Posted": null,
      "SenderAddressDescription": "Відділення №3: вул. Калачівська, 13 (Стара Дарниця)",
      "Redelivery": null,
      "SeatsAmount": "1",
      "CreateTime": "2025-02-11 11:29:00",
      "CostOnSite": "65.00",
      "LightReturnNumber": "",
      "Printed": "0",
      "Route": null,
      "CardMaskedNumber": "",
      "System": "PA 3.0",
      "SendersPhone": "380600000000",
      "RecipientFullName": null,
      "SaturdayDeliveryString": null
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Отримати список документів у заявці на виклик кур’єра (XML)

post

Метод getEWTemplateList працює в моделі InternetDocument (або InternetDocumentGeneral). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 463

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>getEWTemplateList</calledMethod>
    <methodProperties>
        <Page>1</Page>
        <Limit>1</Limit>
        <PickupNumber>102-00258214</PickupNumber>
        <State>00000000-0000-0000-0000-000000000000</State>
        <IsPickupTable>true</IsPickupTable>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <PayerType>Recipient</PayerType>
            <ScanSheetRef></ScanSheetRef>
            <BackwardDeliveryCargoType>Грощі</BackwardDeliveryCargoType>
            <EWNumber>null</EWNumber>
            <Number>20400009196210</Number>
            <RecipientCityRef></RecipientCityRef>
            <OriginalGeoData>
                <item>
                    <RecipientAddressName> </RecipientAddressName>
                    <RecipientArea> </RecipientArea>
                    <RecipientAreaRegions> </RecipientAreaRegions>
                    <RecipientCityName> </RecipientCityName>
                    <RecipientFlat> </RecipientFlat>
                    <RecipientHouse> </RecipientHouse>
                </item>
            </OriginalGeoData>
            <RecipientContactPhone>380000000000</RecipientContactPhone>
            <ElevatorRecipient>0</ElevatorRecipient>
            <StateId>1</StateId>
            <DeliveryPharma></DeliveryPharma>
            <TimeIntervalString></TimeIntervalString>
            <Note>null</Note>
            <RecipientDateTime>null</RecipientDateTime>
            <PaymentMethod>Cash</PaymentMethod>
            <RecipientPost>null</RecipientPost>
            <ChangedDataEW>0</ChangedDataEW>
            <ScanSheetNumber></ScanSheetNumber>
            <IntDocNumber>20400009196210</IntDocNumber>
            <SaturdayDelivery>null</SaturdayDelivery>
            <BackwardDeliverySum>200</BackwardDeliverySum>
            <RecipientStreetRef></RecipientStreetRef>
            <SecurePayment>0</SecurePayment>
            <ThirdPerson>null</ThirdPerson>
            <EWDateCreated>2025-02-11 11:29:00</EWDateCreated>
            <CitySenderDescription>Київ</CitySenderDescription>
            <bCardPaymentPayed>false</bCardPaymentPayed>
            <SenderDescription>Р.Б</SenderDescription>
            <ScanSheetPrinted></ScanSheetPrinted>
            <RecipientContactPerson>Шульга Іван Тестович</RecipientContactPerson>
            <RecipientWarehouseRef></RecipientWarehouseRef>
            <ExpressWaybill>null</ExpressWaybill>
            <SenderAddress>7b422fc3-e1b8-11e3-8c4a-0050568002cf</SenderAddress>
            <ScheduledDeliveryDate>null</ScheduledDeliveryDate>
            <RedBoxBarcode></RedBoxBarcode>
            <Forwarding>null</Forwarding>
            <RecipientsPhone>380000000000</RecipientsPhone>
            <AfterpaymentOnGoodsCost>5.00</AfterpaymentOnGoodsCost>
            <RecipientDescription>Приватна особа</RecipientDescription>
            <Cost>200</Cost>
            <CityRecipientDescription>Київ</CityRecipientDescription>
            <StateName>Тест</StateName>
            <bCardPaymentCancelled>false</bCardPaymentCancelled>
            <CarCall>null</CarCall>
            <RecipientAddress>1ec09d88-e1c2-11e3-8c4a-0050568002cf</RecipientAddress>
            <DeliveryFrom>Branch</DeliveryFrom>
            <InfoRegClientBarcodes>50</InfoRegClientBarcodes>
            <WarehouseIllusha>0</WarehouseIllusha>
            <AgeIdentification>0</AgeIdentification>
            <IsTakeAttorney></IsTakeAttorney>
            <Promocode></Promocode>
            <CargoType>Documents</CargoType>
            <LoyaltyCard>00000000-0000-0000-0000-000000000000</LoyaltyCard>
            <MarketplacePartnerDescription>Бізнес-кабінет</MarketplacePartnerDescription>
            <NumberOfFloorsLifting>1</NumberOfFloorsLifting>
            <DeliveryDateFrom>null</DeliveryDateFrom>
            <EstimatedDeliveryDate>2025-02-12 12:00:00</EstimatedDeliveryDate>
            <ServiceType>WarehouseWarehouse</ServiceType>
            <DeliveryByHand>0</DeliveryByHand>
            <DeliveryTo>Branch</DeliveryTo>
            <Sender>cae836a5-1aaa-11ec-80fb-b8830365bd04</Sender>
            <StatePayId>0</StatePayId>
            <PackingNumber></PackingNumber>
            <RecipientAddressDescription>Склад ОП (Відділення №500): шосе Столичне, 103</RecipientAddressDescription>
            <DateTime>2025-02-11 11:29:22</DateTime>
            <Ref>a01c20b5-e85a-11ef-b619-005056bdc0e9</Ref>
            <RegionCode>в500</RegionCode>
            <SettlementSender>e718a680-4b33-11e4-ab6d-005056801329</SettlementSender>
            <ForwardingCount>0</ForwardingCount>
            <BackwardDeliveryMoney>200</BackwardDeliveryMoney>
            <ContactSender>3d308a7a-e216-11ee-8ced-005056b2dbe1</ContactSender>
            <Vip>null</Vip>
            <LightReturn>false</LightReturn>
            <Description>Тестова посилка</Description>
            <MarketplacePartnerToken>005056887b8d-b5da-11e6-9f54-cea38574</MarketplacePartnerToken>
            <SameDayDelivery></SameDayDelivery>
            <StatePayName></StatePayName>
            <PreferredDeliveryDate>0001-01-01 00:00:00</PreferredDeliveryDate>
            <ExpressPallet></ExpressPallet>
            <CardPaymentRef>null</CardPaymentRef>
            <StatementOfAcceptanceTransferCargoID>null</StatementOfAcceptanceTransferCargoID>
            <CargoReturnRefusal>0</CargoReturnRefusal>
            <RecipientCounterpartyType>PrivatePerson</RecipientCounterpartyType>
            <SenderContactPerson>Іванова Алла Тестовна</SenderContactPerson>
            <RejectionReason>null</RejectionReason>
            <DateLastUpdatedStatus>2025-02-11 11:29:22</DateLastUpdatedStatus>
            <OwnershipForm></OwnershipForm>
            <LastModificationDate>null</LastModificationDate>
            <Recipient>0494f0cd-0aa7-11ee-8ced-005056b2dbe1</Recipient>
            <BackwardDeliveryData>
                <item>
                    <CargoType>Гроші</CargoType>
                    <CargoTypeRef>Money</CargoTypeRef>
                    <RedeliveryString>200</RedeliveryString>
                    <Type> </Type>
                    <TypeRef> </TypeRef>
                    <PayerType>Відправник</PayerType>
                    <PayerTypeRef>Sender</PayerTypeRef>
                    <CustomBackwardDeliveryParameter> </CustomBackwardDeliveryParameter>
                    <CustomBackwardDeliveryParameterRef>00000000-0000-0000-0000-000000000000</CustomBackwardDeliveryParameterRef>
                </item>
            </BackwardDeliveryData>
            <SettlementRecipient>e718a680-4b33-11e4-ab6d-005056801329</SettlementRecipient>
            <CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
            <TimeInterval></TimeInterval>
            <MoneyTransferPayerType>Sender</MoneyTransferPayerType>
            <WarehouseSender>null</WarehouseSender>
            <Weight>0.50</Weight>
            <AviaDelivery></AviaDelivery>
            <DateLastPrint>null</DateLastPrint>
            <ReceiptDate>null</ReceiptDate>
            <OnlineCreditStatus>null</OnlineCreditStatus>
            <DeletionMark>false</DeletionMark>
            <SettlmentAddressData>
                <item>
                    <SenderWarehouseRef>7b422fc3-e1b8-11e3-8c4a-0050568002cf</SenderWarehouseRef>
                    <RecipientWarehouseRef>1ec09d88-e1c2-11e3-8c4a-0050568002cf</RecipientWarehouseRef>
                    <SenderWarehouseNumber>3</SenderWarehouseNumber>
                    <SenderWarehouseIndex>ddd</SenderWarehouseIndex>
                    <SenderAddressRef>7b422fc3-e1b8-11e3-8c4a-0050568002cf</SenderAddressRef>
                    <RecipientWarehouseNumber>500</RecipientWarehouseNumber>
                    <RecipientWarehouseIndex>11/500</RecipientWarehouseIndex>
                    <RecipientAddressRef>1ec09d88-e1c2-11e3-8c4a-0050568002cf</RecipientAddressRef>
                    <SenderSettlementRef>e718a680-4b33-11e4-ab6d-005056801329</SenderSettlementRef>
                    <RecipientSettlementRef>e718a680-4b33-11e4-ab6d-005056801329</RecipientSettlementRef>
                    <SenderSettlementDescription>Київ</SenderSettlementDescription>
                    <RecipientSettlementDescription>Київ</RecipientSettlementDescription>
                    <SenderSettlementStreetDescription> </SenderSettlementStreetDescription>
                    <RecipientSettlementStreetDescription> </RecipientSettlementStreetDescription>
                    <SenderSettlementStreetRef> </SenderSettlementStreetRef>
                    <RecipientSettlementStreetRef> </RecipientSettlementStreetRef>
                    <SenderHouseNumber> </SenderHouseNumber>
                    <RecipientHouseNumber> </RecipientHouseNumber>
                    <SenderFlatNumber> </SenderFlatNumber>
                    <RecipientFlatNumber> </RecipientFlatNumber>
                    <SenderAddressNote> </SenderAddressNote>
                    <RecipientAddressNote> </RecipientAddressNote>
                </item>
            </SettlmentAddressData>
            <CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
            <TimeIntervalRef></TimeIntervalRef>
            <WarehouseRecipient>null</WarehouseRecipient>
            <ContactRecipient>009a9819-ae1d-11ee-8ced-005056b2dbe1</ContactRecipient>
            <AdditionalInformation></AdditionalInformation>
            <EDRPOU>26565486</EDRPOU>
            <FillingWarranty>0</FillingWarranty>
            <AfterpaymentSum>0.01</AfterpaymentSum>
            <Posted>null</Posted>
            <SenderAddressDescription>Відділення №3: вул. Калачівська, 13 (Стара Дарниця)</SenderAddressDescription>
            <Redelivery>null</Redelivery>
            <SeatsAmount>1</SeatsAmount>
            <CreateTime>2025-02-11 11:29:00</CreateTime>
            <CostOnSite>65.00</CostOnSite>
            <LightReturnNumber></LightReturnNumber>
            <Printed>0</Printed>
            <Route>null</Route>
            <CardMaskedNumber></CardMaskedNumber>
            <System>PA 3.0</System>
            <SendersPhone>380600000000</SendersPhone>
            <RecipientFullName>null</RecipientFullName>
            <SaturdayDeliveryString>null</SaturdayDeliveryString>
        </item>
    </data>
    <errors><errors/></errors>
    <warnings><warnings/></warnings>
    <info><info/></info>
    <messageCodes><messageCodes/></messageCodes>
    <errorCodes><errorCodes/></errorCodes>
    <warningCodes><warningCodes/></warningCodes>
    <infoCodes><infoCodes/></infoCodes>
</root>

Останнє оновлення