Draft
JWT-токен авторизації зі строком дії 1 годину у заголовку
Пошук відправлень за номером транспортного документа. Може приймати як один номер для пошуку, так і масив номерів.
SHPL6145344878Пошук відправлень за ідентифікаторами транспортних документів.
113622Максимальна кількість елементів на сторінці.
15Example: 1Номер сторінки для повернення.
1Прапорець, що показує, чи включено відправлення до реєстру. Лише для європейських посилок.
trueНомер реєстру, який містить усі відправлення. Лише для європейських посилок.
CRPL0000004855Ідентифікатор відділення, з якого здійснюється відправлення.
12shipments
Поточна сторінка.
Загальна кількість сторінок.
Поточний ліміт об’єктів на сторінці.
Загальна кількість знайдених об’єктів.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Визначає поточний статус транспортного документа, відстежуючи його проходження через життєвий цикл доставки. Статуси відображають кожен ключовий етап:
- Draft: Документ знаходиться на початковій стадії, ще не завершений.
- Accepted: Перевірений та прийнятий, документ готовий до наступних етапів.
- Issued: Документ завершено та готовий до відправлення.
- ReadyToShip: Вказує, що відправлення підготовлено до транспортування після створення експрес-накладної. Лише це значення може бути вказане при створенні відправлення.
- Deleted: Документ видалено із системи.
- Returned: Відправлення повернено відправнику.
- Utilized: Вказує, що фізичні товари, пов’язані з транспортним документом, були утилізовані або знищені, і документ закрито.
Представляє всі можливі ідентифікатори замовлення, пов’язані з відправленням. Ці ідентифікатори задаються клієнтом для внутрішнього відстеження та є важливими для контролю відправлення протягом усього його маршруту. Усі введені значення можуть відстежуватися в системі трекінгу.
Тут може бути вказана будь-яка додаткова інформація або спеціальні інструкції щодо замовлення. Це можуть бути інструкції з доставки, особливі умови обробки або інші важливі деталі, що сприяють обробці відправлення.
Визначає тип тарифу, який буде застосовано до відправлення під час створення або оновлення.
standard: Стандартний міжнародний тариф доставки.economy: Економний міжнародний тариф доставки.express: Експрес міжнародний тариф доставки.
Якщо поле не передано, тип тарифу визначається автоматично відповідно до поточних бізнес-правил, і існуюча логіка створення відправлення залишається без змін.
🔹Це поле є необов’язковим.
Визначає, хто несе відповідальність за оплату послуг доставки. Тип платника визначає сторону, яка покриває витрати:
- Sender: Відправник оплачує доставку.
- Recipient: Одержувач оплачує доставку.
- ThirdPerson: Третя сторона, не відправник і не одержувач, оплачує доставку. При виборі 'ThirdPerson' поле 'payerContractNumber' має містити номер договору платника. Детальніше див. статтю Оплата послуг доставки через API Nova Post. Це поле також використовується при формуванні інвойсу.
🔻Це поле є обов’язковим
Це поле є обов’язковим у таких випадках:
- Коли
payerTypeмає значенняThirdPerson. Воно повинно містити номер договору платника. Для клієнтів з України також дозволено передавати код ЄДРПОУ замість номера договору. - Коли
payerTypeмає значенняSenderабоRecipientі використовується безготівковий спосіб оплати.
Якщо це поле не передано у зазначених випадках, спосіб оплати автоматично буде встановлений як готівковий.
Переконайтеся, що надана інформація є коректною, оскільки вона необхідна для правильної обробки платежу.
Детальніше див. статтю Оплата послуг доставки через API Nova Post.
Відправлення успішно створено.
Унікальний ідентифікатор, що призначається кожному відправленню, який використовується для внутрішніх операцій, таких як модифікація, пошук у системі та видалення відправлень. Поле id слугує ключовим посиланням для адміністративних і логістичних процесів у системі доставки, забезпечуючи точний доступ і керування записами відправлень.
Формат значення id залежить від напрямку відправлення (first/last mile):
- Для відправлень у Європі значення є числовим ідентифікатором (наприклад,
754116), який використовується для пошуку. - Для відправлень в Україні значення є UUID (наприклад,
56abe014-451c-11f0-a1d5-48df37b921da), який використовується для пошуку заref.
Номер транспортного документа, який надається клієнтам для відстеження та доступу до друкованих форм. Також використовується для пошуку відправлень у системі, забезпечуючи зручний спосіб моніторингу їхнього статусу. Хоча number використовується зовні для відстеження та документації, у деяких випадках він може застосовуватись і для внутрішньої ідентифікації, подібно до id.
^[A-Z]{4}\d{10}$Орієнтовна дата доставки, розрахована на основі маршруту та рівня сервісу. Може змінюватися залежно від логістичних та зовнішніх факторів. Дата у форматі ISO 8601.
2023-04-14T09:00:00ZПоточний статус відправлення. Під час створення встановлюється значення "ReadyToShip", що означає готовність до відправки.
Загальна вартість послуг доставки, розрахована на основі розміру, ваги, напрямку та обраних сервісів.
31.5Загальна кількість місць (посилок) у відправленні. Використовується для планування логістики та відстеження.
Дата та час створення запису відправлення в системі. Формат ISO 8601.
2023-04-11T10:42:05ZДата та час останнього оновлення відправлення. Використовується для відстеження змін. Формат ISO 8601.
2023-04-11T10:42:05ZДата та час видалення або скасування відправлення. Якщо відправлення не скасовано — значення null.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номер батьківського відправлення, для якого ініціюється повернення.
Цей параметр є обов’язковим для створення повернення.
SHMD0000000000Ідентифікатор відділення, яке буде обробляти повернення.
1835903Номер телефону відправника для відправлення повернення.
490000000000Successfully created Light Return shipment.
Unauthorized request — invalid or missing authentication token.
Parent shipment is missing the AllowedLightReturn parameter.
Parent shipment not found or status not allowed.
Parent shipment not found or status not allowed.
Service unavailable or request timeout.
JWT-токен авторизації зі строком дії 1 годину у заголовку
Масив референсів відправлень. Не повинен бути порожнім. Передається як повторювані параметри запиту.
Приклад запиту:
refs[]=38e4fe97-9484-11f0-903f-005056bd9e02
Фільтр стану верифікації. Доступні значення: Order, Closed, allOrders.
Список статусів верифікації
Invalid request parameters
Неавторизований доступ
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Визначає, хто відповідає за оплату послуг доставки. Тип платника визначає, яка сторона несе витрати:
Sender: Сторона, що відправляє товар, оплачує доставку.Recipient: Сторона, що отримує товар, відповідає за оплату доставки.ThirdPerson: Третя сторона оплачує доставку.- Для відправлень у межах Європи або з Європи в Україну необхідно передати поле
payerContractNumber. - Для відправлень з України
payerContractNumberне є обов’язковим."
SenderPossible values: Обов’язковий, якщо payerType = ThirdPerson для відправлень у межах Європи або з Європи в Україну.
Вказує номер договору платника-третьої сторони (наприклад, CNPP-00001797).
CNPP-00001797Визначає список тарифних типів, які використовуються для розрахунку вартості доставки. У відповіді розрахунку повертаються результати вартості для кожного переданого типу доставки.
standard: Стандартний тариф міжнародної доставки.economy: Економ-тариф міжнародної доставки.express: Експрес-тариф міжнародної доставки.
Якщо поле не передано, відповідний тариф визначається автоматично згідно з поточними бізнес-правилами, а поведінка розрахунку залишається без змін.
🔹Це поле є необов’язковим.
Successful cost calculation
Орієнтовна дата доставки, розрахована на основі маршрутизації та рівня сервісу. Може змінюватися залежно від логістичних та зовнішніх факторів. Дата у форматі ISO 8601.
2023-04-14T09:00:00ZНеавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Ідентифікатор транспортного документа.
113677Визначає поточний статус транспортного документа, відображаючи його рух у межах життєвого циклу відправлення. Статуси описують ключові етапи:
- Draft: Документ перебуває на етапі створення та ще не завершений.
- Accepted: Документ перевірено та прийнято, готовий до наступних кроків.
- Issued: Документ сформовано та підготовлено до відправлення.
- ReadyToShip: Вказує, що відправлення готове до транспортування після створення експрес-накладної. Лише це значення може бути вказане при створенні відправлення.
- Deleted: Документ видалено із системи.
- Returned: Відправлення повернено відправнику.
- Utilized: Вказує, що фізичний вантаж, пов’язаний із транспортним документом, утилізовано або знищено, а документ закрито.
Представляє всі можливі ідентифікатори замовлення, пов’язані з відправленням. Ці ідентифікатори встановлюються клієнтом для внутрішнього обліку та є важливими для відстеження відправлення протягом усього його маршруту. Усі введені значення можуть використовуватись у системі відстеження відправлення.
Додаткова інформація або спеціальні інструкції щодо замовлення. Може включати інструкції з доставки, особливі вимоги до обробки або інші важливі деталі, що полегшують обробку та виконання відправлення.
Визначає тип тарифу, який буде застосовано до відправлення під час створення або оновлення.
standard: Стандартний тариф на міжнародну доставку.economy: Економний тариф на міжнародну доставку.express: Експрес-тариф на міжнародну доставку.
Якщо поле не передано, тип тарифу визначається автоматично відповідно до поточних бізнес-правил, і поведінка оновлення відправлення залишається без змін.
🔹Це поле є необов’язковим.
Визначає, хто відповідає за оплату послуг доставки. Тип платника визначає сторону, яка несе витрати:
- Sender: Відправник оплачує доставку.
- Recipient: Отримувач оплачує доставку.
- ThirdPerson: Третя сторона (не відправник і не отримувач) оплачує послуги доставки. У разі вибору
ThirdPersonполеpayerContractNumberповинно містити номер договору платника. Детальніше див. у статті Оплата послуг доставки через API Nova Post.
Номер договору платника. Обов’язковий, якщо payerType = ThirdPerson. Для клієнтів з України також допускається використання коду ЄДРПОУ замість номера договору. Поле також обов’язкове, якщо платником є відправник при безготівковій оплаті. Якщо значення не надано, за замовчуванням застосовується готівковий спосіб оплати. Коректність даних є критично важливою для обробки платежу. Більш детальну інформацію можна знайти у статті Оплата послуг доставки через API Nova Post.
Відправлення успішно оновлено. Ця відповідь підтверджує, що дані зазначеного транспортного документа були змінені відповідно до переданих вхідних параметрів.
Унікальний ідентифікатор, призначений кожному відправленню, який використовується для внутрішніх операцій, таких як внесення змін, пошук у системі та видалення відправлень. Поле id слугує основним ідентифікатором для адміністративних і логістичних процесів у системі доставки, забезпечуючи точний доступ до записів про відправлення та керування ними.
Номер транспортного документа, який надається клієнтам для відстеження відправлення та доступу до друкованих форм. Також використовується для пошуку відправлення в системі, забезпечуючи зручний для клієнта спосіб контролю його статусу. Хоча поле number використовується переважно для зовнішнього відстеження та документації, у певних системних операціях воно також може використовуватися для внутрішньої ідентифікації відправлення аналогічно до поля id.
^[A-Z]{4}\d{10}$Орієнтовна дата доставки, розрахована на основі маршруту та рівня сервісу. Може змінюватися залежно від логістичних та зовнішніх факторів.
Поточний статус відправлення. Після створення початково встановлюється значення ReadyToShip, що означає готовність відправлення до відправки.
Загальна вартість розрахованих послуг доставки, що визначається на основі розміру, ваги, пункту призначення та вибраних сервісів.
32.5Загальна кількість місць у відправленні. Це значення використовується для логістичного планування та відстеження.
Дата й час створення запису про відправлення в системі.
Дата й час останнього оновлення запису про відправлення. Використовується для відстеження змін і оновлень, внесених до даних відправлення.
Дата й час скасування або видалення відправлення із системи. Якщо відправлення не було скасовано, це поле містить значення null.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
ID транспортного документа (відправлення).
{"summary":"International shipment","value":456931}відправлення
Дата й час видалення документа.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Унікальний ідентифікатор відправлення, до якого додаються файли.
Це значення відповідає shipmentId європейської системи.
Використання номера українського відправлення призведе до помилки валідації.
Файл документа, закодований у base64 (PDF, JPEG або інші підтримувані формати).
Необов'язкове ім'я файлу. Якщо не вказано, за замовчуванням використовується значення "invoice".
Результат завантаження файлу
Вказує, чи було файл успішно завантажено.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номери відправлень. Може приймати як один номер, так і масив номерів. Якщо використовується type=marking, у межах одного запиту дозволяється передавати лише один номер.
SHPL1234567890Тип логістичного процесу для друку документа маркування. Застосовується лише для type=marking.
Pickup: перша миляShipment: остання миля
PDF-файл.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номери відправлень. Може приймати як один номер, так і масив номерів.
SHPL1234567890Параметр, що відповідає за включення до відповіді масиву об'єктів зі списком усіх пов'язаних відправлень.
Щоб отримати ці дані у відповіді, встановіть значення 1.
0Example: 1Схема відповіді відстеження
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номери відправлень. Може приймати як один номер, так і масив номерів.
SHPL1234567890Пошук відправлень за ідентифікаторами транспортних документів. Може приймати як один ідентифікатор, так і масив ідентифікаторів для виконання пошуку.
113622Параметр, що відповідає за включення до відповіді масиву об'єктів з інформацією про причини недоставки.
Щоб отримати ці дані у відповіді, встановіть значення true.
falseExample: trueПараметр, що відповідає за включення до відповіді масиву об'єктів з інформацією про пов'язані відправлення (типи: Redirecting, Return, Utilization, Redelivery).
Щоб отримати ці дані у відповіді, встановіть значення true.
falseExample: trueДволітерний код країни відправника відповідно до стандарту ISO 3166-1 Alpha-2.
Якщо цей параметр указано, Історія відстеження та Актуальна історія відстеження відображатимуться лише для зазначеної країни.
Pattern: ^[A-Z]{2}$
DEПараметр, що відповідає за включення до відповіді масиву об'єктів зі списком усіх пов'язаних відправлень, а також масиву, що містить розширену інформацію про ці відправлення — зокрема ім'я власника відправлення, номер відправлення та дату створення відправлення.
Щоб отримати ці дані у відповіді, встановіть значення 1.
0Example: 1Система фільтрує агреговані дані та повертає інформацію лише для зазначеного місця. Це дозволяє відстежувати маршрут доставки конкретного місця у складі багатомісного відправлення.
SHRO1452163509Система агрегує події з усіх місць в один масив, згрупований за номером місця. Це дозволяє відстежувати маршрут доставки кожного місця у складі багатомісного відправлення.
falseExample: trueСхема відповіді відстеження
Масив об'єктів, що містить список пов'язаних відправлень.
Неавторизований доступ
Вказаний ресурс не знайдено
Помилка валідації
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номер відправлення.
SHDE2072834273Структура метаданих
Внутрішній ідентифікатор відправлення.
Дата й час завантаження файлу. Дата у форматі ISO 8601.
Неавторизований доступ
Вказаний ресурс не знайдено
Можливі відповіді з помилками
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Номер відправлення.
SHDE2072834273Унікальний ідентифікатор файлу.
60946ff4-8170-415b-ab66-719848ef1da7Файл.
Неавторизований доступ
Вказаний ресурс не знайдено
Неможливо обробити сутність.
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Ідентифікатор відправлення на довгостроковому зберіганні.
🔻Це поле є обов'язковим.
Визначає, хто відповідає за оплату послуги повторної доставки.
Допустимі значення:
- Sender
- Recipient
- ThirdPerson
Якщо поле не передано, послугу оплачує користувач, який створює замовлення.
Обов'язковий параметр для B2B-клієнтів (юридичних осіб з оплатою за договором).
Будь-який коментар до замовлення.
Запит на повторну доставку успішно створено.
Вартість послуги повторної доставки.
Код валюти відповідно до стандарту ISO 4217.
Символ валюти.
Орієнтовна дата доставки у форматі ISO 8601.
Неавторизований доступ
Помилка валідації.
Час очікування з’єднання вичерпано
JWT-токен авторизації зі строком дії 1 годину у заголовку
Ідентифікатор відправлення, для якого необхідно скасувати замовлення на повторну доставку.
440459Замовлення на повторну доставку успішно скасовано. Повертає часову позначку скасування.
Часова позначка, коли замовлення на повторну доставку було скасовано.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Неможливо обробити сутність. Скасування неможливо виконати.
Останнє оновлення