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

Реєстри

Отримати реєстри

get
/registry

Метод дозволяє отримати інформацію про власні реєстри користувача або реєстри, пов’язані з його профілем у реєстрі.

🔸Реєстри автоматично фільтруються за джерелом створення (clientapi або bc) залежно від використаного методу. 🔸Відправлення, які були видалені з реєстру, не включаються до відповіді.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Query parameters
isEURegistrybooleanOptional

Вказує, що необхідно повернути європейські реєстри.

Example: true
ids[]string[]Optional

Унікальні ідентифікатори реєстрів, для яких необхідно отримати інформацію. Цей параметр є обов’язковим, якщо не вказано параметр numbers.

Example: 85544
numbers[]string[]Optional

Унікальні номери реєстрів, для яких необхідно отримати інформацію. Цей параметр є обов’язковим, якщо не вказано параметр ids.

Example: CRPL0000004829
settlementIds[]string[]Optional

Унікальний ідентифікатор населеного пункту.

Example: 22326
withShipmentsInfobooleanOptional

Якщо встановлено значення true, відповідь міститиме розширену інформацію про відправлення в масиві shipmentsInfo.

Якщо параметр не вказано або встановлено значення false, відповідь міститиме лише shipmentId та shipmentNumber у масиві shipments.

Example: true
createdAtFromstring · dateOptional

Початкова дата періоду фільтрації реєстрів. Використовується для отримання записів, створених починаючи з цієї дати (включно). Значення поля createdAtFrom повинно бути раніше за createdAtTo.

Example: 23.09.2025
createdAtTostring · dateOptional

Кінцева дата періоду фільтрації реєстрів. Використовується для отримання записів, створених до цієї дати (не включно).

Example: 25.09.2025
pageintegerOptional

Номер сторінки, яку необхідно повернути.

Example: 1
limitintegerOptional

Максимальна кількість елементів, що повертаються на сторінці.

Example: 10
Responses
200

Список реєстрів

application/json
current_pageintegerOptional

Номер поточної сторінки у відповіді з пагінацією.

last_pageintegerOptional

Загальна кількість доступних сторінок.

per_pageintegerOptional

Кількість записів реєстрів, що повертаються на одній сторінці.

totalintegerOptional

Загальна кількість реєстрів, що відповідають критеріям запиту.

get/registry
GET /v.1.0/registry HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_page": 1,
  "last_page": 1,
  "per_page": 15,
  "total": 1,
  "items": [
    {
      "id": "948086",
      "number": "CRPL0000041723",
      "createdAt": "2026-05-19T14:46:28.232000Z",
      "updatedAt": "2026-05-20T07:01:01.787000Z",
      "deletedAt": null,
      "posted": false,
      "printed": false,
      "description": "new name",
      "status": "Open",
      "type": "Client",
      "createdByUser": "255ea89d-8c1f-47ec-8f2e-64486bd24f5f",
      "scannedBarcodesAmount": 0,
      "source": "clientapi",
      "companyId": null,
      "companyTin": "",
      "companyName": "Private person",
      "fullName": "Oksana Hrechaniuk",
      "phone": "48512345678",
      "countryCode": "PL",
      "country": "Poland",
      "settlementId": "22326",
      "settlementName": "Warsaw",
      "divisionId": "1888318",
      "divisionName": "Post branch 11",
      "address": "02-495, Polska, Województwo mazowieckie, Warszawa County, Warszawa, Stanisława Wojciechowskiego, 39 lok.1, , , ",
      "addressParts": {
        "city": "Warszawa",
        "region": "Warszawa County",
        "street": "Stanisława Wojciechowskiego",
        "streetId": null,
        "postCode": "02-495",
        "building": "39 lok.1",
        "flat": "",
        "block": "",
        "latitude": 52.1947201268,
        "longitude": 20.8706685393,
        "note": null
      },
      "currencyCode": "PLN",
      "shipmentsInfo": [
        {
          "id": "3168550",
          "number": "SHPL0462195188",
          "totalWeight": 2000,
          "totalCost": 65,
          "currencyCode": "PLN",
          "invoice": true
        }
      ]
    }
  ]
}

Створити реєстр відправлень

post
/registry

Метод використовується для створення клієнтського реєстру відправлень, який об’єднує кілька відправлень в один документ для подальшої обробки.

Цей метод доступний для відправлень з будь-якої країни світу до будь-якої країни світу.

