Sign in

v1

latestOpenAPI 3.1.02026-07-2451827.5 KB
Carrier API

Get shipment document

Retrieves a document for a shipment. Returns a pre-signed download URL.

Supported document types:

  • BILL_OF_LADING — Bill of lading (driver version)
  • SHIPPING_LABEL — Shipping label
get/v1/carrier/shipments/{identifier}/document/{documentType}

Path parameters

identifierstring required

Shipment identifier (offerId, orderNumber, or carrierReference)

documentType'BILL_OF_LADING' | 'SHIPPING_LABEL' required

Document type

Response

Document URL retrieved successfully

filenamestring

Name of the document file

file_typestring

MIME type of the document

download_linkstring

Pre-signed download URL (valid for limited time)

Example response

{
  "filename": "bol-ZKYQ5.pdf",
  "file_type": "application/pdf",
  "download_link": "https://s3.amazonaws.com/..."
}