Get Documents

This API endpoint is used to the obtain freight documents associated with a PRO Number. By default this request will return all available document types.

You can request a specific document by appending &document_type= to the GET request and then specifying which document type you would like returned. Available document types include bill_of_lading, delivery_receipt, invoice, and weight_inspection_certificate.

Carrier IDs

Each of your LTL carriers has a unique carrier_id in ShipEngine. You can use this carrier_id for many ShipEngine endpoints to indicate which account to use. You can find carrier_ids from the List Connected Carriers endpoint. You will need to include the carrier_id for the carrier for which you would like to request the document(s).

Pro Number

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 or spot 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.

Example Requests & Responses

Response Body

Name Type Description
documents[] array array of document objects. Each object contains the information for a single document. For a specific document request, only the requested document will be returned.
documents.type string The document type. You can expect bill_of_lading, delivery_receipt, invoice, and/or weight_inspection_certificate to be returned based on your request.
documents.image string The base64-encoded version of the document.
documents.format string The format of the document which will always be pdf. The base64-encoded image string will be in this format once decoded.

Request all Documents

GET /v-beta/ltl/v1/documents/:carrier_id?pro_number=:pro_number

GET /v-beta/ltl/documents/car_vsY7PLz7KEs48vh9?pro_number=24601-42 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

{
    "documents": [
        {
            "type": "bill_of_lading",
            "image": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgSCi9Sb290IDEgMCBSCi9TaXplIDgKPj4Kc3RhcnR4cmVmCjE3NTg4MQolJUVPRgo=",
            "format": "pdf"
        },
        {
            "type": "delivery_receipt",
            "image": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGCBSCi9TaXplIDgKPj4Kc3RhcnR4cmVmCjE3NTg4MQolJUVPRgo=",
            "format": "pdf"
        },
        {
            "type": "invoice",
            "image": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAi9Sb290IDEgMCBSCi9TaXplIDgKPj4Kc3RhcnR4cmVmCjE3NTg4MQolJUVPRgo=",
            "format": "pdf"
        },
        {
            "type": "weight_inspection_certificate",
            "image": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ2290IDEgMCBSCi9TaXplIDgKPj4Kc3RhcnR4cmVmCjE3NTg4MQolJUVPRgo=",
            "format": "pdf"
        }
    ]
}

Note documents.image results have been truncated for clarity in this example.


Request a Specific Document

GET /v-beta/ltl/v1/documents/:carrier_id?pro_number=:pro_number&document_type=:document_type

GET /v-beta/ltl/documents/car_vsY7PLz7KEs48vh9?pro_number=24601-42&document_type=bill_of_lading HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

{
    "documents": [
        {
            "type": "bill_of_lading",
            "image": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDbIDcgMCBSCi9Sb290IDEgMCBSCi9TaXplIDgKPj4Kc3RhcnR4cmVmCjE3NTg4MQolJUVPRgo=",
            "format": "pdf"
        }
    ]
}

Note documents.image results have been truncated for clarity in this example.