Обмеження при роботі з реєстрами:

  1. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.

  2. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.

  3. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).

  4. Відправлення, позначене на видалення, не може бути додане до реєстру.

  5. Максимальна кількість відправлень в одному реєстрі — 100.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Body

Запит на створення реєстру

descriptionstringRequired

Назва реєстру.

shipmentsstring[] · min: 1 · max: 100Required

Масив унікальних номерів міжнародних відправлень. Кожне відправлення повинно належати одному й тому самому відправнику.

Responses
200

Реєстр успішно створено.

application/json
idstringOptional

Унікальний ідентифікатор реєстру.

numberstringOptional

Номер реєстру у форматі: CR + альфа-код країни з першого відправлення + унікальний номер.

versionTrackingstringOptional

Ідентифікатор відстеження версії реєстру.

statusstringOptional

Статус реєстру. Після створення статус має значення Open.

createdAtstring · date-timeOptional

Дата створення реєстру.

updatedAtstring · date-timeOptional

Дата оновлення реєстру.

deletedAtstringOptional

Дата видалення реєстру.

postedbooleanOptional

Статус опубліковано реєстру.

printedbooleanOptional

Статус друку реєстру.

scannedBarcodesAmountintegerOptional

Кількість відправлень у реєстрі.

forScanBarcodesAmountintegerOptional

Кількість відправлень, що очікують на сканування.

descriptionstringOptional

Назва реєстру, вказана під час створення.

senderCompanyIdstringOptional

Ідентифікатор компанії відправника.

senderCompanyTinstringOptional

ІПН компанії відправника.

senderPhonestringOptional

Номер телефону відправника.

senderCountryCodestringOptional

Код країни відправника у форматі ISO 3166-1 alpha-2.

senderSettlementIdstringOptional

Ідентифікатор населеного пункту відправника.

senderSettlementExternalIdstringOptional
senderSettlementNamestringOptional

Назва населеного пункту відправника.

senderDivisionIdstringOptional

Ідентифікатор відділення відправника.

senderDivisionExternalIdstringOptional
senderDivisionNamestringOptional

Назва відділення відправника.

senderAddressstringOptional

Повна адреса відправника одним рядком.

post/registry
POST /v.1.0/registry HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "description": "My_new_registry",
  "shipments": [
    "SHPL0462195188"
  ]
}
{
  "id": 948086,
  "number": "CRPL0000041723",
  "versionTracking": null,
  "status": "Open",
  "createdAt": "2026-05-19T14:46:28.232180Z",
  "updatedAt": "2026-05-19T14:46:28.232180Z",
  "deletedAt": null,
  "posted": null,
  "printed": null,
  "scannedBarcodesAmount": 1,
  "forScanBarcodesAmount": 0,
  "description": "My_new_registry",
  "senderCompanyId": null,
  "senderCompanyTin": "",
  "senderPhone": "48512345678",
  "senderCountryCode": "PL",
  "senderSettlementId": "22326",
  "senderSettlementExternalId": null,
  "senderSettlementName": "Warsaw",
  "senderDivisionId": "1888318",
  "senderDivisionExternalId": null,
  "senderDivisionName": "Post branch 11",
  "senderAddress": "02-495, Polska, Województwo mazowieckie, Warszawa County, Warszawa, Stanisława Wojciechowskiego, 39 lok.1, , , ",
  "senderAddressParts": {
    "city": "Warszawa",
    "region": "Warszawa County",
    "street": "Stanisława Wojciechowskiego",
    "streetId": null,
    "postCode": "02-495",
    "building": "39 lok.1",
    "flat": "",
    "block": "",
    "latitude": 52.1947201268,
    "longitude": 20.8706685393,
    "note": "",
    "addressId": null
  },
  "shipments": [
    {
      "shipmentId": "1401932",
      "shipmentNumber": "SHPL0462195188",
      "destinationDivision": {
        "name": "WARSZAWA 11",
        "id": 1888318,
        "number": "02/11"
      }
    }
  ]
}

Додати відправлення до реєстру

post
/registry/{id}/shipments

Цей метод дозволяє додавати посилку до існуючого реєстру відправлень, що спрощує подальше оформлення відправки.

Метод підтримує:

  • Європейські відправлення (номери відправлень у форматі SHPL...)

  • Українські відправлення (ідентифікатори MEN/ID)

