> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/metodi-1/metodi/readme/reyestri.md).
# Реєстри
## Отримати реєстри
> Метод дозволяє отримати інформацію про власні реєстри користувача або реєстри, пов’язані з його профілем у реєстрі.\
> \
> 🔸Реєстри автоматично фільтруються за джерелом створення (\`clientapi\` або \`bc\`) залежно від використаного методу.\\
> 🔸Відправлення, які були видалені з реєстру, не включаються до відповіді.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry":{"get":{"tags":["Registers"],"summary":"Отримати реєстри","description":"Метод дозволяє отримати інформацію про власні реєстри користувача або реєстри, пов’язані з його профілем у реєстрі.\n\n🔸Реєстри автоматично фільтруються за джерелом створення (`clientapi` або `bc`) залежно від використаного методу.\n🔸Відправлення, які були видалені з реєстру, не включаються до відповіді.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"isEURegistry","description":"Вказує, що необхідно повернути європейські реєстри.\n","schema":{"type":"boolean"}},{"in":"query","name":"ids[]","description":"Унікальні ідентифікатори реєстрів, для яких необхідно отримати інформацію. Цей параметр є обов’язковим, якщо не вказано параметр `numbers`.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"numbers[]","description":"Унікальні номери реєстрів, для яких необхідно отримати інформацію. Цей параметр є обов’язковим, якщо не вказано параметр `ids`.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"settlementIds[]","description":"Унікальний ідентифікатор населеного пункту.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"withShipmentsInfo","description":"Якщо встановлено значення `true`, відповідь міститиме розширену інформацію про відправлення в масиві `shipmentsInfo`.\n\nЯкщо параметр не вказано або встановлено значення `false`, відповідь міститиме лише `shipmentId` та `shipmentNumber` у масиві `shipments`.\n","schema":{"type":"boolean"}},{"in":"query","name":"createdAtFrom","description":"Початкова дата періоду фільтрації реєстрів. Використовується для отримання записів, створених починаючи з цієї дати (включно). Значення поля `createdAtFrom` повинно бути раніше за `createdAtTo`.","schema":{"type":"string","format":"date"}},{"in":"query","name":"createdAtTo","description":"Кінцева дата періоду фільтрації реєстрів. Використовується для отримання записів, створених до цієї дати (не включно).","schema":{"type":"string","format":"date"}},{"in":"query","name":"page","description":"Номер сторінки, яку необхідно повернути.","schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Максимальна кількість елементів, що повертаються на сторінці.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Список реєстрів","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Номер поточної сторінки у відповіді з пагінацією.\n"},"last_page":{"type":"integer","description":"Загальна кількість доступних сторінок.\n"},"per_page":{"type":"integer","description":"Кількість записів реєстрів, що повертаються на одній сторінці.\n"},"total":{"type":"integer","description":"Загальна кількість реєстрів, що відповідають критеріям запиту.\n"},"items":{"type":"array","description":"Масив об’єктів реєстрів.\nКожен реєстр об’єднує відправлення та пов’язані з ними метадані.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Унікальний ідентифікатор реєстру, згенерований системою.\n"},"number":{"type":"string","description":"Номер реєстру у форматі:\nCR + код країни + унікальний числовий ідентифікатор.\n"},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення реєстру.\n"},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення реєстру.\n"},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення реєстру, якщо його було видалено.\n"},"posted":{"type":"boolean","description":"Визначає, чи було опубліковано реєстр.\n- `true` — реєстр опубліковано\n- `false` — реєстр не опубліковано\n"},"printed":{"type":"boolean","description":"Визначає, чи було надруковано реєстр.\n"},"description":{"type":"string","description":"Назва реєстру, задана користувачем.\n"},"status":{"type":"string","description":"Поточний статус реєстру.\n"},"type":{"type":"string","description":"Тип реєстру.\nЯкщо реєстр створено через API, значення завжди дорівнює `Client`.\n","enum":["Client"]},"createdByUser":{"type":"string","description":"Ідентифікатор користувача, який створив реєстр.\n"},"scannedBarcodesAmount":{"type":"integer","description":"Кількість відправлень, включених до реєстру.\n"},"source":{"type":"string","description":"Джерело створення реєстру (наприклад, `clientapi`).\n"},"companyId":{"type":"string","description":"Ідентифікатор компанії.\n"},"companyTin":{"type":"string","description":"Податковий ідентифікаційний номер компанії.\n"},"companyName":{"type":"string","description":"Назва компанії.\n"},"fullName":{"type":"string","description":"Повне ім’я відправника з першого відправлення у реєстрі.\n"},"phone":{"type":"string","description":"Номер телефону відправника з першого відправлення.\n"},"countryCode":{"type":"string","description":"Код країни відправника у форматі ISO 3166-1 alpha-2.\n"},"country":{"type":"string","description":"Країна відправника.\n"},"settlementId":{"type":"string","description":"Ідентифікатор населеного пункту відправника.\n"},"settlementName":{"type":"string","description":"Назва населеного пункту відправника.\n"},"divisionId":{"type":"string","description":"Ідентифікатор відділення відправника.\n"},"divisionName":{"type":"string","description":"Назва відділення відправника.\n"},"address":{"type":"string","description":"Повна адреса відправника у текстовому форматі.\n"},"addressParts":{"type":"object","description":"Структурований об’єкт адреси, що містить детальну інформацію про адресу.\n\nВикористовується для точної маршрутизації, забору відправлення кур’єром, доставки та митного оформлення.\n","properties":{"city":{"type":"string","description":"Назва міста."},"region":{"type":"string","description":"Назва регіону, області або адміністративної одиниці."},"street":{"type":"string","description":"Назва вулиці."},"streetId":{"type":"string","description":"Унікальний ідентифікатор вулиці."},"postCode":{"type":"string","description":"Поштовий індекс."},"building":{"type":"string","description":"Номер або назва будівлі."},"flat":{"type":"string","description":"Номер квартири або приміщення."},"block":{"type":"string","description":"Корпус або секція будівлі."},"latitude":{"type":"number","description":"Географічна широта."},"longitude":{"type":"number","description":"Географічна довгота."},"note":{"type":"string","description":"Додаткові відомості або інструкції щодо адреси."},"addressId":{"type":"string","description":"Унікальний ідентифікатор адреси в системі."}}},"currencyCode":{"type":"string","description":"Код валюти.\n"},"shipments":{"type":"array","description":"Масив об’єктів відправлень, включених до реєстру.\n\nПовертається, якщо параметр `withShipmentsInfo` не вказано або встановлено значення `false`.\n","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Унікальний ідентифікатор відправлення.\n"},"shipmentNumber":{"type":"string","description":"Номер відправлення.\n"}}}},"shipmentsInfo":{"type":"array","description":"Масив об’єктів відправлень, включених до реєстру.\n\nПовертається, якщо `withShipmentsInfo=true`.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Ідентифікатор відправлення."},"number":{"type":"string","description":"Номер відправлення."},"totalWeight":{"type":"integer","description":"Загальна вага відправлення у грамах."},"totalCost":{"type":"number","description":"Загальна вартість відправлення."},"currencyCode":{"type":"string","description":"Код валюти відправлення."},"invoice":{"type":"boolean","description":"Визначає, чи існує інвойс."}}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Створити реєстр відправлень
> Метод використовується для створення \*\*клієнтського реєстру відправлень\*\*, який об’єднує кілька відправлень в один документ для подальшої обробки.\
> \
> Цей метод доступний для відправлень \*\*з будь-якої країни світу до будь-якої країни світу\*\*.\
> \
> \*\*Обмеження при роботі з реєстрами:\*\*\
> 1\. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.\
> 2\. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.\
> 3\. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).\
> 4\. Відправлення, позначене на видалення, не може бути додане до реєстру.\
> 5\. Максимальна кількість відправлень в одному реєстрі — \*\*100\*\*.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry":{"post":{"tags":["Registers"],"summary":"Створити реєстр відправлень","description":"Метод використовується для створення **клієнтського реєстру відправлень**, який об’єднує кілька відправлень в один документ для подальшої обробки.\n\nЦей метод доступний для відправлень **з будь-якої країни світу до будь-якої країни світу**.\n\n**Обмеження при роботі з реєстрами:**\n1. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.\n2. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.\n3. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).\n4. Відправлення, позначене на видалення, не може бути додане до реєстру.\n5. Максимальна кількість відправлень в одному реєстрі — **100**.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["description","shipments"],"properties":{"description":{"type":"string","description":"Назва реєстру."},"shipments":{"type":"array","description":"Масив унікальних номерів міжнародних відправлень.\nКожне відправлення повинно належати одному й тому самому відправнику.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Унікальний номер міжнародного відправлення."}}},"description":"Запит на створення реєстру"}}}},"responses":{"200":{"description":"Реєстр успішно створено.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Унікальний ідентифікатор реєстру."},"number":{"type":"string","description":"Номер реєстру у форматі:\n`CR + альфа-код країни з першого відправлення + унікальний номер`.\n"},"versionTracking":{"type":"string","description":"Ідентифікатор відстеження версії реєстру."},"status":{"type":"string","description":"Статус реєстру. Після створення статус має значення `Open`."},"createdAt":{"type":"string","format":"date-time","description":"Дата створення реєстру."},"updatedAt":{"type":"string","format":"date-time","description":"Дата оновлення реєстру."},"deletedAt":{"type":"string","description":"Дата видалення реєстру."},"posted":{"type":"boolean","description":"Статус опубліковано реєстру."},"printed":{"type":"boolean","description":"Статус друку реєстру."},"scannedBarcodesAmount":{"type":"integer","description":"Кількість відправлень у реєстрі."},"forScanBarcodesAmount":{"type":"integer","description":"Кількість відправлень, що очікують на сканування."},"description":{"type":"string","description":"Назва реєстру, вказана під час створення."},"senderCompanyId":{"type":"string","description":"Ідентифікатор компанії відправника."},"senderCompanyTin":{"type":"string","description":"ІПН компанії відправника."},"senderPhone":{"type":"string","description":"Номер телефону відправника."},"senderCountryCode":{"type":"string","description":"Код країни відправника у форматі ISO 3166-1 alpha-2."},"senderSettlementId":{"type":"string","description":"Ідентифікатор населеного пункту відправника."},"senderSettlementExternalId":{"type":"string"},"senderSettlementName":{"type":"string","description":"Назва населеного пункту відправника."},"senderDivisionId":{"type":"string","description":"Ідентифікатор відділення відправника."},"senderDivisionExternalId":{"type":"string"},"senderDivisionName":{"type":"string","description":"Назва відділення відправника."},"senderAddress":{"type":"string","description":"Повна адреса відправника одним рядком."},"senderAddressParts":{"type":"object","description":"Структуровані дані адреси відправника.","properties":{"city":{"type":"string","description":"Назва міста."},"region":{"type":"string","description":"Назва регіону або адміністративної одиниці."},"street":{"type":"string","description":"Назва вулиці."},"streetId":{"type":"string","description":"Ідентифікатор вулиці."},"postCode":{"type":"string","description":"Поштовий індекс."},"building":{"type":"string","description":"Номер будинку."},"flat":{"type":"string","description":"Номер квартири або офісу."},"block":{"type":"string","description":"Корпус або секція."},"latitude":{"type":"number","format":"double","description":"Географічна широта адреси."},"longitude":{"type":"number","format":"double","description":"Географічна довгота адреси."},"note":{"type":"string","description":"Додаткова примітка до адреси."},"addressId":{"type":"string","description":"Ідентифікатор адреси."}}},"shipments":{"type":"array","description":"Список відправлень, доданих до реєстру.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Унікальний ідентифікатор відправлення."},"shipmentNumber":{"type":"string","description":"Унікальний номер відправлення."},"destinationDivision":{"type":"object","description":"Інформація про відділення одержувача.","properties":{"name":{"type":"string","description":"Назва відділення одержувача."},"id":{"type":"integer","description":"Ідентифікатор відділення одержувача."},"number":{"type":"string","description":"Номер відділення одержувача."}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Додати відправлення до реєстру
> Цей метод дозволяє додавати посилку до існуючого реєстру відправлень, що спрощує подальше оформлення відправки.\
> \
> Метод підтримує:\
> \- Європейські відправлення (номери відправлень у форматі \`SHPL...\`)\
> \- Українські відправлення (ідентифікатори MEN/ID)\
> \
> \*\*Обмеження при роботі з реєстрами:\*\*\
> \
> 1\. Цей метод доступний для відправлень з будь-якої країни світу до будь-якої країни світу.\
> 2\. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.\
> 3\. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.\
> 4\. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).\
> 5\. Відправлення, позначене на видалення, не може бути додане до реєстру.\
> 6\. Максимальна кількість відправлень в одному реєстрі — \*\*100\*\*.\
> \
> Цей метод використовується для додавання вже створених відправлень до існуючого реєстру.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/shipments":{"post":{"tags":["Registers"],"summary":"Додати відправлення до реєстру","description":"Цей метод дозволяє додавати посилку до існуючого реєстру відправлень, що спрощує подальше оформлення відправки.\n\nМетод підтримує:\n- Європейські відправлення (номери відправлень у форматі `SHPL...`)\n- Українські відправлення (ідентифікатори MEN/ID)\n\n**Обмеження при роботі з реєстрами:**\n\n1. Цей метод доступний для відправлень з будь-якої країни світу до будь-якої країни світу.\n2. Відправлення може бути додане до реєстру лише за умови, що дані відправника (місто, контрагент, адреса) є однаковими для всіх відправлень, які додаються.\n3. Відправлення може бути додане лише до одного реєстру — один і той самий документ не може одночасно входити до кількох реєстрів.\n4. Відправлення може бути додане до реєстру лише до моменту створення для нього експрес-накладної (або до моменту сканування відправлення у відділенні Нової пошти).\n5. Відправлення, позначене на видалення, не може бути додане до реєстру.\n6. Максимальна кількість відправлень в одному реєстрі — **100**.\n\nЦей метод використовується для додавання вже створених відправлень до існуючого реєстру.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Унікальний ідентифікатор реєстру, до якого буде додано відправлення.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["shipments"],"properties":{"shipments":{"type":"array","description":"Масив ідентифікаторів відправлень, які необхідно додати до реєстру.\nКожне відправлення повинно належати одному й тому самому відправнику.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Унікальний номер відправлення."}}}}}}},"responses":{"200":{"description":"Реєстр","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Унікальний ідентифікатор реєстру."},"number":{"type":"string","description":"Номер реєстру."},"versionTracking":{"type":"integer","nullable":true,"description":"Номер версії реєстру."},"status":{"type":"string","description":"Статус реєстру."},"createdAt":{"type":"string","format":"date-time","description":"Дата створення реєстру."},"updatedAt":{"type":"string","format":"date-time","description":"Дата оновлення реєстру."},"deletedAt":{"type":"string","nullable":true,"description":"Дата видалення реєстру."},"posted":{"type":"boolean","description":"Позначка опублікування реєстру."},"printed":{"type":"boolean","description":"Позначка друку реєстру."},"scannedBarcodesAmount":{"type":"integer","description":"Кількість відправлень у реєстрі."},"description":{"type":"string","description":"Назва реєстру, задана користувачем."},"senderCompanyId":{"type":"string","nullable":true,"description":"Ідентифікатор компанії відправника."},"senderCompanyTin":{"type":"string","description":"Податковий ідентифікаційний номер компанії відправника."},"senderPhone":{"type":"string","description":"Номер телефону відправника."},"senderCountryCode":{"type":"string","description":"Код країни відправника."},"senderSettlementId":{"type":"string","description":"Ідентифікатор населеного пункту відправника."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор населеного пункту."},"senderSettlementName":{"type":"string","description":"Назва населеного пункту відправника."},"senderDivisionId":{"type":"string","description":"Ідентифікатор відділення відправника."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор відділення."},"senderDivisionName":{"type":"string","description":"Назва відділення відправника."},"senderAddress":{"type":"string","description":"Повна адреса відправника."},"senderAddressParts":{"type":"object","description":"Структурована інформація про адресу відправника.","properties":{"city":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"streetId":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"building":{"type":"string","nullable":true},"flat":{"type":"string","nullable":true},"block":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"note":{"type":"string","nullable":true},"addressId":{"type":"string","nullable":true}}},"shipments":{"type":"array","description":"Список відправлень, включених до реєстру.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Унікальний ідентифікатор відправлення."},"shipmentNumber":{"type":"string","description":"Номер відправлення."},"destinationDivision":{"type":"object","nullable":true,"description":"Інформація про відділення призначення. Повертається для європейських реєстрів.","properties":{"name":{"type":"string"},"id":{"type":"integer"},"number":{"type":"string"}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Видалити відправлення з реєстру
> Метод дозволяє видаляти відправлення з існуючого клієнтського реєстру.\
> \
> Метод підтримує:\
> \- Європейські відправлення (номери відправлень у форматі \`SHPL...\`)\
> \- Українські відправлення (ідентифікатори MEN/ID)\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/shipments":{"delete":{"tags":["Registers"],"summary":"Видалити відправлення з реєстру","description":"Метод дозволяє видаляти відправлення з існуючого клієнтського реєстру.\n\nМетод підтримує:\n- Європейські відправлення (номери відправлень у форматі `SHPL...`)\n- Українські відправлення (ідентифікатори MEN/ID)\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Унікальний ідентифікатор реєстру, з якого необхідно видалити відправлення.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["shipments"],"properties":{"shipments":{"type":"array","description":"Масив ідентифікаторів відправлень, які необхідно видалити з реєстру.\nКожне відправлення повинно належати одному й тому самому відправнику.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Унікальний номер відправлення."}}}}}}},"responses":{"200":{"description":"Відправлення успішно видалено з реєстру.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Унікальний ідентифікатор реєстру."},"number":{"type":"string","description":"Номер реєстру."},"versionTracking":{"type":"integer","nullable":true,"description":"Номер версії реєстру."},"status":{"type":"string","nullable":true,"description":"Статус реєстру."},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення реєстру."},"updatedAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата та час оновлення реєстру."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата та час видалення реєстру."},"posted":{"type":"boolean","nullable":true,"description":"Визначає, чи було опубліковано реєстр."},"printed":{"type":"boolean","nullable":true,"description":"Визначає, чи було надруковано реєстр."},"scannedBarcodesAmount":{"type":"integer","nullable":true,"description":"Кількість відправлень у реєстрі."},"description":{"type":"string","description":"Назва реєстру."},"senderCompanyId":{"type":"string","nullable":true,"description":"Ідентифікатор компанії відправника."},"senderCompanyTin":{"type":"string","description":"Податковий ідентифікаційний номер компанії відправника."},"senderPhone":{"type":"string","description":"Номер телефону відправника."},"senderCountryCode":{"type":"string","description":"Код країни відправника (ISO Alpha-2)."},"senderSettlementId":{"type":"string","description":"Ідентифікатор населеного пункту відправника."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор населеного пункту."},"senderSettlementName":{"type":"string","description":"Назва населеного пункту відправника."},"senderDivisionId":{"type":"string","description":"Ідентифікатор відділення відправника."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор відділення."},"senderDivisionName":{"type":"string","description":"Назва відділення відправника."},"senderAddress":{"type":"string","description":"Адреса відправника."},"senderAddressParts":{"type":"object","description":"Структурована адреса відправника."},"shipments":{"type":"array","description":"Список відправлень, що залишилися в реєстрі.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Ідентифікатор відправлення."},"shipmentNumber":{"type":"string","description":"Номер відправлення."}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Перейменувати реєстр
> Метод дозволяє перейменувати існуючий реєстр.\
> \
> Метод підтримує:\
> \- Європейські відправлення (номери відправлень у форматі \`SHPL...\`)\
> \- Українські відправлення (ідентифікатори MEN/ID)\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/rename":{"put":{"tags":["Registers"],"summary":"Перейменувати реєстр","description":"Метод дозволяє перейменувати існуючий реєстр.\n\nМетод підтримує:\n- Європейські відправлення (номери відправлень у форматі `SHPL...`)\n- Українські відправлення (ідентифікатори MEN/ID)\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Унікальний ідентифікатор реєстру.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["description"],"properties":{"description":{"type":"string","description":"Нова назва реєстру."}}}}}},"responses":{"200":{"description":"Запит успішно виконано. Реєстр було перейменовано.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"id":{"type":"string","description":"Унікальний ідентифікатор реєстру."},"number":{"type":"string","description":"Номер реєстру."},"versionTracking":{"type":"integer","nullable":true,"description":"Номер версії реєстру."},"status":{"type":"string","nullable":true,"description":"Статус реєстру."},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення реєстру."},"updatedAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата та час оновлення реєстру."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата та час видалення реєстру."},"posted":{"type":"boolean","nullable":true,"description":"Визначає, чи було опубліковано реєстр."},"printed":{"type":"boolean","nullable":true,"description":"Визначає, чи було надруковано реєстр."},"scannedBarcodesAmount":{"type":"integer","nullable":true,"description":"Кількість відправлень у реєстрі."},"description":{"type":"string","description":"Назва реєстру."},"senderCompanyId":{"type":"string","nullable":true,"description":"Ідентифікатор компанії відправника."},"senderCompanyTin":{"type":"string","description":"Податковий ідентифікаційний номер компанії відправника."},"senderPhone":{"type":"string","description":"Номер телефону відправника."},"senderCountryCode":{"type":"string","description":"Код країни відправника (ISO Alpha-2)."},"senderSettlementId":{"type":"string","description":"Ідентифікатор населеного пункту відправника."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор населеного пункту."},"senderSettlementName":{"type":"string","description":"Назва населеного пункту відправника."},"senderDivisionId":{"type":"string","description":"Ідентифікатор відділення відправника."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"Зовнішній ідентифікатор відділення."},"senderDivisionName":{"type":"string","description":"Назва відділення відправника."},"senderAddress":{"type":"string","description":"Адреса відправника."},"senderAddressParts":{"type":"object","description":"Структурована адреса відправника."},"shipments":{"type":"array","description":"Відправлення, включені до реєстру.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Ідентифікатор відправлення."},"shipmentNumber":{"type":"string","description":"Номер відправлення."}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Видалити реєстр
> Метод дозволяє видалити існуючий реєстр.\
> \
> 🔸Наразі видалення реєстру можливе лише після видалення всіх відправлень з реєстру.\
> \
> Метод підтримує:\
> \- Європейські відправлення (номери відправлень у форматі \`SHPL...\`)\
> \- Українські відправлення (ідентифікатори MEN/ID)\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}":{"delete":{"tags":["Registers"],"summary":"Видалити реєстр","description":"Метод дозволяє видалити існуючий реєстр.\n\n🔸Наразі видалення реєстру можливе лише після видалення всіх відправлень з реєстру.\n\nМетод підтримує:\n- Європейські відправлення (номери відправлень у форматі `SHPL...`)\n- Українські відправлення (ідентифікатори MEN/ID)\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Унікальний ідентифікатор реєстру, який необхідно видалити.","schema":{"type":"string"}}],"responses":{"200":{"description":"Запит успішно виконано. Реєстр було видалено.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Визначає, чи було успішно видалено реєстр."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Друк реєстру відправлень
> Метод дозволяє отримати згенерований PDF-файл зі списком клієнтських відправлень для подальшого друку.\
> \
> Відповідь повертається у вигляді згенерованого файлу та містить реєстр для друку зі списком відправлень, включених до вибраного реєстру.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\\
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, який відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\\
> Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}}},"paths":{"/registry/print":{"get":{"tags":["Registers"],"summary":"Друк реєстру відправлень","description":"Метод дозволяє отримати згенерований PDF-файл зі списком клієнтських відправлень для подальшого друку.\n\nВідповідь повертається у вигляді згенерованого файлу та містить реєстр для друку зі списком відправлень, включених до вибраного реєстру.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.\n- **Multiline description**\n Розширений опис, який відображає більше одного рядка тексту.\n\n**EXAMPLE**\nПоказує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"id","required":true,"description":"Ідентифікатор реєстру в системі.","schema":{"type":"integer"}},{"in":"query","name":"type","required":false,"description":"Тип документа для друку.\n\nЗастосовується лише до **українських** реєстрів.\n\nДоступні значення:\n- `international` — документи для міжнародних відправлень\n- `invoice` — інвойси відправлень\n- `marking` — маркувальні етикетки відправлень\n","schema":{"type":"string","enum":["international","invoice","marking"]}},{"in":"query","name":"printSizeType","required":false,"description":"Розмір друку маркування.\n\nЗастосовується лише до **українських** реєстрів.\n\nОбов’язковий для `type=marking`.\n","schema":{"type":"string","enum":["size_100_100"]}},{"in":"query","name":"copies","required":false,"description":"Кількість копій документа для друку.","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Згенерований файл.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"422":{"description":"Неможливо обробити запит.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}}}},"500":{"description":"Внутрішня помилка сервера.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://api-portal.novapost.com/metodi-1/metodi/readme/reyestri.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.