Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Отримати всі підписки

get
/tracking-push/subscribers

Отримати список усіх підписок, пов’язаних із клієнтом.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Responses
200

Успішна відповідь, що містить список підписок.

application/json
current_pageintegerOptional

Поточна сторінка набору результатів із пагінацією.

Example: 1
last_pageintegerOptional

Остання сторінка набору результатів із пагінацією.

Example: 1
per_pageintegerOptional

Кількість елементів на сторінці.

Example: 15
totalintegerOptional

Загальна кількість доступних підписок.

Example: 1
get/tracking-push/subscribers
GET /v.1.0/tracking-push/subscribers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_page": 1,
  "last_page": 1,
  "per_page": 15,
  "total": 3,
  "items": [
    {
      "id": "a47388e8-2af0-447e-a33b-1484b79b6331",
      "type": "numbers",
      "url": "https://api.somehost.link/endpoint",
      "isActive": true,
      "is_active": true,
      "phone": "",
      "cid": "11a111a1-a1a1-11aa-a111-111111aa1111",
      "eventTypes": [
        "ReadyToShip"
      ],
      "event_types": [
        "ReadyToShip"
      ],
      "sendWarnings": true,
      "send_warnings": true,
      "warningEmail": "someuser@novadigital.com",
      "warning_email": "someuser@novadigital.com",
      "contentType": "application/json",
      "companyTins": [],
      "company_tins": [],
      "secretToken": "k4MzM1NywiZXhwIjoxNzM3",
      "secret_token": "k4MzM1NywiZXhwIjoxNzM3",
      "secretTokenHeaderName": null,
      "secret_token_header_name": null,
      "updatedAt": "2025-04-14T07:26:20.994000Z",
      "updated_at": "2025-04-14T07:26:20.994000Z",
      "createdAt": "2025-04-14T07:26:20.994000Z",
      "created_at": "2025-04-14T07:26:20.994000Z",
      "numbers": []
    }
  ]
}

Створити нову підписку

post
/tracking-push/subscribers

Цей метод використовується для створення нової підписки для отримання сповіщень про відстеження через webhook. Підписка може бути різних типів, наприклад для окремого номера або для компанії, і є необхідною для клієнтів, які хочуть отримувати оновлення статусів відправлень у реальному часі.

Webhook-сповіщення за замовчуванням надсилаються з Content-Type application/json.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Query parameters
typestring · enumRequired

Тип підписки, яку необхідно створити. Це обов’язкове поле, яке може приймати такі значення:

  • individual: Для особистих облікових записів.
  • numbers: Для відстеження конкретних номерів відправлень.
  • legal: Для бізнес-облікових записів, що потребують додаткових даних про компанію.
  • recipientLegal: Для відстеження всіх відправлень, що прямують до юридичного клієнта-одержувача.
  • creator: Для відстеження всіх відправлень, створених клієнтом, незалежно від того, чи вказаний він як відправник.
Example: numbersPossible values:
urlstring · uri · min: 3Required

URL зворотного виклику, на який надсилатимуться webhook-сповіщення. Це обов’язкове поле та має містити коректний URL. URL повинен підтримувати отримання POST-запитів із JSON-навантаженням.

Example: https://api.webhook.test/test_endpoint
isActivebooleanRequired

Визначає, чи повинна підписка бути активною одразу після створення. Якщо встановлено значення true, webhook почне надсилати сповіщення відразу після підтвердження підписки. За замовчуванням використовується значення false, якщо параметр не передано.

Default: falseExample: true
phonestringOptional

Номер телефону, пов’язаний із підпискою. Цей параметр є обов’язковим, якщо тип підписки має значення individual. Номер телефону повинен бути в міжнародному форматі, наприклад 380637445555.

Example: 380630000001
secretTokenstringOptional

Токен авторизації webhook: максимальна довжина 600 символів.

Example: k4MzM1NywiZXhwIjoxNzM3
secretTokenHeaderNamestringOptional

Визначає назву заголовка, який використовується для передачі secretToken у webhook-запитах.

Example: X-Custom-Token
eventTypesstring[]Optional

