added

Public API Now Supports Document Fetching Across Core Entities

We’ve added new Documents retrieval endpoints to the Public API. These endpoints allow you to retrieve uploaded documents for carriers, drivers, loads, trips, trucks, and trailers.


What Changed?

Previously, documents were only available through internal UI and were not exposed in the Public API.

Now, the following new endpoints are available for retrieving documents associated with each entity type:

Endpoints Added:

GET /api/p/{version}/carriers/{carrierId}/documents

GET /api/p/{version}/drivers/{driverId}/documents

GET /api/p/{version}/loads/{loadNumber}/documents

GET /api/p/{version}/trips/{tripId}/documents

GET /api/p/{version}/trucks/{truckId}/documents

GET /api/p/{version}/trailers/{trailerId}/documents


Response Example

Each endpoint returns an array of document objects, providing all documents linked to the specified entity. Each document includes details such as type, size, uploader, and upload time, along with a secure download link. The DownloadUrl is valid for 10 minutes and includes an ExpiresAt timestamp.

[
  {
    "id": "a314c7cd-783a-4807-8771-06406a9e490a",
    "AttachmentPath": "Loads-1759237626.pdf",
    "AttachmentType": "Customer Rate Confirmation",
    "AttachmentSize": 170225,
    "UploadedAt": "2025-09-30T13:07:07+00:00",
    "ParentId": "3022259",
    "ParentType": "Load",
    "UploadedBy": "7190175eecc3408e90d7173f4ece0e59",
    "DownloadUrl": "https://alvysqastorage.blob.core.windows.net/tl743/Loads-1759237626.pdf?...",
    "ExpiresAt": "2025-09-30T15:12:15.9506343+00:00"
  }
]

Why?

This enhancement improves transparency and flexibility by making documents accessible through the Public API. It supports broader use cases, enabling external systems to integrate seamlessly with Alvys data and workflows.