> 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/changelog-1/documentation-1/dodano-metodi-dlya-roboti-z-reyestrami-vidpravlen.md).

# Додано методи для роботи з реєстрами відправлень

## 1. Реєстри в Україні <a href="#id-1.-reyestri-v-ukrayini" id="id-1.-reyestri-v-ukrayini"></a>

**Обмеження:**

* реєстри можна створити лише на відправлення одного типу (міжнародні або в межах України);
* створюються лише на відправлення, які в статусі ReadyToShip;
* у всіх відправлень для реєстра одна точка відправки;
* користувач, який виконує операції з реєстром, пов’язаний з організацією-відправником (для юридичних осіб) або є відправником у відправленнях.

### 1.1 Створення нового реєстру з МЕН (ІД) <a href="#id-1.1-stvorennya-novogo-reyestru-z-men-id" id="id-1.1-stvorennya-novogo-reyestru-z-men-id"></a>

#### Опис <a href="#opis" id="opis"></a>

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

#### Запит  <a href="#zapit" id="zapit"></a>

Метод `POST v.1.0/registry`

```
{
  "description": "My_new_registry",
  "shipments": [
    "9f0d4b57-537e-11f1-b431-005056bd6036",
    "bf20249c-537e-11f1-b431-005056bd6036"
  ]
}
```

#### Відповідь <a href="#vidpovid" id="vidpovid"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
{
    "id": "d3de2df4-537e-11f1-b431-005056bd6036",
    "number": "106-00000944",
    "versionTracking": 1,
    "status": null,
    "createdAt": "2026-05-19 15:32:41.072817",
    "updatedAt": null,
    "deletedAt": null,
    "posted": false,
    "printed": false,
    "scannedBarcodesAmount": null,
    "forScanBarcodesAmount": null,
    "description": "My_new_registry",
    "senderCompanyId": "e06f386d-6da9-11de-99d6-002219c743f6",
    "senderCompanyTin": "1122333",
    "senderPhone": "380501112233",
    "senderCountryCode": "UA",
    "senderSettlementId": "126956",
    "senderSettlementExternalId": "0e7ddcd8-4b3a-11e4-ab6d-005056801329",
    "senderSettlementName": "Petropavlivska Borshchahivka",
    "senderDivisionId": "11217",
    "senderDivisionExternalId": "4b14fc45-7e39-4c8d-8bfc-56f4dc71e4c1",
    "senderDivisionName": "Post branch 3",
    "senderAddress": "Петропавлівська Борщагівка, Відділення №3 (до 30 кг на одне місце): вул. Соборна, 117-А",
    "senderAddressParts": {
        "city": "",
        "region": "",
        "street": "",
        "streetId": "",
        "postCode": "",
        "building": "",
        "flat": "",
        "block": "",
        "latitude": null,
        "longitude": null,
        "note": "",
        "addressId": null
    },
    "shipments": [
        {
            "shipmentId": "bf20249c-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51370078704480",
            "destinationDivision": null
        },
        {
            "shipmentId": "9f0d4b57-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51544030591411",
            "destinationDivision": null
        }
    ]
}
```

#### Помилки <a href="#pomilki" id="pomilki"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.2 Додавання МЕН (ІД) в існуючий реєстр <a href="#id-1.2-dodavannya-men-id-v-isnuyuchii-reyestr" id="id-1.2-dodavannya-men-id-v-isnuyuchii-reyestr"></a>

#### Опис <a href="#opis.1" id="opis.1"></a>

Цей метод використовується для додавання МЕН(ІД) в існуючий клієнтський реєстр.

#### Параметр адресного рядка <a href="#parametr-adresnogo-ryadka" id="parametr-adresnogo-ryadka"></a>

{id} - унікальний ідентифікатор реєстру

#### Запит  <a href="#zapit.1" id="zapit.1"></a>

Метод `POST v.1.0/registry/{id}/shipments`

```
{
  "shipments": [
     "f232ed31-537f-11f1-b431-005056bd6036"
  ]
}
```

#### Відповідь <a href="#vidpovid.1" id="vidpovid.1"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
{
    "id": "d3de2df4-537e-11f1-b431-005056bd6036",
    "number": "106-00000944",
    "versionTracking": 2,
    "status": null,
    "createdAt": "2026-05-19T15:32:41.072000Z",
    "updatedAt": "2026-05-19T12:33:12.484000Z",
    "deletedAt": null,
    "posted": false,
    "printed": false,
    "scannedBarcodesAmount": null,
    "description": "My_new_registry",
    "senderCompanyId": "e06f386d-6da9-11de-99d6-002219c743f6",
    "senderCompanyTin": "1122333",
    "senderPhone": "380501112233",
    "senderCountryCode": "UA",
    "senderSettlementId": "126956",
    "senderSettlementExternalId": "0e7ddcd8-4b3a-11e4-ab6d-005056801329",
    "senderSettlementName": "Petropavlivska Borshchahivka",
    "senderDivisionId": "11217",
    "senderDivisionExternalId": "4b14fc45-7e39-4c8d-8bfc-56f4dc71e4c1",
    "senderDivisionName": "Post branch 3",
    "senderAddress": "",
    "senderAddressParts": {
        "city": null,
        "region": null,
        "street": null,
        "streetId": null,
        "postCode": null,
        "building": null,
        "flat": null,
        "block": null,
        "latitude": null,
        "longitude": null,
        "note": null,
        "addressId": ""
    },
    "shipments": [
        {
            "shipmentId": "bf20249c-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51370078704480"
        },
        {
            "shipmentId": "9f0d4b57-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51544030591411"
        },
        {
            "shipmentId": "f232ed31-537f-11f1-b431-005056bd6036",
            "shipmentNumber": "51399912031968"
        }
    ]
}
```