Список типів подій, які буде відстежувати підписка. Цей параметр дозволяє визначити, які події повинні ініціювати webhook-сповіщення. Якщо значення не передано, підписка за замовчуванням буде створена для всіх типів подій.

Список підтримуваних типів подій включає:

  • ReadyToShip: Відправлення створено та готове до відправки.
  • Deleted: Відправлення видалено.
  • ParcelPlaceRemoved: Місце відправлення було видалено з відправлення.
  • Received: Відправлення отримано одержувачем.
  • MoneyTransfer: Створено грошовий переказ, пов’язаний із відправленням.
  • MoneyTransferReceived: Грошовий переказ, пов’язаний із відправленням, виплачено одержувачу.
  • Returned: Відправлення повертається або вже повернуто відправнику.
  • Refused: Одержувач відмовився прийняти відправлення.
  • Redirecting: Відправлення перенаправляється на іншу адресу або у відділення.
  • Utilization: Відправлення утилізовано.
  • Redelivery: Заплановано повторну спробу доставки відправлення.
  • UndeliveryReason: Зафіксовано причину недоставки.
  • ChangeTime: Дату або час доставки було змінено.
  • ArrivalSC: Відправлення прибуло до сортувального центру.
  • TransferToPartner: Відправлення передано партнеру для подальшої доставки.
  • LoadingCourier: Відправлення завантажено до транспортного засобу кур’єра.
  • ArrivalSenderWarehouse: Відправлення прибуло на склад відправника.
  • DepartureSenderWarehouse: Відправлення вибуло зі складу відправника.
  • InCityRecipient: Відправлення прибуло до міста одержувача.
  • AwaitingOnDivision: Відправлення очікує у відділенні або пункті видачі.

🔸Це поле приймає лише типи подій, наведені вище.
Будь-які значення поза цим списком не підтримуються та не повинні передаватися.

sendWarningsbooleanOptional

Визначає, чи потрібно надсилати попередження електронною поштою у разі виникнення проблем із зазначеним webhook URL. Якщо параметр увімкнено, система надсилатиме сповіщення про проблеми доставки або інші помилки. За замовчуванням використовується значення false.

Default: falseExample: true
warningEmailstring · emailOptional

Адреса електронної пошти, на яку надсилатимуться попередження щодо проблем із методом. Є обов’язковою, якщо параметр sendWarnings має значення true. Адреса електронної пошти повинна бути коректною та активною для забезпечення доставки попереджень.

Example: example@novadigital.com
companyTinsstring · uuid[]Optional

Список податкових ідентифікаційних номерів компаній, що використовуються для типу підписок legal або recipientLegal. Цей параметр є обов’язковим для юридичних підписок і необхідний для підтвердження особи компанії. Кожен TIN повинен бути коректним UUID.

Body
typestring · enumRequired

Тип підписки, яку необхідно створити.

Possible values:
urlstring · uriRequired

URL зворотного виклику, на який надсилатимуться webhook-сповіщення.

isActivebooleanRequired

Визначає, чи є підписка активною одразу після створення.

phonestringOptional

Номер телефону, пов’язаний із підпискою.

eventTypesstring[]Optional

Список типів подій, які буде відстежувати підписка.

sendWarningsbooleanOptional

Визначає, чи потрібно надсилати попередження електронною поштою щодо проблем доставки webhook.

warningEmailstring · emailOptional

Адреса електронної пошти, на яку надсилатимуться попередження.

companyTinsstring · uuid[]Optional

Список податкових ідентифікаційних номерів компаній для юридичних підписок.

  • Для legal підписка отримує події лише для відправлень, у яких значення поля sender.companyTin збігається з одним із значень, переданих у полі companyTins.
  • Для recipientLegal підписка отримує події лише для відправлень, у яких значення поля recipient.companyTin збігається з одним із значень, переданих у полі companyTins.

🔸Обов’язкове, якщо type має значення legal або recipientLegal.

secretTokenstring · max: 600Optional

Токен авторизації webhook, який використовується для перевірки вхідних webhook-запитів.

