> 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/dovidniki.md).
# Довідники
## Знайти одиниці вимірювання
> Цей API метод дозволяє отримати список одиниць вимірювання, таких як штуки, метри або кілограми, які можна використовувати для опису товарів у метричній системі. Відповідь містить деталі щодо кожної одиниці вимірювання, зокрема код, назву та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/dictionary/measurements":{"get":{"tags":["Довідники"],"description":"Цей API метод дозволяє отримати список одиниць вимірювання, таких як штуки, метри або кілограми, які можна використовувати для опису товарів у метричній системі. Відповідь містить деталі щодо кожної одиниці вимірювання, зокрема код, назву та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"limit","description":"Максимальна кількість записів на сторінці.","schema":{"type":"integer","format":"int32","default":15}},{"in":"query","name":"page","description":"Номер сторінки для повернення","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Одиниці вимірювання","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Поточна сторінка.","minimum":1},"last_page":{"type":"integer","description":"Загальна кількість знайдених сторінок.","minimum":1},"per_page":{"type":"integer","description":"Поточний ліміт об’єктів на одній сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість знайдених об’єктів.","minimum":0},"from":{"type":"integer","nullable":true},"to":{"type":"integer","nullable":true},"items":{"type":"array","description":"Список одиниць вимірювання, які можна використовувати для опису товарів у метричній системі.","items":{"type":"object","properties":{"code":{"type":"string","description":"Код одиниці вимірювання."},"name":{"type":"string","description":"Назва одиниці вимірювання.","minLength":2,"maxLength":100},"shortname":{"type":"string","description":"Скорочена назва одиниці вимірювання.","minLength":1,"maxLength":20},"createdAt":{"type":"string","description":"Дата й час додавання елемента до списку."},"updatedAt":{"type":"string","description":"Дата й час оновлення елемента."},"deletedAt":{"type":"string","description":"Дата й час видалення; якщо не видалено — null.","nullable":true}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Знайти одиниці вимірювання"}}}}
```
## Знайти відділення
> Цей API метод дозволяє отримати список власних і партнерських вантажних відділень (divisions) та поштоматів, доступних у межах країни. Передаючи код країни як параметр, можна отримати повний перелік відділень і пов’язану з ними інформацію. Відповідь зазвичай містить такі дані, як назва відділення, номер, адреса, ідентифікатор, інформація про країну та місто, тип відділення й інші релевантні атрибути. Ці дані можуть бути використані для створення транспортного документа (відправлення).\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/divisions":{"get":{"tags":["Довідники"],"description":"Цей API метод дозволяє отримати список власних і партнерських вантажних відділень (divisions) та поштоматів, доступних у межах країни. Передаючи код країни як параметр, можна отримати повний перелік відділень і пов’язану з ними інформацію. Відповідь зазвичай містить такі дані, як назва відділення, номер, адреса, ідентифікатор, інформація про країну та місто, тип відділення й інші релевантні атрибути. Ці дані можуть бути використані для створення транспортного документа (відправлення).\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"header","name":"Accept-language","description":"Щоб отримати опис відділення певною мовою, передайте необхідний мовний код (стандарт ISO 639-1) у header-параметрі з назвою `accept-language`. Якщо переклад для вибраної мови відсутній, буде показано англійську мову.","schema":{"type":"string","enum":["cz","de","en","es","fr","et","hu","it","lt","lv","nl","pl","ro","sk","uk"]}},{"in":"query","name":"countryCodes[]","description":"Щоб отримати список вантажних відділень і поштоматів у певній країні, виберіть потрібний код країни зі списку. Використовуйте код відповідно до стандарту ISO 3166-1 Alpha-2.","schema":{"type":"array","items":{"type":"string","enum":["CZ","DE","EE","ES","FR","GB","HU","IT","LT","LV","MD","NL","PL","RO","SK","UA"]}}},{"in":"query","name":"limit","description":"Максимальна кількість елементів у відповіді.","schema":{"type":"integer","format":"int32","default":15}},{"in":"query","name":"page","description":"Номер сторінки для повернення.","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"settlementIds[]","description":"Список ідентифікаторів населених пунктів, що використовується для фільтрації відділень або терміналів за місцем розташування. Кожен ID відповідає унікальному населеному пункту в системі.","schema":{"type":"array","items":{"type":"integer"}}},{"in":"query","name":"divisionCategories[]","description":"Визначає операційну категорію відділення, щоб зазначити його тип і функцію в логістичній мережі. Можна використовувати одну або кілька категорій зі списку.","schema":{"type":"array","items":{"type":"string","enum":["Postomat","PostBranch","CargoBranch","PUDO"]}}},{"in":"query","name":"statuses[]","description":"Фільтрує відділення за їхнім операційним статусом. Вказує, чи активне відділення, тимчасово закрите або перебуває в підготовці до відкриття.","schema":{"type":"array","items":{"type":"string","enum":["Working","NotWorking","NotWorkingTemporary","InProcessOpening"]}}},{"in":"query","name":"prohibitedSending","description":"Вказує, чи доступне відправлення посилок із цього відділення. Якщо `true`, відправлення з цього відділення неможливе.","schema":{"type":"boolean","enum":[true,false]}},{"in":"query","name":"prohibitedIssuance","description":"Вказує, чи доступна доставка посилок до цього відділення. Якщо `true`, отримання посилок у цьому відділенні неможливе.","schema":{"type":"boolean","enum":[true,false]}},{"in":"query","name":"latitude","description":"Географічна широта відділення, що використовується для відображення на мапі та розрахунку відстаней. Приклад значення: 49.8005164984.\n","schema":{"type":"number","format":"float"}},{"in":"query","name":"longitude","description":"Географічна довгота відділення, що використовується для відображення на мапі та розрахунку відстаней. Приклад значення: 22.9404162762.\n","schema":{"type":"number","format":"float"}}],"responses":{"200":{"description":"Відділення","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Поточна сторінка.","minimum":1},"last_page":{"type":"integer","description":"Загальна кількість знайдених сторінок.","minimum":1},"per_page":{"type":"integer","description":"Поточний ліміт об’єктів на одній сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість знайдених об’єктів.","minimum":0},"from":{"type":"integer","nullable":true},"to":{"type":"integer","nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Ідентифікатор відділення.","minimum":1},"name":{"type":"string","description":"Назва відділення.","minLength":1},"shortName":{"type":"string","description":"Коротка назва відділення.","minLength":1},"externalId":{"type":"string","description":"Внутрішні дані, не для використання."},"source":{"type":"string","description":"Джерело інформації про відділення (наприклад, NPUA, NPAX, InPost, NPDepartment, NPMD1C, GLS_CZ, DPD, Venipak, SPS, ExpressOne. Список розширюється в міру підключення нових партнерів).","nullable":true},"countryCode":{"type":"string","description":"Код країни, у якій розташоване відділення, відповідно до стандарту ISO 3166-1 Alpha-2.","pattern":"^[A-Z]{2}$"},"settlement":{"type":"object","description":"Детальна інформація про місце розташування відділення.","properties":{"id":{"type":"integer","description":"Ідентифікатор міста.","minimum":1},"name":{"type":"string","description":"Назва міста або населеного пункту.","minLength":2},"region":{"type":"object","description":"Район розташування міста.","properties":{"id":{"type":"integer","description":"Ідентифікатор району.","minimum":1},"name":{"type":"string","description":"Назва району.","minLength":2},"parent":{"type":"object","description":"Область або регіон розташування міста.","properties":{"id":{"type":"integer","description":"Ідентифікатор регіону.","minimum":1},"name":{"type":"string","description":"Назва регіону.","minLength":2}},"required":["id","name"]}},"required":["id","name","parent"]}},"required":["id","name","region"]},"address":{"type":"string","description":"Адреса відділення.","maxLength":255},"number":{"type":"string","description":"Номер відділення.","maxLength":255},"status":{"type":"string","description":"Вказує поточний операційний стан відділення. Можливі значення: Working, NotWorking, NotWorkingTemporary, InProcessOpening.\n"},"customerServiceAvailable":{"type":"boolean","description":"Availability of customer service in the division. Внутрішні дані, не для використання."},"divisionCategory":{"type":"string","description":"Тип відділення."},"publicPhones":{"type":"array","items":{"type":"string"},"description":"Public phone of the division. Внутрішні дані, не для використання."},"internalPhones":{"type":"array","items":{},"description":"Internal phone of the division. Внутрішні дані, не для використання."},"responsiblePerson":{"type":"integer","description":"Responsible person for the division. Внутрішні дані, не для використання.","nullable":true},"partner":{"type":"integer","description":"Внутрішні дані, не для використання.","nullable":true},"ownerDivision":{"type":"integer","description":"Внутрішні дані, не для використання.","nullable":true},"latitude":{"type":"number","description":"Координата широти.","nullable":true},"longitude":{"type":"number","description":"Координата довготи.","nullable":true},"distance":{"type":"integer","nullable":true},"maxWeightPlaceSender":{"type":"integer","description":"Максимальна вага одного місця, яке можна відправити з цього відділення, у грамах."},"maxLengthPlaceSender":{"type":"integer","description":"Максимальна довжина одного місця, яке можна відправити з цього відділення, у міліметрах."},"maxWidthPlaceSender":{"type":"integer","description":"Максимальна ширина одного місця, яке можна відправити з цього відділення, у міліметрах."},"maxHeightPlaceSender":{"type":"integer","description":"Максимальна висота одного місця, яке можна відправити з цього відділення, у міліметрах."},"maxWeightPlaceRecipient":{"type":"integer","description":"Максимальна вага одного місця, яке можна отримати в цьому відділенні, у грамах."},"maxLengthPlaceRecipient":{"type":"integer","description":"Максимальна довжина одного місця, яке можна отримати в цьому відділенні, у міліметрах."},"maxWidthPlaceRecipient":{"type":"integer","description":"Максимальна ширина одного місця, яке можна отримати в цьому відділенні, у міліметрах."},"maxHeightPlaceRecipient":{"type":"integer","description":"Максимальна висота одного місця, яке можна отримати в цьому відділенні, у міліметрах."},"maxCostPlace":{"type":"number","description":"Максимальна вартість одного відправлення.","minimum":0.01},"maxDeclaredCostPlace":{"type":"number","description":"Максимальна оголошена вартість одного відправлення.","minimum":0.01},"workSchedule":{"type":"array","description":"Графік роботи відділення. Повертає масив із робочими днями та часом роботи.","items":{"type":"object","properties":{"day":{"type":"string","description":"Робочий день тижня."},"from":{"type":"string","description":"Час початку роботи відділення у 24-годинному форматі."},"to":{"type":"string","description":"Час закриття відділення у 24-годинному форматі."},"breakFrom":{"type":"string","description":"Час початку перерви. Null, якщо перерви немає. Повертається у 24-годинному форматі.","nullable":true},"breakTo":{"type":"string","description":"Час завершення перерви. Null, якщо перерви немає. Повертається у 24-годинному форматі.","nullable":true}}}},"settings":{"type":"array","items":{}},"logisticsCode":{"type":"string","description":"Код логістичного району, який використовується виключно для країни **Молдова** для визначення регіональної зони обробки та напряму маршрутизації відправлення.\n🔸**Це ключовий параметр, необхідний для коректного розподілу за логістичними маршрутами.**\n"},"attributes":{"type":"object","description":"Використовується для відображення додаткових параметрів.","properties":{"printFormDeliveryRegion":{"type":"string","description":"Код відділення доставки, який використовується виключно для країни **Молдова**. Він є підкатегорією міста призначення та використовується для визначення основного логістичного хаба, до якого відправлення спочатку спрямовується перед подальшим розподілом до конкретного міста або населеного пункту."}}},"createdAt":{"type":"string","description":"Дата й час додавання елемента до списку."},"updatedAt":{"type":"string","description":"Дата й час оновлення елемента."},"deletedAt":{"type":"string","description":"Дата й час видалення; якщо не видалено — null.","nullable":true},"fullAddress":{"type":"object","description":"Адреса відділення, розбита на складові.","properties":{"country":{"type":"string","description":"Країна відділення.","maxLength":100},"settlement":{"type":"string","description":"Назва міста відділення.","maxLength":100},"street":{"type":"string","description":"Назва вулиці відділення.","maxLength":100},"building":{"type":"string","description":"Номер будівлі відділення.","maxLength":100},"note":{"type":"string","description":"Додаткова інформація про адресу.","maxLength":100},"zipcode":{"type":"string","description":"Поштовий індекс.","maxLength":10}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Знайти відділення"}}}}
```
## Знайти валюти
> Цей API метод дозволяє отримати список валют, доступних для створення транспортних документів. Використовуючи цей метод, ви можете отримати перелік валют, які підтримуються системою. Відповідь містить деталі щодо кожної валюти, зокрема код валюти, назву та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/dictionary/currencies":{"get":{"tags":["Довідники"],"description":"Цей API метод дозволяє отримати список валют, доступних для створення транспортних документів. Використовуючи цей метод, ви можете отримати перелік валют, які підтримуються системою. Відповідь містить деталі щодо кожної валюти, зокрема код валюти, назву та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"limit","description":"Максимальна кількість елементів на сторінці.","schema":{"type":"integer","format":"int32","default":15}},{"in":"query","name":"page","description":"Номер сторінки для повернення.","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"codes[]","description":"Коди валют.","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"Валюти","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Поточна сторінка.","minimum":1},"last_page":{"type":"integer","description":"Загальна кількість знайдених сторінок.","minimum":1},"per_page":{"type":"integer","description":"Поточний ліміт об’єктів на одній сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість знайдених об’єктів.","minimum":0},"from":{"type":"integer","nullable":true},"to":{"type":"integer","nullable":true},"items":{"type":"array","description":"Перелік валют, доступних для оформлення транспортних документів.","items":{"type":"object","properties":{"code":{"type":"string","description":"Код валюти відповідно до стандарту ISO 4217.","pattern":"^[A-Z]{3}$"},"numCode":{"type":"integer","description":"Числовий код валюти відповідно до стандарту ISO 4217."},"name":{"type":"string","description":"Повна назва валюти.","minLength":2,"maxLength":100},"shortName":{"type":"string","description":"Коротка назва валюти.","minLength":1,"maxLength":20},"symbol":{"type":"integer","description":"Знак, символ або коротке позначення назви грошової одиниці."},"createdAt":{"type":"string","description":"Дата й час додавання елемента до списку."},"updatedAt":{"type":"string","description":"Дата й час оновлення елемента."},"deletedAt":{"type":"string","description":"Дата й час видалення; якщо не видалено — null.","nullable":true}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Знайти валюти"}}}}
```
## Знайти товарні класифікатори (УКТ ЗЕД)
> Цей API метод дозволяє отримати список товарних класифікаторів (УКТ ЗЕД). Товарні класифікатори — це попередньо визначені категорії або класифікації, що використовуються для віднесення різних типів вантажів до відповідних груп. Використовуючи цей метод, можна отримати перелік класифікаторів, які підтримуються системою. Відповідь містить деталі щодо кожного класифікатора, зокрема ідентифікатор, назву, опис, категорію, приклади та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\
> \
> \*\*Як це працює:\*\*\
> \- Метод повертає класифікатори для країни отримувача, зазначеної в\
> параметрі \`country-code\`.\
> \
> \- Формат кодів УКТ ЗЕД залежить від вибраної країни, наприклад:\
> \- Для країн призначення \*\*Канада (CA)\*\* та \*\*Молдова (MD)\*\* коди УКТ ЗЕД проходять сувору перевірку й мають містити рівно \*\*10 цифр\*\*.\
> \- Будь-які нечислові символи в \`HsCode\` будуть автоматично видалені перед валідацією.\
> \- Параметр \`keyword\` дозволяє шукати конкретний товарний класифікатор.\
> \
> \- Якщо \`fuzzy=true\`, пошук включатиме схожі результати на основі нечіткого збігу.\
> \
> \*\*Обмеження:\*\*\
> \
> \- Деякі країни можуть не підтримувати отримання УКТ ЗЕД через API.\
> \- Результати залежать від актуальності оновлення бази класифікаторів.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/dictionary/classifier":{"get":{"tags":["Довідники"],"description":"Цей API метод дозволяє отримати список товарних класифікаторів (УКТ ЗЕД). Товарні класифікатори — це попередньо визначені категорії або класифікації, що використовуються для віднесення різних типів вантажів до відповідних груп. Використовуючи цей метод, можна отримати перелік класифікаторів, які підтримуються системою. Відповідь містить деталі щодо кожного класифікатора, зокрема ідентифікатор, назву, опис, категорію, приклади та іншу релевантну інформацію. Ці дані можуть бути використані для створення транспортного документа (відправлення).\n\n**Як це працює:**\n- Метод повертає класифікатори для країни отримувача, зазначеної в\nпараметрі `country-code`.\n\n- Формат кодів УКТ ЗЕД залежить від вибраної країни, наприклад:\n - Для країн призначення **Канада (CA)** та **Молдова (MD)** коди УКТ ЗЕД проходять сувору перевірку й мають містити рівно **10 цифр**.\n - Будь-які нечислові символи в `HsCode` будуть автоматично видалені перед валідацією.\n- Параметр `keyword` дозволяє шукати конкретний товарний класифікатор.\n\n- Якщо `fuzzy=true`, пошук включатиме схожі результати на основі нечіткого збігу.\n\n**Обмеження:**\n\n- Деякі країни можуть не підтримувати отримання УКТ ЗЕД через API.\n- Результати залежать від актуальності оновлення бази класифікаторів.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"country-code","description":"Код країни за стандартом ISO 3166-1 Alpha-2, для якої потрібен класифікатор УКТ ЗЕД.\nЦей параметр стосується **країни отримувача**, а не відправника.\nФормат кодів УКТ ЗЕД відрізняється залежно від країни, наприклад: - `UA` – повертає 8-значні коди. - `CA` або `MD` – повертає 10-значні коди. \n**Приклад:** якщо потрібні коди УКТ ЗЕД для Канади, використовуйте `country-code=CA`.\n","schema":{"type":"string"}},{"in":"query","name":"fuzzy","description":"Механізм пошуку дозволяє включати результати, що близькі до пошукового запиту або мають певний ступінь схожості, розширюючи область пошуку за рахунок варіацій і подібних записів.","schema":{"type":"boolean","enum":[true,false]}},{"in":"query","name":"keyword","description":"Ключове слово для пошуку класифікатора.","schema":{"type":"string"}},{"in":"query","name":"locale","description":"Мовний код відповідно до стандарту ISO 639-1.","schema":{"type":"string"}},{"in":"query","name":"size","description":"Кількість відповідних класифікаторів для повернення.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Список товарних класифікаторів (УКТ ЗЕД)","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean"},"source":{"type":"string"},"error":{"type":"string"},"items":{"type":"array","description":"Список класифікаторів, що відповідають заданому ключовому слову. Якщо збігів немає — повертається null.","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Ідентифікатор класифікатора."},"hsCode":{"type":"string","description":"Код довідника товарних класифікаторів (УКТ ЗЕД)."},"category":{"type":"object","description":"Категорія класифікатора.","properties":{"en":{"type":"string","description":"Назва категорії англійською мовою."},"currentLocal":{"type":"string","description":"Назва категорії мовою, зазначеною в параметрі `locale`."}},"required":["en","currentLocal"]},"subCategory":{"type":"object","description":"Підкатегорія класифікатора.","properties":{"en":{"type":"string","description":"Назва підкатегорії англійською мовою."},"currentLocal":{"type":"string","description":"Назва підкатегорії мовою, зазначеною в параметрі `locale`."}},"required":["en","currentLocal"]},"keywords":{"type":"object","description":"Ключові слова для підкатегорії.","properties":{"en":{"type":"string","description":"Ключові слова англійською мовою."},"currentLocal":{"type":"string","description":"Ключові слова мовою, зазначеною в параметрі `locale`."}},"required":["en","currentLocal"]},"product":{"type":"object","description":"Назва товару класифікатора.","properties":{"en":{"type":"string","description":"Назва англійською мовою."},"currentLocal":{"type":"string","description":"Назва мовою, зазначеною в параметрі `locale`."}},"required":["en","currentLocal"]},"description":{"type":"object","description":"Опис товарів, що відповідають цьому класифікатору.","properties":{"en":{"type":"string","description":"Опис англійською мовою."},"currentLocal":{"type":"string","description":"Опис мовою, зазначеною в параметрі `locale`."}},"required":["en","currentLocal"]},"exportFromUA":{"type":"boolean"},"importToUA":{"type":"boolean"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Знайти товарні класифікатори (УКТ ЗЕД)"}}}}
```
## Знайти налаштування митних зборів
> Цей метод повертає налаштування країни одержувача для визначення можливості сплати митних зборів відправником, а також мінімальне та максимальне порогові значення оціночної вартості посилки, в межах яких ця опція доступна.\
> \
> Якщо значення \`customsFeesActive\` дорівнює false, відправник не може виступати платником митних зборів для вибраної країни.\
> \
> Поля \`minDeclaredCost\` та \`maxDeclaredCost\` визначають діапазон оціночної вартості посилки (у валюті країни одержувача), в межах якого доступна опція сплати митних зборів відправником.\
> \
> Якщо оціночна вартість посилки є меншою за \`minDeclaredCost\`, митні збори на таку посилку не нараховуються.\
> \
> Якщо оціночна вартість посилки перевищує \`maxDeclaredCost\`, відправник не може виступати платником митних зборів. У такому випадку параметр \`payerFeesCustoms\` має бути встановлений у значення \`Recipient\`.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"responses":{"Unauthorized":{"description":"Unauthorized","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":{"/dictionary/customs-fees/{code}":{"get":{"tags":["Довідники"],"summary":"Знайти налаштування митних зборів","description":"Цей метод повертає налаштування країни одержувача для визначення можливості сплати митних зборів відправником, а також мінімальне та максимальне порогові значення оціночної вартості посилки, в межах яких ця опція доступна.\n\nЯкщо значення `customsFeesActive` дорівнює false, відправник не може виступати платником митних зборів для вибраної країни.\n\nПоля `minDeclaredCost` та `maxDeclaredCost` визначають діапазон оціночної вартості посилки (у валюті країни одержувача), в межах якого доступна опція сплати митних зборів відправником.\n\nЯкщо оціночна вартість посилки є меншою за `minDeclaredCost`, митні збори на таку посилку не нараховуються.\n\nЯкщо оціночна вартість посилки перевищує `maxDeclaredCost`, відправник не може виступати платником митних зборів. У такому випадку параметр `payerFeesCustoms` має бути встановлений у значення `Recipient`.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"path","name":"code","required":true,"description":"Альфа-код країни призначення відповідно до стандарту ISO 3166-1 Alpha-2.","schema":{"type":"string"}}],"responses":{"200":{"description":"Успішна відповідь із налаштуваннями митних зборів","content":{"application/json":{"schema":{"type":"object","properties":{"customsFeesActive":{"type":"boolean","description":"Ознака можливості сплати митних зборів відправником.\n\nМожливі значення:\n - `true` — оплата можлива\n - `false` — оплата неможлива\n"},"minDeclaredCost":{"type":"number","description":"Мінімальна оціночна вартість посилки у валюті країни одержувача.\n"},"maxDeclaredCost":{"type":"number","description":"Максимальна оціночна вартість посилки у валюті країни одержувача, за якої відправник може сплачувати митні збори.\n"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"description":"Непридатна до обробки сутність – некоректний код країни","content":{"application/json":{"schema":{"type":"object","properties":{"ErrorMessage":{"type":"string"}}}}}},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Довідник населених пунктів із забороною видачі
> Цей API метод повертає маніфест із посиланнями на офлайн-файли довідника, що містять перелік населених пунктів України, у яких заборонена видача (отримання) відправлень. Довідник охоплює всі типи населених пунктів і призначений для валідації адрес, перевірки доступності доставки та логістичних обмежень.\
> \
> Відповідь містить URL-адреси актуальних локалізованих файлів довідника, підготовлених для офлайн-використання. Кожен файл містить дані про населений пункт, зокрема адміністративну ієрархію, координати, поштові індекси, альтернативні назви та ознаки заборони.\
> \
> Файли довідника поширюються у вигляді локалізованих стиснутих JSON-архівів.\
> \
> 🔹\*\*Ключові можливості:\*\*\
> \
> \- Повертає JSON-маніфест із URL-адресами файлів довідника.\
> \- Файли надаються у форматі \`.json.gz\`.\
> \- Підтримується локалізація (\`locale="uk"\`, \`locale="en"\`).\
> \- Містить лише населені пункти з \`prohibitedIssuance = true\`.\
> \- Призначено для офлайн-використання та періодичної синхронізації.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/dictionary/settlements/prohibited-issuance":{"get":{"tags":["Довідники"],"summary":"Довідник населених пунктів із забороною видачі","description":"Цей API метод повертає маніфест із посиланнями на офлайн-файли довідника, що містять перелік населених пунктів України, у яких заборонена видача (отримання) відправлень. Довідник охоплює всі типи населених пунктів і призначений для валідації адрес, перевірки доступності доставки та логістичних обмежень.\n\nВідповідь містить URL-адреси актуальних локалізованих файлів довідника, підготовлених для офлайн-використання. Кожен файл містить дані про населений пункт, зокрема адміністративну ієрархію, координати, поштові індекси, альтернативні назви та ознаки заборони.\n\nФайли довідника поширюються у вигляді локалізованих стиснутих JSON-архівів.\n\n🔹**Ключові можливості:**\n\n- Повертає JSON-маніфест із URL-адресами файлів довідника.\n- Файли надаються у форматі `.json.gz`.\n- Підтримується локалізація (`locale=\"uk\"`, `locale=\"en\"`).\n- Містить лише населені пункти з `prohibitedIssuance = true`.\n- Призначено для офлайн-використання та періодичної синхронізації.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[],"responses":{"200":{"description":"Маніфест довідника населених пунктів із забороною видачі","content":{"application/json":{"schema":{"type":"object","required":["unix_time","urls"],"properties":{"unix_time":{"type":"integer","description":"Unix timestamp, що вказує час генерації довідника."},"urls":{"type":"array","description":"Список URL-адрес локалізованих офлайн-файлів довідника.","items":{"type":"string","format":"uri"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Дія недоступна","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}
```
## Офлайн-довідник населених пунктів
> Цей API-метод повертає маніфест із посиланнями на файли офлайн-довідників, що містять дані про населені пункти. Довідники формуються на основі набору даних населених пунктів і надаються окремо для кожної країни.\
> \
> Відповідь містить URL-адреси актуальних локалізованих файлів довідника, підготовлених для використання в офлайн-режимі. Кожен файл містить дані про населені пункти, такі як адміністративна ієрархія, координати, поштові індекси, альтернативні назви та інші релевантні атрибути.\
> \
> Кожен запит повертає файли довідника для конкретної країни.\
> \
> Файли довідника поширюються у вигляді локалізованих стиснених JSON-архівів.\
> \
> 🔹\*\*Основні можливості:\*\* \
> \- Повертає JSON-маніфест із URL-адресами файлів довідника. \
> \- Файли надаються у форматі \`.json.gz\`. \
> \- Підтримується локалізація через заголовок \`Accept-language\` (за замовчуванням: \`en\`). \
> \- Окремі файли для кожної країни (\`UA\`, \`MD\`). \
> \- Побудовано на основі даних довідника населених пунктів. \
> \- Оновлюється один раз на добу. \
> \- Призначено для використання в офлайн-режимі та періодичної синхронізації.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"responses":{"Unauthorized":{"description":"Unauthorized","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":{"/dictionary/settlements/versions":{"get":{"tags":["Довідники"],"summary":"Офлайн-довідник населених пунктів","description":"Цей API-метод повертає маніфест із посиланнями на файли офлайн-довідників, що містять дані про населені пункти. Довідники формуються на основі набору даних населених пунктів і надаються окремо для кожної країни.\n\nВідповідь містить URL-адреси актуальних локалізованих файлів довідника, підготовлених для використання в офлайн-режимі. Кожен файл містить дані про населені пункти, такі як адміністративна ієрархія, координати, поштові індекси, альтернативні назви та інші релевантні атрибути.\n\nКожен запит повертає файли довідника для конкретної країни.\n\nФайли довідника поширюються у вигляді локалізованих стиснених JSON-архівів.\n\n🔹**Основні можливості:** \n- Повертає JSON-маніфест із URL-адресами файлів довідника. \n- Файли надаються у форматі `.json.gz`. \n- Підтримується локалізація через заголовок `Accept-language` (за замовчуванням: `en`). \n- Окремі файли для кожної країни (`UA`, `MD`). \n- Побудовано на основі даних довідника населених пунктів. \n- Оновлюється один раз на добу. \n- Призначено для використання в офлайн-режимі та періодичної синхронізації.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"header","name":"Accept-language","description":"Щоб отримати вміст довідника певною мовою, передайте код потрібної мови (стандарт ISO 639-1) у заголовку з назвою `accept-language`. Якщо переклад для вибраної мови відсутній, буде відображено англійську мову.","schema":{"type":"string","enum":["en","ro","uk"]}},{"in":"query","name":"countryCode","description":"Код країни, для якої необхідно повернути довідник населених пунктів (ISO 3166-1 Alpha-2).","required":true,"schema":{"type":"string","enum":["UA","MD"]}}],"responses":{"200":{"description":"Маніфест офлайн-довідника населених пунктів","content":{"application/json":{"schema":{"type":"object","required":["unix_time","base_version","urls","real_urls"],"properties":{"unix_time":{"type":"integer","description":"Unix-часова мітка, що вказує час генерації довідника."},"base_version":{"type":"object","description":"Метадані базової версії довідника.","required":["unix_time"],"properties":{"unix_time":{"type":"integer","description":"Unix-часова мітка базової версії довідника."}}},"urls":{"type":"array","description":"Список публічних URL-адрес локалізованих файлів офлайн-довідника.","items":{"type":"string","format":"uri"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Дія недоступна","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Знайти населені пункти
> Цей API-метод дозволяє отримати список населених пунктів, доступних у різних країнах. Передавши код країни як параметр, ви можете отримати повний список населених пунктів та пов'язану з ними інформацію. Метод підтримує пошук за назвою вулиці. Відповідь зазвичай містить такі дані, як назва населеного пункту, ідентифікатор, дані країни та інші релевантні атрибути. Ці дані можуть бути корисними для створення транспортного документа (відправлення).
```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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/settlements":{"get":{"tags":["Довідники"],"summary":"Знайти населені пункти","description":"Цей API-метод дозволяє отримати список населених пунктів, доступних у різних країнах. Передавши код країни як параметр, ви можете отримати повний список населених пунктів та пов'язану з ними інформацію. Метод підтримує пошук за назвою вулиці. Відповідь зазвичай містить такі дані, як назва населеного пункту, ідентифікатор, дані країни та інші релевантні атрибути. Ці дані можуть бути корисними для створення транспортного документа (відправлення).","parameters":[{"in":"query","name":"countryCodes[]","description":"Для отримання списку населених пунктів у певній країні виберіть необхідний код країни зі списку. Використовуйте код відповідно до стандарту ISO 3166-1 Alpha-2.","schema":{"type":"array","items":{"type":"string","enum":["cz","de","en","es","fr","et","hu","it","lt","lv","nl","pl","ro","sk","uk"]}}},{"in":"query","name":"limit","description":"Максимальна кількість елементів для повернення.","schema":{"type":"integer","format":"int32","default":15}},{"in":"query","name":"page","description":"Номер сторінки для повернення.","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"textSearch","description":"Пошук за будь-яким текстом.","schema":{"type":"string"}}],"responses":{"200":{"description":"населені пункти","content":{"application/json":{"schema":{"type":"object","required":["current_page","last_page","per_page","total","items"],"properties":{"current_page":{"type":"integer","description":"Поточна сторінка.","minimum":1},"last_page":{"type":"integer","description":"Загальна кількість знайдених сторінок.","minimum":1},"per_page":{"type":"integer","description":"Поточний ліміт об'єктів на одній сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість знайдених об'єктів.","minimum":0},"from":{"type":"integer","nullable":true},"to":{"type":"integer","nullable":true},"items":{"type":"array","description":"Список населених пунктів.","items":{"type":"object","required":["id","name","country","region","parent","latitude","longitude","postCode1","postCode2","alternativeNames","externalId","boost","prohibitedIssuance","prohibitedSending","createdAt","updatedAt","deletedAt"],"properties":{"id":{"type":"integer","description":"Ідентифікатор населеного пункту.","minimum":1},"name":{"type":"string","description":"Назва міста або населеного пункту."},"country":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"Назва країни.","minLength":2},"code":{"type":"string","minLength":2}}},"region":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Код ідентифікатора району.","minimum":1},"name":{"type":"string","description":"Район розташування населеного пункту.","minLength":2},"parent":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Код ідентифікатора області.","minimum":1},"name":{"type":"string","description":"Область розташування населеного пункту.","minLength":2}}}}},"latitude":{"type":"number","description":"Координата широти.","nullable":true,"minimum":-90,"maximum":90},"longitude":{"type":"number","description":"Координата довготи.","nullable":true,"minimum":-180,"maximum":180},"postCode1":{"type":"string","description":"Значення поштового індексу \"від\".","nullable":true,"minLength":0,"maxLength":16},"postCode2":{"type":"string","description":"Значення поштового індексу \"до\".","nullable":true,"minLength":0,"maxLength":16},"alternativeNames":{"type":"array","description":"Список альтернативних назв населеного пункту.","items":{"type":"string"}},"externalId":{"type":"string","description":"Зовнішній ідентифікатор населеного пункту.","nullable":true,"maxLength":50},"boost":{"type":"integer","description":"Показник пріоритету сортування."},"prohibitedIssuance":{"type":"boolean","description":"Вказує, чи доступна доставка посилок до цього населеного пункту. Якщо значення true – отримання посилок у цьому населеному пункті неможливе.","nullable":true},"prohibitedSending":{"type":"boolean","description":"Вказує, чи доступне відправлення посилок з цього населеного пункту. Якщо значення true – відправлення з цього населеного пункту неможливе.","nullable":true},"createdAt":{"type":"string","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","nullable":true,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
## Знайти вулиці
> Цей API-метод дозволяє отримати список вулиць, доступних у різних населених пунктах. Передаючи код країни як параметр або settlementId як параметр, ви можете отримати повний список вулиць та пов’язану з ними інформацію. Метод також підтримує пошук за назвою вулиці. Відповідь зазвичай містить інформацію, таку як назва вулиці, назва населеного пункту, ідентифікатор та інші релевантні атрибути. Ці дані можуть бути корисними для створення транспортного документа (відправлення).
```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":"Authorization JWT-token with a lifetime of 1 hour in header"}},"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":{"/streets":{"get":{"tags":["Довідники"],"summary":"Знайти вулиці","description":"Цей API-метод дозволяє отримати список вулиць, доступних у різних населених пунктах. Передаючи код країни як параметр або settlementId як параметр, ви можете отримати повний список вулиць та пов’язану з ними інформацію. Метод також підтримує пошук за назвою вулиці. Відповідь зазвичай містить інформацію, таку як назва вулиці, назва населеного пункту, ідентифікатор та інші релевантні атрибути. Ці дані можуть бути корисними для створення транспортного документа (відправлення).","parameters":[{"in":"query","name":"countryCodes[]","description":"Список кодів країн (ISO 3166-1 Alpha-2) для фільтрації вулиць.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"name","description":"Фільтр за назвою вулиці.","schema":{"type":"string"}},{"in":"query","name":"limit","description":"Максимальна кількість елементів для повернення.","schema":{"type":"integer","format":"int32","default":15,"minimum":1,"maximum":100}},{"in":"query","name":"page","description":"Номер сторінки для повернення.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"вулиці","content":{"application/json":{"schema":{"type":"object","required":["current_page","last_page","per_page","total","items"],"properties":{"current_page":{"type":"integer","description":"Поточна сторінка.","minimum":1},"last_page":{"type":"integer","description":"Загальна кількість знайдених сторінок.","minimum":1},"per_page":{"type":"integer","description":"Поточний ліміт об’єктів на одній сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість знайдених об’єктів.","minimum":0},"from":{"type":"integer","nullable":true},"to":{"type":"integer","nullable":true},"items":{"type":"array","description":"Список вулиць.","items":{"type":"object","required":["id","name","settlement","countryCode","latitude","longitude","externalId","alternativeNames","createdAt","updatedAt","deletedAt"],"properties":{"id":{"type":"integer","description":"Ідентифікатор вулиці.","minimum":1},"name":{"type":"string","description":"Назва вулиці."},"settlement":{"type":"object","description":"Населений пункт, у якому розташована вулиця.","properties":{"id":{"type":"integer","minimum":1},"name":{"type":"string","minLength":2}}},"countryCode":{"type":"string","description":"Код країни відповідно до стандарту ISO 3166-1 Alpha-2.","pattern":"^[A-Z]{2}$"},"latitude":{"type":"number","description":"Координата широти.","nullable":true,"minimum":-90,"maximum":90},"longitude":{"type":"number","description":"Координата довготи.","nullable":true,"minimum":-180,"maximum":180},"alternativeNames":{"type":"array","description":"Масив альтернативних назв вулиці.","items":{"type":"string"}},"externalId":{"type":"string","description":"Зовнішній ідентифікатор вулиці.","nullable":true,"maxLength":50},"createdAt":{"type":"string","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","nullable":true,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}}
```
---
# 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/dovidniki.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.