UA

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

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

Документація доступна лише українською, оскільки функціонал призначений для внутрішніх відправлень. Якщо вам потрібне універсальне рішення для відправлень по Україні та за кордон, переходьте до розділу API Docs Int.

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

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

Авторизація

Для початку роботи з функціоналом 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 навіть у разі логічних помилок.