> 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/methods/ua/api-docs-ua/ua.md).

# UA

### Загальна інформація

Цей підрозділ містить методи API для інтеграції **із сервісами в межах України**.&#x20;

{% hint style="info" %}
Документація доступна **лише українською**, оскільки функціонал призначений для внутрішніх відправлень. Якщо вам потрібне універсальне рішення для відправлень по Україні та за кордон, переходьте до розділу [**API Docs Int**](https://api-portal.novapost.com/methods/ua/).
{% endhint %}

Методи згруповані за основними напрямками інтеграції:

* **Адреси** — робота з довідниками (населених пунктів, поштоматів тощо) і створення адрес контрагентів.
* **Виклик кур'єра** — робота із заявками на виклик кур'єра.
* **Додаткові послуги** — створення переадресації або повернення, зміна даних.
* **Довідники** — робота з довідниками.
* **Друковані форми** — отримання друкованих форм документів.
* **Експрес-накладна** — створення, редагування, видалення та отримання даних за експрес-накладною.
* **Контактні персони** — створення, оновлення та видалення контактних осіб контрагентів.
* **Контрагенти** — робота із даними контрагентів.
* **Оплати** — деталізація вартості відправлень.
* **Реєстри** — робота із реєстрами експрес-накладних.
* **Трекінг** — отримання детальної інформації про статус відправлень.
* **Фрахт** — робота із заявками на перевезення вантажів.

### Авторизація

Для початку роботи з функціоналом API UA необхідно згенерувати API-ключ і використовувати його під час формування запитів.&#x20;

Щоб згенерувати ключ, перейдіть за посиланням «[**Отримати API Key**](https://new.novaposhta.ua/)» (**Бізнес-кабінет**/**Налаштування**/**Безпека**) та натисніть «**Створити ключ**». Детальніше — на сторінці «[**Створення API-ключа**](/novaposhta-docs/ua/kroki-integraciyi/stvorennya-api-klyucha.md)».

### Точки входу

**JSON:** <https://api.novaposhta.ua/v2.0/json/\\>
**XML:** <https://api.novaposhta.ua/v2.0/xml/>

### Формат запиту

Обмін даними здійснюється за протоколом HTTPS із використанням методів передачі даних POST або GET на точку входу залежно від типу запиту (XML або JSON).&#x20;

Формат обов'язково має бути вказаний маленькими літерами. Наприклад: <https://api.novaposhta.ua/v2.0/json/>.

### Формат відповіді

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


---

# 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, and the optional `goal` query parameter:

```
GET https://api-portal.novapost.com/methods/ua/api-docs-ua/ua.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