#### Помилки <a href="#pomilki.1" id="pomilki.1"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.3 Видалення МЕН (ІД) з реєстру <a href="#id-1.3-vidalennya-men-id-z-reyestru" id="id-1.3-vidalennya-men-id-z-reyestru"></a>

#### Опис <a href="#opis.2" id="opis.2"></a>

Цей метод використовується для видалення МЕН(ІД) з існуючого клієнтського реєстру.

#### Параметр адресного рядка <a href="#parametr-adresnogo-ryadka.1" id="parametr-adresnogo-ryadka.1"></a>

{id} - унікальний ідентифікатор реєстру

#### Запит  <a href="#zapit.2" id="zapit.2"></a>

Метод `DELETE v.1.0/registry/{id}/shipments`

{id} - унікальний ідентифікатор реєстру

```
{
  "shipments": [
     "f232ed31-537f-11f1-b431-005056bd6036"
  ]
}
```

#### Відповідь <a href="#vidpovid.2" id="vidpovid.2"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
{
    "id": "d3de2df4-537e-11f1-b431-005056bd6036",
    "number": "106-00000944",
    "versionTracking": 2,
    "status": null,
    "createdAt": "2026-05-19T15:32:41.072000Z",
    "updatedAt": "2026-05-19T12:33:12.484000Z",
    "deletedAt": null,
    "posted": false,
    "printed": false,
    "scannedBarcodesAmount": null,
    "description": "My_new_registry",
    "senderCompanyId": "e06f386d-6da9-11de-99d6-002219c743f6",
    "senderCompanyTin": "1122333",
    "senderPhone": "380501112233",
    "senderCountryCode": "UA",
    "senderSettlementId": "126956",
    "senderSettlementExternalId": "0e7ddcd8-4b3a-11e4-ab6d-005056801329",
    "senderSettlementName": "Petropavlivska Borshchahivka",
    "senderDivisionId": "11217",
    "senderDivisionExternalId": "4b14fc45-7e39-4c8d-8bfc-56f4dc71e4c1",
    "senderDivisionName": "Post branch 3",
    "senderAddress": "",
    "senderAddressParts": {
        "city": null,
        "region": null,
        "street": null,
        "streetId": null,
        "postCode": null,
        "building": null,
        "flat": null,
        "block": null,
        "latitude": null,
        "longitude": null,
        "note": null,
        "addressId": ""
    },
    "shipments": [
        {
            "shipmentId": "bf20249c-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51370078704480"
        },
        {
            "shipmentId": "9f0d4b57-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51544030591411"
        }
    ]
}
```

#### Помилки <a href="#pomilki.2" id="pomilki.2"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.4 Видалення реєстру <a href="#id-1.4-vidalennya-reyestru" id="id-1.4-vidalennya-reyestru"></a>

#### Опис <a href="#opis.3" id="opis.3"></a>

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

#### Параметр адресного рядка <a href="#parametr-adresnogo-ryadka.2" id="parametr-adresnogo-ryadka.2"></a>

{id} - унікальний ідентифікатор реєстру

#### Запит  <a href="#zapit.3" id="zapit.3"></a>

Метод `DELETE v.1.0/registry/{id}`

#### Відповідь <a href="#vidpovid.3" id="vidpovid.3"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
{
    "success": true
}
```

