freight

List freight shipments

Changed on

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

get/v1/freight/shipments

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/freight/shipments
  • Auth: API key in header API-Key

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.

created_at_startstring date-time

Only return freight shipments created on or after this date/time.

created_at_endstring date-time

Only return freight shipments created on or before this date/time.

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_code": "UNISHIPPERS",
      "status": "booked",
      "bol_number": "BOL-20260417-4821",
      "pro_number": "072-51293847",
      "confirmation_number": "FXFE-PU-884215",
      "created_at": "2026-09-18T14:54:44Z",
      "documents": [
        {
          "type": "bill_of_lading",
          "url": "/v1/downloads/10/a1b2c3d4e5f6/bill_of_lading.pdf"
        }
      ],
      "notifications": [
        {
          "events": [
            "booked",
            "in_transit"
          ],
          "email_addresses": [
            "logistics@example.com"
          ]
        }
      ]
    }
  ],
  "total": 137,
  "page": 1,
  "page_size": 25,
  "pages": 6
}

Changes

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status