List 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
The page of results to return. Values below 1 are treated as 1.
The number of freight shipments to return per page. Values above 500 are capped at 500.
Response
The request was a success.
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",
"documents": [
{
"type": "bill_of_lading",
"url": "/v2/downloads/10/a1b2c3d4e5f6/bill_of_lading.pdf"
}
]
}
],
"total": 137,
"page": 1,
"page_size": 25,
"pages": 6
}Changes
Changed in 2 of the 6 revisions of this API.42
- ●
removed the optional property
shipments/items/documents/items/document_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
shipments/items/freight_provider_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
shipments/items/pickup_transaction_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
shipments/items/product_transaction_idfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
shipments/items/freight_provider_codeto the response with the200statusresponse-optional-property-added
- ●
- ○
endpoint added
endpoint-added
- ○