Обмеження при роботі з реєстрами:

  1. Цей метод доступний для відправлень з будь-якої країни світу до будь-якої країни світу.

  2. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.

  3. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.

  4. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).

  5. Відправлення, позначене на видалення, не може бути додане до реєстру.

  6. Максимальна кількість відправлень в одному реєстрі — 100.

Цей метод використовується для додавання вже створених відправлень до існуючого реєстру.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор реєстру, до якого буде додано відправлення.

Example: 111111
Body
shipmentsstring[] · min: 1 · max: 100Required

Масив ідентифікаторів відправлень, які необхідно додати до реєстру. Кожне відправлення повинно належати одному й тому самому відправнику.

Responses
200

Реєстр

application/json
idstringOptional

Унікальний ідентифікатор реєстру.

numberstringOptional

Номер реєстру.

versionTrackinginteger · nullableOptional

Номер версії реєстру.

statusstringOptional

Статус реєстру.

createdAtstring · date-timeOptional

Дата створення реєстру.

updatedAtstring · date-timeOptional

Дата оновлення реєстру.

deletedAtstring · nullableOptional

Дата видалення реєстру.

postedbooleanOptional

Позначка опублікування реєстру.

printedbooleanOptional

Позначка друку реєстру.

scannedBarcodesAmountintegerOptional

Кількість відправлень у реєстрі.

descriptionstringOptional

Назва реєстру, задана користувачем.

senderCompanyIdstring · nullableOptional

Ідентифікатор компанії відправника.

senderCompanyTinstringOptional

Податковий ідентифікаційний номер компанії відправника.

senderPhonestringOptional

Номер телефону відправника.

senderCountryCodestringOptional

Код країни відправника.

senderSettlementIdstringOptional

Ідентифікатор населеного пункту відправника.

senderSettlementExternalIdstring · nullableOptional

Зовнішній ідентифікатор населеного пункту.

senderSettlementNamestringOptional

Назва населеного пункту відправника.

senderDivisionIdstringOptional

Ідентифікатор відділення відправника.

senderDivisionExternalIdstring · nullableOptional

Зовнішній ідентифікатор відділення.

senderDivisionNamestringOptional

Назва відділення відправника.

senderAddressstringOptional

Повна адреса відправника.

post/registry/{id}/shipments
POST /v.1.0/registry/{id}/shipments HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "shipments": [
    "SHPL8187197311"
  ]
}
{
  "id": "948086",
  "number": "CRPL0000041723",
  "versionTracking": null,
  "status": "Open",
  "createdAt": "2026-05-19T14:46:28.232000Z",
  "updatedAt": "2026-05-19T14:46:28.574000Z",
  "deletedAt": null,
  "posted": false,
  "printed": false,
  "scannedBarcodesAmount": 2,
  "description": "My_new_registry",
  "senderCompanyId": null,
  "senderCompanyTin": "",
  "senderPhone": "48512345678",
  "senderCountryCode": "PL",
  "senderSettlementId": "22326",
  "senderSettlementExternalId": null,
  "senderSettlementName": "Warsaw",
  "senderDivisionId": "1888318",
  "senderDivisionExternalId": null,
  "senderDivisionName": "Post branch 11",
  "senderAddress": "02-495, Polska, Województwo mazowieckie, Warszawa County, Warszawa, Stanisława Wojciechowskiego, 39 lok.1, , , ",
  "senderAddressParts": {
    "city": "Warszawa",
    "region": "Warszawa County",
    "street": "Stanisława Wojciechowskiego",
    "streetId": null,
    "postCode": "02-495",
    "building": "39 lok.1",
    "flat": "",
    "block": "",
    "latitude": 52.1947201268,
    "longitude": 20.8706685393,
    "note": null,
    "addressId": null
  },
  "shipments": [
    {
      "shipmentId": "3168550",
      "shipmentNumber": "SHPL0462195188"
    },
    {
      "shipmentId": "3168827",
      "shipmentNumber": "SHPL8187197311"
    }
  ]
}

Видалити відправлення з реєстру

delete
/registry/{id}/shipments

Метод дозволяє видаляти відправлення з існуючого клієнтського реєстру.

Метод підтримує:

  • Європейські відправлення (номери відправлень у форматі SHPL...)

  • Українські відправлення (ідентифікатори MEN/ID)

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор реєстру, з якого необхідно видалити відправлення.

Example: 111111
Body
shipmentsstring[] · min: 1 · max: 100Required

Масив ідентифікаторів відправлень, які необхідно видалити з реєстру. Кожне відправлення повинно належати одному й тому самому відправнику.