🔸Токен є необов’язковим і, якщо наданий, повинен містити лише літери та цифри.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secretTokenHeaderNamestringOptional

Визначає назву HTTP-заголовка, який використовується для передачі secretToken у webhook-запитах.

Якщо secretTokenHeaderName передано та його значення не є null, його значення використовується як назва заголовка для передачі secretToken.
Якщо secretTokenHeaderName не передано в запиті або явно встановлено значення null, використовується назва заголовка за замовчуванням X-NP-Key.

Вимоги до валідації:

  • Дозволені лише латинські літери, цифри та дефіси.
  • Не повинен починатися або закінчуватися дефісом.
  • Не повинен містити пробіли або будь-які інші спеціальні символи.

🔸Це поле є необов’язковим.

Example: X-Custom-TokenPattern: A-Za-z0-9
Responses
201

Підписку успішно створено.

application/json
idstringOptional

Унікальний ідентифікатор створеної підписки.

Example: f5300824-58a9-496b-ac3b-bee156844fdf
typestringOptional

Тип створеної підписки.

Example: numbers
secretTokenstring · max: 600Optional

Токен авторизації webhook, який використовується для перевірки вхідних webhook-запитів.

🔸Токен є необов’язковим і, якщо його надано, повинен містити лише літерно-цифрові символи.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secret_tokenstring · max: 600Optional

Застаріле поле. Збережено для зворотної сумісності. Використовуйте secretToken замість нього.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secretTokenHeaderNamestringOptional

Визначає назву HTTP-заголовка, який використовується для передачі secretToken у webhook-запитах.

🔸Якщо поле вказано, назва заголовка повинна складатися лише з латинських літер, цифр і дефісів, не повинна починатися або закінчуватися дефісом, а також не повинна містити пробіли чи інші спеціальні символи.

🔸Це поле є необов’язковим.

Example: X-Custom-TokenPattern: A-Za-z0-9
secret_token_header_namestringOptional

Застаріле поле. Збережено для зворотної сумісності. Використовуйте secretTokenHeaderName замість нього.

Example: X-Custom-TokenPattern: A-Za-z0-9
urlstring · uriOptional

URL зворотного виклику для підписки.

Example: https://api.example.com/webhook
isActivebooleanOptional

Визначає, чи є підписка наразі активною.

Example: true
is_activebooleanOptional

Застаріле поле. Збережено для зворотної сумісності. Використовуйте isActive замість нього.

Example: true
phonestringOptional

Номер телефону, пов’язаний із підпискою.

Example: 380630000001
cidstringOptional

Унікальний ідентифікатор користувача.

Example: 11a111a1-a1a1-11aa-a111-111111aa1111
eventTypesstring[]Optional

Список типів подій, які буде відстежувати підписка:

  • ReadyToShip: Відправлення створено та готове до відправки.
  • Deleted: Відправлення видалено.
  • ParcelPlaceRemoved: Місце відправлення було видалено з відправлення.
  • Received: Відправлення отримано одержувачем.
  • MoneyTransfer: Створено грошовий переказ, пов’язаний із відправленням.
  • MoneyTransferReceived: Грошовий переказ, пов’язаний із відправленням, виплачено одержувачу.
  • Returned: Відправлення повертається або вже повернуто відправнику.
  • Refused: Одержувач відмовився прийняти відправлення.
  • Redirecting: Відправлення перенаправляється на іншу адресу або у відділення.
  • Utilization: Відправлення утилізовано.
  • Redelivery: Заплановано повторну спробу доставки відправлення.
  • UndeliveryReason: Зафіксовано причину недоставки.
  • ChangeTime: Дату або час доставки було змінено.
  • ArrivalSC: Відправлення прибуло до сортувального центру.
  • TransferToPartner: Відправлення передано партнеру для подальшої доставки.
  • LoadingCourier: Відправлення завантажено до транспортного засобу кур’єра.
  • ArrivalSenderWarehouse: Відправлення прибуло на склад відправника.
  • DepartureSenderWarehouse: Відправлення вибуло зі складу відправника.
  • InCityRecipient: Відправлення прибуло до міста одержувача.
  • AwaitingOnDivision: Відправлення очікує у відділенні або пункті видачі.

