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

Proof of delivery

Список вкладень

get
/shipments/{shipmentNumber}/attachments

Повертає список доступних файлів, прикріплених до відправлення (фотографії та/або підпис), для вказаного відправлення лише якщо відправлення належить автентифікованому клієнту.

Authorizations
AuthorizationstringRequired

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

Path parameters
shipmentNumberstringRequired

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

Example: SHDE2072834273
Responses
200

Структура метаданих

application/json
shipmentIdintegerOptional

Внутрішній ідентифікатор відправлення.

createdAtstringOptional

Дата й час завантаження файлу. Дата у форматі ISO 8601.

get/shipments/{shipmentNumber}/attachments
GET /v.1.0/shipments/{shipmentNumber}/attachments HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "shipmentId": 279708,
    "storageInfo": {
      "id": "c0da6fe9-997b-4f8d-b798-0150e50a6655",
      "name": "string (11).png",
      "documentType": "signature"
    },
    "createdAt": "2025-07-29T14:07:30.135738Z"
  },
  {
    "shipmentId": 279708,
    "storageInfo": {
      "id": "da2dc99f-c7e9-478d-9597-9ccca38f6bdb",
      "name": "IMG_8034.JPG.png",
      "documentType": "proofOfDelivery"
    },
    "createdAt": "2025-07-29T14:08:16.476107Z"
  },
  {
    "shipmentId": 279708,
    "storageInfo": {
      "id": "038a5340-f2a1-4982-a88b-8ad01b80bd81",
      "name": "IMG_7298.JPG.png",
      "documentType": "proofOfDelivery"
    },
    "createdAt": "2025-07-29T14:07:30.135738Z"
  },
  {
    "shipmentId": 279708,
    "storageInfo": {
      "id": "257f5a42-1c0f-48aa-9805-0af3a757b863",
      "name": "IMG_8000.JPG.png",
      "documentType": "proofOfDelivery",
      "createdAt": "2025-07-29T14:07:30.135738Z"
    }
  }
]

Завантажити вкладення

get
/shipments/{shipmentNumber}/attachments/{fileId}

Повертає потік файлу, вказаного за fileId, якщо відправлення належить автентифікованому клієнту.

Authorizations
AuthorizationstringRequired

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

Path parameters
shipmentNumberstringRequired

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

Example: SHDE2072834273
fileIdstringRequired

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

Example: 60946ff4-8170-415b-ab66-719848ef1da7
Responses
200

Файл.

application/pdf
string · binaryOptional
get/shipments/{shipmentNumber}/attachments/{fileId}
GET /v.1.0/shipments/{shipmentNumber}/attachments/{fileId} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*
binary

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