List purchase orders
<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>Retrieve a paginated list of purchase orders with optional filtering by status, warehouse, dates, and other criteria.
Query parameters
Filter by order number
Filter by status
Filter by warehouse ID
Filter by reference number
Filter by creation date start (inclusive)
Number of results per page
Response
The request was a success.
Example response
{
"purchase_orders": [
{
"purchase_order_id": "se-234",
"order_number": "02162026-02",
"supplier_id": "se-567",
"supplier_name": "Acme Widgets Inc",
"status": "open",
"order_date": "2025-01-15T00:00:00Z",
"expected_delivery_date": "2025-02-01T00:00:00Z",
"create_date": "2025-01-14T10:30:00Z",
"modify_date": "2025-01-14T10:30:00Z",
"reference_number": "REF-12345",
"warehouse_id": "se-123456"
}
],
"total": 150,
"page": 2,
"pages": 3,
"links": {
"first": {
"href": "https://api.shipstation.com/v2/purchase_orders?page_size=50"
},
"next": {
"href": "https://api.shipstation.com/v2/purchase_orders?cursor=eyJQYWdlIjoyLCJPcmRlck51bWJlciI6bnVsbCwiU3RhdHVzIjpudWxsLCJXYXJlaG91c2VJZCI6bnVsbCwiUmVmZXJlbmNlTnVtYmVyIjpudWxsLCJDcmVhdGVEYXRlU3RhcnQiOm51bGx9"
}
}
}Changes
Changed in 1 of the 6 revisions of this API.6
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●