🔸Це поле приймає лише типи подій, наведені вище.
Будь-які значення поза цим списком не підтримуються та не повинні передаватися.

Example: ["ReadyToShip"]
event_typesstring[]Optional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте eventTypes замість нього.

Example: ["ReadyToShip"]
sendWarningsbooleanOptional

Визначає, чи надсилаються попередження електронною поштою у разі некоректної роботи методу.

Example: true
send_warningsbooleanOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте sendWarnings замість нього.

Example: true
warningEmailstring · emailOptional

Адреса електронної пошти, яка використовується для надсилання попереджень.

Example: admin@example.com
warning_emailstring · emailOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте warningEmail замість нього.

Example: admin@example.com
contentTypestringOptional

Визначає Content-Type, який використовується для тіла webhook-запитів. Значення за замовчуванням — application/json.

Example: application/json
companyTinsstring[]Optional

Список податкових ідентифікаційних номерів юридичної особи, пов’язаної з підпискою.

company_tinsstring[]Optional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте companyTins замість нього.

updatedAtstring · date-timeOptional

Дата та час останнього оновлення підписки.

Example: 2024-02-26T20:08:26.217000Z
updated_atstring · date-timeOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте updatedAt замість нього.

Example: 2024-02-26T20:08:26.217000Z
createdAtstring · date-timeOptional

Дата та час створення підписки.

Example: 2024-02-26T20:08:26.217000Z
created_atstring · date-timeOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте createdAt замість нього.

Example: 2024-02-26T20:08:26.217000Z
post/tracking-push/subscribers
POST /v.1.0/tracking-push/subscribers?type=numbers&url=https%3A%2F%2Fapi.webhook.test%2Ftest_endpoint&isActive=false HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "type": "numbers",
  "url": "https://api.webhook.test/test_endpoint",
  "isActive": true,
  "phone": "",
  "eventTypes": [
    "ReadyToShip",
    "Received",
    "Returned"
  ],
  "sendWarnings": true,
  "warningEmail": "example@novadigital.com",
  "companyTins": [],
  "secretToken": "k4MzM1NywiZXhwIjoxNzM3",
  "secretTokenHeaderName": "X-Custom-Token"
}
{
  "id": "a866fe22-8134-45c7-bfe9-3cf348415e26",
  "type": "numbers",
  "url": "https://api.somehost.link/endpoint",
  "isActive": true,
  "is_active": true,
  "phone": "",
  "cid": "11a111a1-a1a1-11aa-a111-111111aa1111",
  "eventTypes": [
    "ReadyToShip"
  ],
  "event_types": [
    "ReadyToShip"
  ],
  "sendWarnings": true,
  "send_warnings": true,
  "contentType": "application/json",
  "companyTins": [],
  "company_tins": [],
  "secretToken": "k4MzM1NywiZXhwIjoxNzM3",
  "secret_token": "k4MzM1NywiZXhwIjoxNzM3",
  "secretTokenHeaderName": "X-Custom-Token",
  "secret_token_header_name": "X-Custom-Token",
  "warningEmail": "someuser@novadigital.com",
  "warning_email": "someuser@novadigital.com",
  "updatedAt": "2025-04-14T07:26:20.994000Z",
  "updated_at": "2025-04-14T07:26:20.994000Z",
  "createdAt": "2025-04-14T07:26:20.994000Z",
  "created_at": "2025-04-14T07:26:20.994000Z"
}

Оновити існуючу підписку

put
/tracking-push/subscribers/{id}

Цей метод оновлює дані існуючої підписки, зокрема callback URL, статус активності, типи подій тощо.

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

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор підписки, яку необхідно оновити. Це обов’язковий параметр шляху, який використовується для визначення підписки, що буде змінена.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26
Body
urlstring · uriRequired

Нова URL-адреса зворотного виклику для webhook-сповіщень. Цей URL повинен бути доступним і підтримувати обробку POST-запитів.

Example: https://api.example.com/updated-webhook
isActivebooleanRequired