Responses
200

Відправлення успішно видалено з реєстру.

application/json
idstringOptional

Унікальний ідентифікатор реєстру.

numberstringOptional

Номер реєстру.

versionTrackinginteger · nullableOptional

Номер версії реєстру.

statusstring · nullableOptional

Статус реєстру.

createdAtstring · date-timeOptional

Дата та час створення реєстру.

updatedAtstring · date-time · nullableOptional

Дата та час оновлення реєстру.

deletedAtstring · date-time · nullableOptional

Дата та час видалення реєстру.

postedboolean · nullableOptional

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

printedboolean · nullableOptional

Визначає, чи було надруковано реєстр.

scannedBarcodesAmountinteger · nullableOptional

Кількість відправлень у реєстрі.

descriptionstringOptional

Назва реєстру.

senderCompanyIdstring · nullableOptional

Ідентифікатор компанії відправника.

senderCompanyTinstringOptional

Податковий ідентифікаційний номер компанії відправника.

senderPhonestringOptional

Номер телефону відправника.

senderCountryCodestringOptional

Код країни відправника (ISO Alpha-2).

senderSettlementIdstringOptional

Ідентифікатор населеного пункту відправника.

senderSettlementExternalIdstring · nullableOptional

Зовнішній ідентифікатор населеного пункту.

senderSettlementNamestringOptional

Назва населеного пункту відправника.

senderDivisionIdstringOptional

Ідентифікатор відділення відправника.

senderDivisionExternalIdstring · nullableOptional

Зовнішній ідентифікатор відділення.

senderDivisionNamestringOptional

Назва відділення відправника.

senderAddressstringOptional

Адреса відправника.

senderAddressPartsobjectOptional

Структурована адреса відправника.

delete/registry/{id}/shipments
DELETE /v.1.0/registry/{id}/shipments HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "shipments": [
    "SHPL8187197311"
  ]
}
{
  "id": "948086",
  "number": "CRPL0000041723",
  "versionTracking": null,
  "status": "Open",
  "createdAt": "2026-05-19T14:46:28.232000Z",
  "updatedAt": "2026-05-19T14:46:28.574000Z",
  "deletedAt": null,
  "posted": false,
  "printed": false,
  "scannedBarcodesAmount": 1,
  "description": "My_new_registry",
  "senderCompanyId": null,
  "senderCompanyTin": "",
  "senderPhone": "48512345678",
  "senderCountryCode": "PL",
  "senderSettlementId": "22326",
  "senderSettlementExternalId": null,
  "senderSettlementName": "Warsaw",
  "senderDivisionId": "1888318",
  "senderDivisionExternalId": null,
  "senderDivisionName": "Post branch 11",
  "senderAddress": "02-495, Polska, Województwo mazowieckie, Warszawa County, Warszawa, Stanisława Wojciechowskiego, 39 lok.1, , , ",
  "senderAddressParts": {
    "city": "Warszawa",
    "region": "Warszawa County",
    "street": "Stanisława Wojciechowskiego",
    "streetId": null,
    "postCode": "02-495",
    "building": "39 lok.1",
    "flat": "",
    "block": "",
    "latitude": 52.1947201268,
    "longitude": 20.8706685393,
    "note": null,
    "addressId": null
  },
  "shipments": [
    {
      "shipmentId": "3168550",
      "shipmentNumber": "SHPL0462195188"
    }
  ]
}

Перейменувати реєстр

put
/registry/{id}/rename

Метод дозволяє перейменувати існуючий реєстр.

Метод підтримує:

  • Європейські відправлення (номери відправлень у форматі SHPL...)

  • Українські відправлення (ідентифікатори MEN/ID)

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор реєстру.

Example: 111111
Body
descriptionstringRequired

Нова назва реєстру.

Responses
200

Запит успішно виконано. Реєстр було перейменовано.

application/json
idstringOptional

Унікальний ідентифікатор реєстру.

numberstringOptional

Номер реєстру.

versionTrackinginteger · nullableOptional

Номер версії реєстру.

statusstring · nullableOptional

Статус реєстру.

createdAtstring · date-timeOptional

Дата та час створення реєстру.

updatedAtstring · date-time · nullableOptional

Дата та час оновлення реєстру.

deletedAtstring · date-time · nullableOptional

Дата та час видалення реєстру.

postedboolean · nullableOptional

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

printedboolean · nullableOptional

Визначає, чи було надруковано реєстр.

