Upload multipart/form-data. One file per request. Max file size 25 MB. Allowed document types: Proof of Delivery, Bill of Lading, Carrier Rate Confirmation, Load Manifest, Trip Report, Temp. Log, Proof of Pickup, Scale Ticket, Notice of Assignment, NOA, Shipping Labels. Allowed MIME types: application/pdf, image/jpeg, image/png.
Upload a document to a specific trip (or split trip). Supports multipart/form-data
. Each request must contain exactly one file.
-
Max file size: 25 MB
-
Allowed MIME types:
application/pdf
,image/jpeg
,image/png
-
Allowed Document Types: Proof of Delivery (POD), Bill of Lading (BOL), Carrier Rate Confirmation, Load Manifest, Trip Report, Temperature Log, Proof of Pickup, Scale Ticket, Notice of Assignment (NOA), Shipping Labels
- Not allowed: Carrier Invoice, Trip Manifest
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
tripId | path | string | Yes | Unique identifier of the trip |
version | path | string | Yes | API version (e.g., 1.0 ) |
Request Body
multipart/form-data
Parameter | Type | Required | Description |
---|---|---|---|
File | binary | Yes | The file to upload (PDF, JPEG, PNG). Max size 25 MB. |
FileName | string | No | Optional custom filename (if omitted, filename is taken from multipart part) |
DocumentType | string | Yes | The type of document. Must match one of the allowed document types. |
Example Request (cURL)
curl -X POST "{{host}}/api/p/v1/trips/{tripId}/document" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: multipart/form-data" \
-F "[email protected]" \
-F "DocumentType=Bill of Lading"
Response Body
Parameter | Type | Description |
---|---|---|
id | string | Unique identifier of the uploaded document |
AttachmentPath | string | File name/path assigned on upload + timestamp suffix (e.g., 1757343192 ) |
AttachmentType | string | Type of document (matches DocumentType ) |
AttachmentSize | integer | Size of the file in bytes |
UploadedAt | string | UTC timestamp when the file was uploaded (ISO 8601) |
ParentId | string | Identifier of the parent entity (the {tripId} ) |
ParentType | string | Entity type the document is attached to (Trip ) |
Example Response
200 OK
{
"id": "e7c9f1a2-005e-0000-a4ee-45ca5e8600a",
"AttachmentPath": "BillOfLading-1757343192.jpg",
"AttachmentType": "Bill of Lading",
"AttachmentSize": 2097152,
"UploadedAt": "2025-09-09T08:26:03.194Z",
"ParentId": "trp-12345",
"ParentType": "Trip"
}
On the right side, you can see examples of different error codes by clicking Example and selecting the response code.
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the Rate Limits section.
Try It Out
This page is interactive, allowing you to try a request by specifying the API version and tripId in the URL path.
As you fill out the parameters, the cURL command on the right side of the page will be automatically updated. Alternatively, you can directly edit the cURL command.
⚠️ Don’t forget: make sure to authorize yourself before trying a request.