Визначає, чи є підписка наразі активною. Встановіть значення true, щоб активувати підписку, або false, щоб деактивувати її.

Example: false
typestring · enumOptional

Тип створеної підписки.

Example: recipientLegalPossible values:
eventTypesstring[]Optional

Список типів подій, які буде відстежувати підписка. Ви можете вказати, які події повинні ініціювати webhook-сповіщення.

Example: null
sendWarningsbooleanOptional

Визначає, чи повинна система надсилати попередження електронною поштою щодо проблем із зазначеним webhook URL. Встановіть значення true, щоб увімкнути надсилання попереджень.

Example: false
warningEmailstring · emailOptional

Адреса електронної пошти для надсилання попереджень. Це поле є необхідним, якщо параметр sendWarnings має значення true.

Example: admin@example.com
companyTinsstring · uuid[]Optional

Список податкових ідентифікаційних номерів компаній, що використовуються для типу підписок legal або recipientLegal.

  • Для legal підписка отримує події лише для відправлень, у яких значення поля sender.companyTin збігається з одним із значень, переданих у полі companyTins.
  • Для recipientLegal підписка отримує події лише для відправлень, у яких значення поля recipient.companyTin збігається з одним із значень, переданих у полі companyTins.
secretTokenstring · max: 600Optional

Токен авторизації webhook, який використовується для перевірки вхідних webhook-запитів.

🔸Токен є необов’язковим і, якщо його надано, повинен містити лише літерно-цифрові символи.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secretTokenHeaderNamestringOptional

Визначає назву HTTP-заголовка, який використовується для передачі secretToken у webhook-запитах.

Якщо secretTokenHeaderName передано та його значення не є null, його значення використовується як назва заголовка для передачі secretToken.
Якщо secretTokenHeaderName не передано в запиті або явно встановлено значення null, використовується назва заголовка за замовчуванням X-NP-Key.

Вимоги до валідації:

  • Дозволені лише латинські літери, цифри та дефіси.
  • Не повинен починатися або закінчуватися дефісом.
  • Не повинен містити пробіли або будь-які інші спеціальні символи.

🔸Це поле є необов’язковим.

Example: X-Custom-TokenPattern: A-Za-z0-9
Responses
200

Підписку успішно оновлено.

application/json
idstringOptional

Унікальний ідентифікатор оновленої підписки.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26
typestringOptional

Тип підписки, наприклад individual, numbers або legal.

Example: individual
urlstring · uriOptional

Оновлений URL зворотного виклику для підписки.

Example: https://api.example.com/updated-webhook
isActivebooleanOptional

Визначає, чи є підписка наразі активною.

Example: false
is_activebooleanOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте isActive замість нього.

Example: false
phonestringOptional

Номер телефону, пов’язаний із підпискою, якщо застосовно.

Example: 380001234567
cidstringOptional

Унікальний ідентифікатор користувача.

Example: 11a111a1-a1a1-11aa-a111-111111aa1111
eventTypesstring[]Optional

Список типів подій, які буде відстежувати підписка.

event_typesstring[]Optional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте eventTypes замість нього.

sendWarningsbooleanOptional

Визначає, чи надсилаються попередження електронною поштою у разі некоректної роботи методу.

Example: false
send_warningsbooleanOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте sendWarnings замість нього.

Example: false
warningEmailstring · emailOptional

Адреса електронної пошти, яка використовується для надсилання попереджень.

Example: admin@example.com
warning_emailstring · emailOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте warningEmail замість нього.

Example: admin@example.com
contentTypestringOptional

Визначає Content-Type, який використовується для тіла webhook-запитів.

Значення за замовчуванням — application/json.

Example: application/json
companyTinsstring[]Optional

Список податкових ідентифікаційних номерів юридичної особи, пов’язаної з підпискою.

company_tinsstring[]Optional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте companyTins замість нього.

secretTokenstring · max: 600Optional

Токен авторизації webhook, який використовується для перевірки вхідних webhook-запитів.

🔸Токен є необов’язковим і, якщо його надано, повинен містити лише літерно-цифрові символи.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secret_tokenstring · max: 600Optional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте secretToken замість нього.

