Freight Shipment Documents

Retrieve the freight shipment documents associated with a PRO number. By default this request will return all available document types. You can optionally specify a document_type value in order to download a particular kind of document.

SecurityFreightApiCode
Request
Request Body schema: application/json
transaction_id
required
string
scac
required
string

The NMFTA Standard Carrier Alpha Code is used to identify a freight carrier within the transportation industry.

auth
object

The carrier authorization information needed to fulfill this request.

pro_number
required
string
document_type
string (DocumentType)
Enum: "bill_of_lading" "delivery_receipt" "invoice" "weight_inspection_certificate"
Responses
200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

520

External Server Error

post/freight-shipment-documents
Request samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "auth": { },
  • "pro_number": "string",
  • "document_type": "bill_of_lading"
}
Response samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "documents": [
    ]
}