scannedBarcodesAmountinteger · nullableOptional

Кількість відправлень у реєстрі.

descriptionstringOptional

Назва реєстру.

senderCompanyIdstring · nullableOptional

Ідентифікатор компанії відправника.

senderCompanyTinstringOptional

Податковий ідентифікаційний номер компанії відправника.

senderPhonestringOptional

Номер телефону відправника.

senderCountryCodestringOptional

Код країни відправника (ISO Alpha-2).

senderSettlementIdstringOptional

Ідентифікатор населеного пункту відправника.

senderSettlementExternalIdstring · nullableOptional

Зовнішній ідентифікатор населеного пункту.

senderSettlementNamestringOptional

Назва населеного пункту відправника.

senderDivisionIdstringOptional

Ідентифікатор відділення відправника.

senderDivisionExternalIdstring · nullableOptional

Зовнішній ідентифікатор відділення.

senderDivisionNamestringOptional

Назва відділення відправника.

senderAddressstringOptional

Адреса відправника.

senderAddressPartsobjectOptional

Структурована адреса відправника.

put/registry/{id}/rename
PUT /v.1.0/registry/{id}/rename HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "description": "new name"
}
{
  "id": "948086",
  "number": "CRPL0000041723",
  "versionTracking": null,
  "status": "Open",
  "createdAt": "2026-05-19T14:46:28.232000Z",
  "updatedAt": "2026-05-19T14:46:28.574000Z",
  "deletedAt": null,
  "posted": false,
  "printed": false,
  "scannedBarcodesAmount": 1,
  "description": "new name",
  "senderCompanyId": null,
  "senderCompanyTin": "",
  "senderPhone": "48512345678",
  "senderCountryCode": "PL",
  "senderSettlementId": "22326",
  "senderSettlementExternalId": null,
  "senderSettlementName": "Warsaw",
  "senderDivisionId": "1888318",
  "senderDivisionExternalId": null,
  "senderDivisionName": "Post branch 11",
  "senderAddress": "02-495, Polska, Województwo mazowieckie, Warszawa County, Warszawa, Stanisława Wojciechowskiego, 39 lok.1, , , ",
  "senderAddressParts": {
    "city": "Warszawa",
    "region": "Warszawa County",
    "street": "Stanisława Wojciechowskiego",
    "streetId": null,
    "postCode": "02-495",
    "building": "39 lok.1",
    "flat": "",
    "block": "",
    "latitude": 52.1947201268,
    "longitude": 20.8706685393,
    "note": null,
    "addressId": null
  },
  "shipments": [
    {
      "shipmentId": "3168550",
      "shipmentNumber": "SHPL0462195188"
    }
  ]
}

Видалити реєстр

delete
/registry/{id}

Метод дозволяє видалити існуючий реєстр.

🔸Наразі видалення реєстру можливе лише після видалення всіх відправлень з реєстру.

Метод підтримує:

  • Європейські відправлення (номери відправлень у форматі SHPL...)

  • Українські відправлення (ідентифікатори MEN/ID)

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор реєстру, який необхідно видалити.

Example: 111111
Responses
200

Запит успішно виконано. Реєстр було видалено.

application/json
successbooleanRequired

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

delete/registry/{id}
DELETE /v.1.0/registry/{id} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Друк реєстру відправлень

get
/registry/print

Метод дозволяє отримати згенерований PDF-файл зі списком клієнтських відправлень для подальшого друку.

Відповідь повертається у вигляді згенерованого файлу та містить реєстр для друку зі списком відправлень, включених до вибраного реєстру.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Query parameters
idintegerRequired

Ідентифікатор реєстру в системі.

Example: 85544
typestring · enumOptional

Тип документа для друку.

Застосовується лише до українських реєстрів.

Доступні значення:

  • international — документи для міжнародних відправлень
  • invoice — інвойси відправлень
  • marking — маркувальні етикетки відправлень
Example: internationalPossible values:
printSizeTypestring · enumOptional

Розмір друку маркування.

Застосовується лише до українських реєстрів.

Обов’язковий для type=marking.

Example: size_100_100Possible values:
copiesintegerOptional

Кількість копій документа для друку.

Default: 1Example: 2
Responses
200

Згенерований файл.

application/octet-stream
string · binaryOptional
get/registry/print
GET /v.1.0/registry/print?id=1 HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

binary
ПопередняПовторна доставка
НаступнаКур'єрська доставка

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