Example: k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$
secretTokenHeaderNamestringOptional

Визначає назву HTTP-заголовка, який використовується для передачі secretToken у webhook-запитах.

🔸Це поле є необов’язковим і, якщо його вказано, повинно містити лише латинські літери, цифри та дефіси, не повинно починатися або закінчуватися дефісом, а також не повинно містити пробіли чи інші спеціальні символи.

Pattern: A-Za-z0-9
secret_token_header_namestringOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте secretTokenHeaderName замість нього.

Example: X-Custom-Token
updatedAtstring · date-timeOptional

Дата та час останнього оновлення підписки.

Example: 2025-04-14T07:53:38.970000Z
updated_atstring · date-timeOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте updatedAt замість нього.

Example: 2025-04-14T07:53:38.970000Z
createdAtstring · date-timeOptional

Дата та час створення підписки.

Example: 2025-04-14T07:53:38.970000Z
created_atstring · date-timeOptional

Застаріле поле. Збережено для забезпечення зворотної сумісності. Використовуйте createdAt замість нього.

Example: 2025-04-14T07:53:38.970000Z
put/tracking-push/subscribers/{id}
PUT /v.1.0/tracking-push/subscribers/{id} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "url": "https://api.somehost.link/endpoint",
  "isActive": false,
  "type": "numbers",
  "eventTypes": [],
  "sendWarnings": true,
  "warningEmail": "someuser@novadigital.com",
  "secretToken": "k4MzM1NywiZXhwIjoxNzM3",
  "secretTokenHeaderName": "X-Custom-Token"
}
{
  "id": "a866fe22-8134-45c7-bfe9-3cf348415e2",
  "type": "numbers",
  "url": "https://api.somehost.link/endpoint",
  "is_active": false,
  "phone": "",
  "cid": "11a111a1-a1a1-11aa-a111-111111aa1111",
  "event_types": [],
  "send_warnings": false,
  "warning_email": "someuser@novadigital.com",
  "contentType": "application/json",
  "company_tins": [],
  "secret_token": "k4MzM1NywiZXhwIjoxNzM3",
  "secret_token_header_name": "X-Custom-Token",
  "updated_at": "2025-04-14T07:53:38.970000Z",
  "created_at": "2025-04-14T07:53:38.970000Z"
}

Видалити підписку

delete
/tracking-push/subscribers/{id}

Цей метод видаляє підписку, зазначену за її унікальним ідентифікатором. Після видалення підписка більше не отримуватиме webhook-сповіщення. Видалення є незворотним, тому цю дію слід виконувати з обережністю.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор підписки, яку необхідно видалити. Це обов’язковий параметр шляху, який визначає конкретну підписку, що буде видалена.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26
Responses
204

Підписку успішно видалено.

application/json
messagestringOptional

Повідомлення-підтвердження про успішне видалення підписки.

delete/tracking-push/subscribers/{id}
DELETE /v.1.0/tracking-push/subscribers/{id} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": null
}

Додати номери до існуючої підписки

post
/tracking-push/subscribers/{id}/numbers

Цей метод дозволяє додавати номери відправлень до існуючої підписки, зазначеної за її унікальним ідентифікатором. Ці номери використовуються для відстеження конкретних відправлень, пов’язаних із підпискою.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор підписки, до якої будуть додані номери відправлень. Це обов’язковий параметр шляху.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26
Body
numbersstring[]Optional

Список номерів відправлень, які необхідно додати до підписки.

Example: ["20600000179995","20600000179992"]
Responses
200

Номери успішно додано до підписки.

application/json
messagestringOptional

Повідомлення-підтвердження про успішне додавання номерів.

Example: Numbers successfully added to the subscription.
addedNumbersstring[]Optional

Список номерів, які були успішно додані до підписки.

Example: ["SHPL2666212296","SHPL6628713835"]
missedNumbersstring[]Optional

Список номерів, які не вдалося додати (наприклад, некоректні або вже пов’язані з підпискою).

