Cупровідні документи

Завантаження супровідних документів

post

/shipments/invoice-files

Завантажує супровідні документи для відправлення.

Метод приймає файли у форматі multipart/form-data. Кожен файл повинен містити метадані з інформацією про відправлення та документ.

Структура запиту

• files[0].file — бінарний файл.
• files[0].metadata — JSON-рядок з метаданими файлу.

Обов’язкові поля метаданих

• menNumber — номер відправлення.
• name — назва файлу.
• typeCode — короткий код типу документа.

Обмеження

• Максимальна кількість файлів в одному запиті: 6.
• Максимальний розмір файлу: 1 MB.
• Дублікати назв файлів в межах одного запиту не допускаються.
• Непідтримувані розширення файлів не допускаються.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Body

Responses

200

Файли успішно завантажено.

application/json

404

Відправлення не знайдено.

application/json

422

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

application/json

post/shipments/invoice-files

POST /v.1.0/shipments/invoice-files HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 47

{
  "files": [
    {
      "file": "binary",
      "metadata": "text"
    }
  ]
}

{
  "files": [
    {
      "UUID": "52300_",
      "name": "invoice.pdf",
      "status": "uploaded"
    },
    {
      "UUID": null,
      "name": "invoice2.pdf",
      "status": "failed"
    }
  ]
}

Отримання списку супровідних документів

get

/shipments/{men}/invoice-files

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

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

menstringRequired

Номер відправлення.

Example: 51610811647217

Responses

200

Список файлів відправлення.

application/json

404

Відправлення не знайдено.

422

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

get/shipments/{men}/invoice-files

GET /v.1.0/shipments/{men}/invoice-files HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "files": [
    {
      "UUID": "8be65310-c7c5-40aa-97f7-c4028b5fffc5",
      "name": "file 1.jpg",
      "metadata": {
        "typeId": "5c7bd5e2-4c52-11f0-a12b-005056bd8d41",
        "documentType": "Рахунок Фактура (Comercial Invoice)",
        "typeCode": "0380",
        "sourceSystem": "clientapi",
        "uploadedAt": "2026-04-09T14:13:17.744082Z"
      }
    },
    {
      "UUID": "98076158-aef6-4cf4-8a77-ede51acd5387",
      "name": "file 2.jpg",
      "metadata": {
        "typeId": "5c7bd5e2-4c52-11f0-a12b-005056bd8d41",
        "documentType": "Рахунок Фактура (Comercial Invoice)",
        "typeCode": "0380",
        "sourceSystem": "clientapi",
        "uploadedAt": "2026-04-09T14:16:35.084945Z"
      }
    }
  ]
}

Видалення супровідних документів

delete

/shipments/{men}/invoice-files

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

Видалення є незворотним, тому використовуйте метод з обережністю.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

menstringRequired

Номер відправлення.

Example: 51610811647217

Body

UUIDsstring[]Optional

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

Responses

200

Файли успішно оброблено.

application/json

404

Відправлення не знайдено.

422

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

delete/shipments/{men}/invoice-files

DELETE /v.1.0/shipments/{men}/invoice-files HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "UUIDs": [
    "{uuid1}",
    "{uuid2}"
  ]
}

{
  "results": [
    {
      "UUID": "f_1",
      "status": "deleted"
    },
    {
      "UUID": "f_1",
      "status": "already_deleted"
    },
    {
      "UUID": "f_2",
      "status": "error",
      "message": "Storage unavailable"
    }
  ]
}

Отримання файлу супровідного документа

get

/shipments/{men}/invoice-files/{uuid}

Завантажує файл супровідного документа відправлення.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

menstringRequired

Номер відправлення.

Example: 51610811647217

uuidstringRequired

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

Example: 8be65310-c7c5-40aa-97f7-c4028b5fffc5

Responses

200

Вміст файлу.

application/octet-stream

string · binaryOptional

404

Відправлення не знайдено.

422

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

get/shipments/{men}/invoice-files/{uuid}

GET /v.1.0/shipments/{men}/invoice-files/{uuid} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

binary