Завантаження файлів

Завантажити файл до відправлення

post

/shipments/attachments/uploads/{id}

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

⚠️ Обмеження за регіоном: Цей метод доступний лише для європейських відправлень (напрямки EU/EU та EU/UA). Він недоступний для відправлень, що відправляються з України.

Ім'я файлу: • Якщо передано параметр "fileName", завантажений файл буде збережено з указаним ім'ям. • Якщо параметр "fileName" не передано, за замовчуванням буде встановлено ім'я файлу "invoice".

Приклади використання:

1. "Я хочу завантажити PDF-інвойс клієнта до відправлення 980911" — передайте вміст, закодований у base64, у параметрі "file" та встановіть "fileName": "invoice.pdf".
2. "Я хочу додати фотографію товару у форматі JPEG" — закодуйте фотографію у base64 та встановіть "fileName": "product-photo.jpeg".

Authorizations

AuthorizationstringRequired

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

Path parameters

idinteger · int32Required

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

Body

filestringOptional

Файл документа, закодований у base64 (PDF, JPEG або інші підтримувані формати).

fileNamestringOptional

Необов'язкове ім'я файлу. Якщо не вказано, за замовчуванням використовується значення invoice.

Responses

201

Результат завантаження файлу

application/json

successbooleanOptional

Вказує, чи було файл успішно завантажено.

401

Неавторизований доступ

application/json

404

Вказаний ресурс не знайдено

application/json

422

Помилка валідації

application/json

503

Час очікування з’єднання вичерпано

application/json

post/shipments/attachments/uploads/{id}

POST /v.1.0/shipments/attachments/uploads/{id} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "file": "/9j/4AAQSkZJRgABAQEAYABgAAD... (base64 content truncated)",
  "fileName": "product-photo.jpeg"
}

{
  "success": true
}