post/tracking-push/subscribers/{id}/numbers
POST /v.1.0/tracking-push/subscribers/{id}/numbers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "numbers": [
    "20600000179995",
    "20600000179992"
  ]
}
{
  "message": "Numbers successfully added to the subscription.",
  "addedNumbers": [
    "SHPL2666212296",
    "SHPL6628713835"
  ],
  "missedNumbers": []
}

Видалити номери з існуючої підписки

delete
/tracking-push/subscribers/{id}/numbers

Цей метод дозволяє видаляти номери відправлень з існуючої підписки, зазначеної за її унікальним ідентифікатором.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters
idstringRequired

Унікальний ідентифікатор підписки, з якої будуть видалені номери відправлень. Це обов’язковий параметр шляху.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26
Body
numbersstring[]Optional

Список номерів відправлень, які необхідно видалити з підписки.

Example: ["20600000179995","20600000179992"]
Responses
200

Номери успішно видалено з підписки.

application/json
messagestringOptional

Повідомлення-підтвердження про успішне видалення номерів.

delete/tracking-push/subscribers/{id}/numbers
DELETE /v.1.0/tracking-push/subscribers/{id}/numbers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "numbers": [
    "20600000179995",
    "20600000179992"
  ]
}
{
  "message": {}
}

Перевірка тестового webhook

post
/tracking-push/subscribers/test-webhook

Цей метод дозволяє перевірити роботу webhook. Для успішної відповіді потрібна щонайменше одна активна підписка.

Webhook-запити за замовчуванням надсилаються з Content-Type application/json.

🔹Поведінка тестового webhook: Метод повертає відповідь-підтвердження про те, що тестовий webhook-запит було надіслано. Подія webhook з даними відстеження надсилається на URL, вказаний підписником.

🔹Структура тіла webhook-запиту: Тіло webhook-запиту має наступний вигляд:

{
  "number": "SHPL0000000001",
  "scheduled_delivery_date": "2024-11-20T20:03:00.000000Z",
  "history_tracking": [
    {
      "code": "4",
      "code_name": "On the way",
      "country_code": "UA",
      "settlement": "Kyiv",
      "date": "2024-11-19T09:32:05.000000Z"
    },
    {
      "code": "112",
      "code_name": "Change of delivery date",
      "country_code": "",
      "settlement": "",
      "date": "2024-11-19T09:33:56.000000Z"
    }
  ]
}

із такими параметрами:

  • number — номер відправлення.

  • scheduled_delivery_date — заплановані дата та час доставки у форматі ISO 8601.

  • history_tracking — масив об’єктів статусів відстеження.

    • code — код статусу відстеження. Докладніше про коди статусів відстеження дивіться в описі параметра currentStatus.statusCode у відповіді методу Повне відстеження.

    • code_name — назва статусу відстеження.

    • country_code — код країни, у якій було зафіксовано статус.

    • settlement — назва населеного пункту.

    • date — дата та час події статусу.

Тіло webhook-запиту містить щонайменше один статус відстеження. Кожне наступне webhook-сповіщення містить новий доданий статус і всі раніше доставлені статуси.

Authorizations
AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Body
numbersstring[]Optional

Тестовий номер відправлення завжди має значення SHPL0000000001.

Example: ["SHPL0000000001"]
idstringOptional

Унікальний ідентифікатор створеної підписки.

Example: f5300824-58a9-496b-ac3b-bee156844fdf
cidstringOptional

Унікальний ідентифікатор користувача.

Example: 11a111a1-a1a1-11aa-a111-111111aa1111
Responses
200

Тестовий webhook успішно надіслано.

application/json
successstringOptional

Повідомлення-підтвердження про успішне виконання тесту.

Example: true
post/tracking-push/subscribers/test-webhook
POST /v.1.0/tracking-push/subscribers/test-webhook HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "numbers": [
    "SHPL0000000001"
  ],
  "id": "f5300824-58a9-496b-ac3b-bee156844fdf",
  "cid": "11a111a1-a1a1-11aa-a111-111111aa1111"
}
{
  "success": true
}
ПопередняКур'єрська доставка
НаступнаФулфілмент

Останнє оновлення