Page 4

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

post

/json

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

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

Body

apiKeystringRequired

API ключ.

modelNamestringRequiredExample: InternetDocumentGeneral

calledMethodstringRequiredExample: save

Responses

200

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

application/json

successbooleanOptional

Вказує, чи було запит успішно оброблено.

post/json

POST /v.1.0/json HTTP/1.1
Host: api-stage.novapost.pl/
Content-Type: application/json
Accept: */*
Content-Length: 987

{
  "apiKey": "[YOUR_API_KEY]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "25.06.2026",
    "CargoType": "Cargo",
    "VolumeGeneral": "0.45",
    "Weight": "0.5",
    "ServiceType": "DoorsWarehouse",
    "SeatsAmount": "2",
    "Description": "Additional shipment 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": "Kyiv",
    "RecipientArea": "Kyivska",
    "RecipientAreaRegions": "Kyivskyi",
    "RecipientAddressName": "1",
    "RecipientHouse": "",
    "RecipientFlat": "",
    "RecipientName": "Ivan Ivanov",
    "RecipientType": "PrivatePerson",
    "SettlementType": "City",
    "OwnershipForm": "00000000-0000-0000-0000-000000000000",
    "RecipientContactName": "Ivan Ivanov",
    "EDRPOU": "12345678"
  }
}

200

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

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

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

post

/xml

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

Body

apiKeystringRequired

API ключ.

modelNamestringRequiredExample: InternetDocumentGeneral

calledMethodstringRequiredExample: save

Responses

200

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

application/xml

successbooleanOptional

Вказує, чи було запит успішно оброблено.

post/xml

POST /v.1.0/xml HTTP/1.1
Host: api-stage.novapost.pl/
Content-Type: application/xml
Accept: */*
Content-Length: 1604

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[YOUR_API_KEY]</apiKey>
  <modelName>InternetDocumentGeneral</modelName>
  <calledMethod>save</calledMethod>
  <methodProperties>
    <PayerType>Sender</PayerType>
    <PaymentMethod>Cash</PaymentMethod>
    <DateTime>25.06.2026</DateTime>
    <CargoType>Cargo</CargoType>
    <VolumeGeneral>0.45</VolumeGeneral>
    <Weight>0.5</Weight>
    <ServiceType>DoorsWarehouse</ServiceType>
    <SeatsAmount>2</SeatsAmount>
    <Description>Additional shipment 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>Kyiv</RecipientCityName>
    <RecipientArea>Kyivska</RecipientArea>
    <RecipientAreaRegions>Kyivskyi</RecipientAreaRegions>
    <RecipientAddressName>1</RecipientAddressName>
    <RecipientHouse></RecipientHouse>
    <RecipientFlat></RecipientFlat>
    <RecipientName>Ivan Ivanov</RecipientName>
    <RecipientType>PrivatePerson</RecipientType>
    <SettlementType>City</SettlementType>
    <OwnershipForm>00000000-0000-0000-0000-000000000000</OwnershipForm>
    <RecipientContactName>Ivan Ivanov</RecipientContactName>
    <EDRPOU>12345678</EDRPOU>
  </methodProperties>
</file>
"

200

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

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

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

post

/json

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

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

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

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

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

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

Приклад:

"BackwardDeliveryData":
[
  {
    "PayerType": "Sender або Recipient",
    "CargoType": "Documents",
    "RedeliveryString": ""
  }
]

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

Body

apiKeystringRequired

API ключ.

modelNamestringRequiredExample: InternetDocumentGeneral

calledMethodstringRequiredExample: save

Responses

200

Приклад XML-запиту для створення експрес-накладної зі зворотною доставкою

application/json

successbooleanOptional

Вказує, чи було запит успішно оброблено.

post/json

POST /v.1.0/json HTTP/1.1
Host: api-stage.novapost.pl/
Content-Type: application/json
Accept: */*
Content-Length: 1124

{
  "apiKey": "[YOUR_API_KEY]",
  "modelName": "InternetDocumentGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "DateTime": "25.06.2026",
    "CargoType": "Cargo",
    "Weight": "0.5",
    "ServiceType": "DoorsWarehouse",
    "SeatsAmount": "2",
    "Description": "Additional shipment 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

Приклад XML-запиту для створення експрес-накладної зі зворотною доставкою

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

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

post

/xml

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

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

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

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

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"
      }
    ]
  }
]

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

Приклад:

"BackwardDeliveryData":
[
  {
    "PayerType": "Sender або Recipient",
    "CargoType": "Documents",
    "RedeliveryString": ""
  }
]

Body

apiKeystringRequired

API ключ.

modelNamestringRequiredExample: InternetDocumentGeneral

calledMethodstringRequiredExample: save

Responses

200

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

application/xml

successbooleanOptional

Вказує, чи було запит успішно оброблено.

post/xml

POST /v.1.0/xml HTTP/1.1
Host: api-stage.novapost.pl/
Content-Type: application/xml
Accept: */*
Content-Length: 1855

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[YOUR_API_KEY]</apiKey>
    <modelName>InternetDocumentGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</PaymentMethod>
        <DateTime>25.06.2026</DateTime>
        <CargoType>Cargo</CargoType>
        <Weight>0.5</Weight>
        <ServiceType>DoorsWarehouse</ServiceType>
        <SeatsAmount>2</SeatsAmount>
        <Description>Additional shipment 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 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>

Last updated 1 month ago