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

1. Реєстри в Україні

Обмеження:

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

1.1 Створення нового реєстру з МЕН (ІД)

Опис

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

Запит

Метод POST v.1.0/registry

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

Відповідь

Статус 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
        }
    ]
}

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

1.2 Додавання МЕН (ІД) в існуючий реєстр

Опис

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

Параметр адресного рядка

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

Запит

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

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

Відповідь

Статус 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"
        }
    ]
}

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

1.3 Видалення МЕН (ІД) з реєстру

Опис

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

Параметр адресного рядка

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

Запит

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

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

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

Відповідь

Статус 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"
        }
    ]
}

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

1.4 Видалення реєстру

Опис

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

Параметр адресного рядка

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

Запит

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

Відповідь

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

{
    "success": true
}

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

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

Опис

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

Параметр адресного рядка

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

Запит

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

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

Відповідь

Статус 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"
        }
    ]
}

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

1.6 Друк реєстру

Опис

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

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

Параметри адресного рядка

Ім'я

Тип

Значення

Опис

number

Приклад: d3de2df4-537e-11f1-b431-005056bd6036

Ідентифікатор реєстру (обов'язкове)

type*

string

Приклад:

international
invoice
marking

Тип друкованої форми. Опціонально.

printSizeType*

string

Приклад:

size_100_100

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

Обов'язкове для type= marking

copies**

number

Number of copies of printed document (optional) Default value

Запит

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

Відповідь

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

file

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out

1.7 Запит списку реєстрів

Опис

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

Параметри адресного рядка

Поле

Тип

Можливе значення

Опис

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

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

Запит

Метод GET v.1.0/registry

Відповідь

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

Помилки

Помилка

Значення

401

Unauthorized

422

Validation error

503

Connection time-out