---
title: "List freight shipments"
method: GET
path: "/v2/freight/shipments"
tags: ["freight"]
---

# List freight shipments

`GET /v2/freight/shipments`

<aside class="access" aria-label="Endpoint access">
      <table class="access__table">
        <thead>
          <tr>
            <th class="access__table-header">Products</th>
            <th class="access__table-header">Plans</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td class="access__table-cell access__product">
              <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/>
              <div class="access__sub">Formerly ShipEngine</div>
            </td>
            <td class="access__table-cell access__plans">
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a>
            </td>
          </tr>
          <tr>
            <td class="access__table-cell">
              <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/>
            </td>
            <td class="access__table-cell access__plans">
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a>
            </td>
          </tr>
        </tbody>
      </table>
      <footer class="access__footer">
        <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md">
          Learn about products and plans
          <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/>
        </a>
      </footer>
    </aside>

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

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

The request was a success.

- ListFreightShipmentsResponseBody — A page of freight shipments.
  - `shipments` FreightShipmentResponseBody[] — The freight shipments on this page.
    - `freight_shipment_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
    - `freight_provider_account_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
    - `freight_provider_name` string — The code of the freight provider the shipment was booked through.
    - `status` 'pending' | 'quoted' | 'booked' | 'in_transit' | 'delivered' | 'cancelled' | 'exception' — The lifecycle status of a freight shipment. `exception` is also returned when the status cannot be determined.
    - `product_transaction_id` string, nullable — The provider's identifier for the booked shipment.
    - `pickup_transaction_id` string, nullable — The provider's identifier for the pickup request. `null` when no pickup was requested.
    - `bol_number` string, nullable — The Bill of Lading number assigned to the shipment.
    - `pro_number` string, nullable — The carrier's PRO number for the shipment, or `null` until the carrier assigns one.
    - `confirmation_number` string, nullable — The carrier's pickup confirmation number. `null` when the carrier did not return one.
    - `documents` FreightShipmentDocument[], nullable — The documents stored for the shipment, each with a download URL. `null` when no documents have been stored yet.
      - `document_id` integer, nullable — Always `null`. Reserved for future use.
      - `type` 'bill_of_lading' | 'bol_pallet_label_combined' | 'certificate_of_insurance' | 'certificate_of_insurance_instructions' | 'certificate_of_origin_us' | 'certificate_of_origin_usmca' | 'certificate_of_origin_usmca_instructions' | 'international_commercial_invoice' | 'packing_list' | 'pallet_label' | 'pallet_label_4x6' | 'proof_of_delivery' | 'quote' | 'weight_and_inspection' — The type of document.
      - `url` string, nullable — The path to download the document as a PDF, relative to the API host. Resolve it against `https://api.shipstation.com` to get the full URL.
  - `total` integer — The total number of freight shipments on the account.
  - `page` integer — The page of results returned.
  - `page_size` integer — The number of freight shipments per page.
  - `pages` integer — The total number of pages available.

## Other responses

- `400` — The request contained errors.
- `500` — The request was successful.

---

[API](https://skmtc.net/shipstation/apis/shipstation-api-v2.md) · [All operations](https://skmtc.net/shipstation/apis/shipstation-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipstation/shipstation-api-v2/revisions/d3d8c21cd227/schema)