latestOpenAPI 3.0.0Proprietary2026-08-22131410675.6 KB

8d8a7cf79204

freight

List freight shipments

Return the freight shipments on your account, most recently created first. Results are paginated.

get/v1/freight/shipments

Query parameters

pageinteger

The page of results to return. Values below 1 are treated as 1.

page_sizeinteger

The number of freight shipments to return per page. Values above 500 are capped at 500.

Response

The request was a success.

totalinteger

The total number of freight shipments on the account.

pageinteger

The page of results returned.

page_sizeinteger

The number of freight shipments per page.

pagesinteger

The total number of pages available.

Example response

{
  "shipments": [
    {
      "freight_shipment_id": "se-28529731",
      "freight_provider_account_id": "se-28529731",
      "freight_provider_name": "UNISHIPPERS",
      "status": "booked",
      "product_transaction_id": "7f1c9a52-3d84-4f0e-9b3a-2c6d5e4f8a10",
      "pickup_transaction_id": "3ac81f60-92b7-4de1-8f04-5b9a7c2e6d13",
      "bol_number": "BOL-20260417-4821",
      "pro_number": "072-51293847",
      "confirmation_number": "FXFE-PU-884215",
      "documents": [
        {
          "type": "bill_of_lading",
          "url": "/v1/downloads/10/a1b2c3d4e5f6/bill_of_lading.pdf"
        }
      ]
    }
  ],
  "total": 137,
  "page": 1,
  "page_size": 25,
  "pages": 6
}