List Carrier Documents
This API endpoint can be used to retrieve a list of documents from a carrier associated with a specified PRO number. The documents that can be associated with a PRO number are bill_of_lading, delivery_receipt, invoice, or weight_inspection_certificate.
PRO Numbers
The PRO number is equivalent to the tracking number in parcel shipping. Some carriers support automatically generated PRO numbers. If so, one will be included in the quote response. If a PRO number is not returned in the response, then one will be assigned by the carrier at the time of pickup.
You will need this number to track your shipment.
Carrier Codes
In the request below, you will need to know the carrier code for your LTL carrier. This code will be passed in the URL as a query string.
The carrier codes are mapped to the carriers' SCACs, and many carriers have more than one. The SCACs may correspond to different services or other arrangements that the carrier offers. For more information about the individual SCACs listed, contact the carrier.
Response Body
The response object returned from sucessful requests to this endpoint will contain a list of documents and each document listed will contain the parameters listed in the table below. To see a sample of a full response, see the Example Response section below.
| Name | Type | Required | Description |
|---|---|---|---|
type | string | ✔ | The document type returned will be bill_of_lading, delivery_receipt, invoice, or weight_inspection_certificate. |
image | string | ✔ | The base64-encoded bill of lading document. |
format | string | ✔ | The format of the document which will always be pdf for pickup responses. The base64-encoded image string will be in this format once decoded. |
Example Request
GET /v-beta/ltl/carriers/:carrier_id/documents/:pro_number
123
Example Response
123456789101112131415161718192021222324