#### Помилки <a href="#pomilki.3" id="pomilki.3"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.5 Перейменування реєстру <a href="#id-1.5-pereimenuvannya-reyestru" id="id-1.5-pereimenuvannya-reyestru"></a>

#### Опис <a href="#opis.4" id="opis.4"></a>

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

#### Параметр адресного рядка <a href="#parametr-adresnogo-ryadka.3" id="parametr-adresnogo-ryadka.3"></a>

{id} - унікальний ідентифікатор реєстру

#### Запит  <a href="#zapit.4" id="zapit.4"></a>

Метод `PUT v.1.0/registry/{id}/rename`

```
{
   "description": "new name for registry"
}
```

#### Відповідь <a href="#vidpovid.4" id="vidpovid.4"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
{
    "id": "d3de2df4-537e-11f1-b431-005056bd6036",
    "number": "106-00000944",
    "versionTracking": 5,
    "status": null,
    "createdAt": "2026-05-19T15:32:41.072000Z",
    "updatedAt": "2026-05-19T12:46:15.082000Z",
    "deletedAt": null,
    "posted": false,
    "printed": false,
    "scannedBarcodesAmount": null,
    "description": "new name for registry",
    "senderCompanyId": "e06f386d-6da9-11de-99d6-002219c743f6",
    "senderCompanyTin": "1122333",
    "senderPhone": "380501112233",
    "senderCountryCode": "UA",
    "senderSettlementId": "126956",
    "senderSettlementExternalId": "0e7ddcd8-4b3a-11e4-ab6d-005056801329",
    "senderSettlementName": "Petropavlivska Borshchahivka",
    "senderDivisionId": "11217",
    "senderDivisionExternalId": "4b14fc45-7e39-4c8d-8bfc-56f4dc71e4c1",
    "senderDivisionName": "Post branch 3",
    "senderAddress": "",
    "senderAddressParts": {
        "city": null,
        "region": null,
        "street": null,
        "streetId": null,
        "postCode": null,
        "building": null,
        "flat": null,
        "block": null,
        "latitude": null,
        "longitude": null,
        "note": null,
        "addressId": ""
    },
    "shipments": [
        {
            "shipmentId": "bf20249c-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51370078704480"
        },
        {
            "shipmentId": "9f0d4b57-537e-11f1-b431-005056bd6036",
            "shipmentNumber": "51544030591411"
        }
    ]
}
```

#### Помилки <a href="#pomilki.4" id="pomilki.4"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.6 Друк реєстру <a href="#id-1.6-druk-reyestru" id="id-1.6-druk-reyestru"></a>

#### Опис <a href="#opis.5" id="opis.5"></a>

Цей метод використовується для друку клієнтського реєстру і пов'язаних з ним сутностей:

* загальний реєстр
* міжнародні експрес-накладні,
* маркування міжнародних експрес-накладних,
* рахунки міжнародних експрес-накладних.

#### Параметри адресного рядка <a href="#parametri-adresnogo-ryadka" id="parametri-adresnogo-ryadka"></a>

| **Ім'я**        | **Тип** | **Значення**                                                                                                                           | **Опис**                                                                                                     |
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| id              | number  | **Приклад:** d3de2df4-537e-11f1-b431-005056bd6036                                                                                      | Ідентифікатор реєстру (обов'язкове)                                                                          |
| type\*          | string  | <p><strong>Приклад:</strong></p><ul><li><code>international</code></li><li><code>invoice</code></li><li><code>marking</code></li></ul> | Тип друкованої форми. Опціонально.                                                                           |
| printSizeType\* | string  | <p><strong>Приклад:</strong></p><ul><li><code>size\_100\_100</code></li></ul>                                                          | <p>Розмір для друку маркування.</p><p>Обов'язкове для<br><code>type</code>= <code>marking</code><br><br></p> |
| copies\*\*      | number  |                                                                                                                                        | <p>Number of copies of printed document (optional)<br>Default value</p>                                      |

#### Запит  <a href="#zapit.5" id="zapit.5"></a>

Метод `GET v.1.0/registry/print?id={id}`

#### Відповідь <a href="#vidpovid.5" id="vidpovid.5"></a>

Статус `200 OK Request successful. The server has responded as required.`

```
file
```

#### Помилки <a href="#pomilki.5" id="pomilki.5"></a>

| **Помилка** | **Значення**        |
| ----------- | ------------------- |
| 401         | Unauthorized        |
| 422         | Validation error    |
| 503         | Connection time-out |

### 1.7 Запит списку реєстрів <a href="#id-1.7-zapit-spisku-reyestriv" id="id-1.7-zapit-spisku-reyestriv"></a>

#### Опис <a href="#opis.6" id="opis.6"></a>

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

#### Параметри адресного рядка <a href="#parametri-adresnogo-ryadka.1" id="parametri-adresnogo-ryadka.1"></a>

|     **Поле**     | **Тип** |                **Можливе значення**               |                                                                                   **Опис**                                                                                  |
| :--------------: | :-----: | :-----------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|      ids\[]      |  string | **Приклад:** fb161018-52af-11f1-b431-005056bd6036 |                                                     Унікальні ідентифікатори реєстру, для яких слід отримати інформацію.                                                    |
|    numbers\[]    |  string |             **Приклад:** 106-00000901             |                                                        Унікальний номер реєстру, для якого слід отримати інформацію.                                                        |
| settlementIds\[] |  string |                **Приклад:** 126956                |                                                                 Унікальний ідентифікатор населеного пункту.                                                                 |
|   createdAtFrom  |   date  |              **Приклад:** 01.05.2026              | Дата початку періоду фільтрації реєстру. Використовується для отримання записів, створених з цієї дати включно. Поле `createdAtFrom` має бути датою раніше за `createdAtTo` |
|    createdAtTo   |   date  |              **Приклад:** 01.05.2026              |                           Дата закінчення періоду фільтрації реєстру. Використовується для отримання записів, створених до цієї дати (не включно).                          |
|       page       | integer |                   **Приклад:** 1                  |                                                                        Номер сторінки для повернення.                                                                       |
|       limit      | integer |                   **Приклад:** 1                  |                                                         Максимальна кількість елементів для повернення на сторінці.                                                         |

#### Запит  <a href="#zapit.6" id="zapit.6"></a>

Метод `GET v.1.0/registry`

#### Відповідь <a href="#vidpovid.6" id="vidpovid.6"></a>

Статус `200 OK Request successful. The server has responded as required.`

#### Помилки <a href="#pomilki.6" id="pomilki.6"></a>

<table data-header-hidden><thead><tr><th width="374" align="center"></th><th align="center"></th></tr></thead><tbody><tr><td align="center"><strong>Помилка</strong></td><td align="center"><strong>Значення</strong></td></tr><tr><td align="center">401</td><td align="center">Unauthorized</td></tr><tr><td align="center">422</td><td align="center">Validation error</td></tr><tr><td align="center">503</td><td align="center">Connection time-out</td></tr></tbody></table>


---

# 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/changelog-1/documentation-1/dodano-metodi-dlya-roboti-z-reyestrami-vidpravlen.md?ask=<question>
```

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.