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

Цей розділ містить документацію API для інтеграції із сервісами Нової пошти в межах України. API призначений для роботи з внутрішніми відправленнями по Україні та надає методи для створення й керування експрес-накладними, роботи з контрагентами і адресами, отримання довідників, друкованих форм, реєстрів, трекінгу та інших сервісів. Технічна версія цього інтерфейсу — API 2.0.

Для міжнародних відправлень, відправлень за кордон та інтеграції із сервісами Nova Post в інших країнах використовуйте міжнародний Nova Post API, документація якого доступна в розділі API Docs.

Міжнародний API активно розвивається та поступово доповнюється можливостями для роботи з відправленнями в межах України. У перспективі він стане єдиним API для інтеграції із сервісами Nova Post незалежно від країни та напрямку відправлення. Тому для нових інтеграцій рекомендуємо також ознайомитися з можливостями API Docs.

Огляд методів

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

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

Авторизація

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

Щоб згенерувати ключ, перейдіть за посиланням «Отримати API Key» (Бізнес-кабінет/Налаштування/Безпека) та натисніть «Створити ключ». Детальніше — на сторінці «Створення API-ключа».

Точки входу

JSON: https://api.novaposhta.ua/v2.0/json/ XML: https://api.novaposhta.ua/v2.0/xml/

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

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

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

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

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