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

Перенаправлення відправлення

Створити перенаправлення відправлення

post
/shipments/modification/redirecting

Метод дозволяє створити перенаправлення для вже існуючого відправлення Nova Post та змінити місце його отримання без створення нового відправлення.

За допомогою методу можна перенаправити відправлення:

  • у відділення;

  • у поштомат;

  • на адресу отримувача.

Для нового місця доставки необхідно використовувати лише один спосіб адресації:

  • recipient.divisionId — для доставки у відділення або поштомат;

  • recipient.addressParts.street разом з іншими обов’язковими полями recipient.addressParts — для адресної доставки.

🔸Не передавайте recipient.divisionId та recipient.addressParts.street одночасно. Якщо не передано жодне з цих полів, запит не пройде валідацію.

Після успішного створення перенаправлення нове відправлення створювати не потрібно. Перенаправлення застосовується до вже існуючого відправлення.

Authorizations
AuthorizationstringRequired

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

Body
idone ofRequired

Ідентифікатор існуючого відправлення, для якого необхідно створити перенаправлення.

Може бути переданий як додатне ціле число або UUID. Для числового значення мінімальне значення — 1.

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

Example: 19859866
integer · min: 1Optional
or
string · uuidOptional
payerTypestring · enumRequired

Сторона, відповідальна за оплату послуги перенаправлення. Доступні значення:

  • Sender — відправник;
  • Recipient — отримувач;
  • ThirdPerson — третя особа.

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

Possible values:
payerContractNumberstring · nullableOptional

Номер договору платника.

customerTypestring · enumOptional

Тип клієнта, який ініціює перенаправлення. Доступні значення:

  • Recipient — отримувач;
  • Sender — відправник.
Possible values:
customerPhonestring · nullableOptional

Контактний номер телефону клієнта.

sourcestring · enumOptional

Джерело створення перенаправлення.

Для інтеграції через API використовується значення API.

Possible values:
notestring · nullableOptional

Коментар до перенаправлення.

🔹Якщо коментар відсутній, передайте порожній рядок.

Responses
200

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

application/json
idintegerOptional

Ідентифікатор створеного перенаправлення.

numberstringOptional

Номер створеного перенаправлення.

shipmentIdintegerOptional

Ідентифікатор відправлення, для якого створено перенаправлення.

shipmentnumberstringOptional

Номер існуючого відправлення Nova Post.

typestring · enumOptional

Тип створеної модифікації.

Для цього методу повертається Redirecting.

Possible values:
statusstringOptional

Поточний статус обробки перенаправлення.

🔹NeedProcessing означає, що перенаправлення створено та передано на подальшу обробку.

Example: NeedProcessing
payerTypestring · enumOptional

Сторона, відповідальна за оплату послуги перенаправлення.

Possible values:
customerTypestring · enumOptional

Тип клієнта, який ініціював перенаправлення. Можливі значення:

  • Recipient — отримувач;
  • Sender — відправник.
Possible values:
notestringOptional

Коментар до перенаправлення.

scheduledDeliveryDatestring · date-timeOptional

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

costnumberOptional

Вартість послуги перенаправлення.

currencystringOptional

Код валюти вартості послуги.

Наприклад: USD.

currencySymbolstringOptional

Символ валюти.

Наприклад: $.

post/shipments/modification/redirecting
POST /v.1.0/shipments/modification/redirecting HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "id": 19859866,
  "payerType": "ThirdPerson",
  "payerContractNumber": "GNPMD-00029299",
  "customerType": "Sender",
  "source": "API",
  "note": "",
  "recipient": {
    "phone": "37123456789",
    "name": "Test Tesov",
    "countryCode": "MD",
    "divisionId": 12345,
    "addressParts": {}
  }
}
{
  "id": 9405417,
  "number": "SMUS0000205405",
  "shipmentId": 19859866,
  "shipmentnumber": "SHUS7810637809",
  "type": "Redirecting",
  "status": "NeedProcessing",
  "payerType": "ThirdPerson",
  "customerType": "Sender",
  "note": "",
  "scheduledDeliveryDate": "2026-09-27T07:55:00.000000Z",
  "cost": 3.36,
  "currency": "USD",
  "currencySymbol": "$"
}

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