Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

purchase_orders

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.

get/v2/purchase_orders

Query parameters

order_numberstring

Filter by order number

status'draft' | 'open' | 'receiving' | 'received' | 'cancelled' | 'closed'

Filter by status

warehouse_idstring

Filter by warehouse ID

reference_numberstring

Filter by reference number

create_date_startstring date-time

Filter by creation date start (inclusive)

page_sizeinteger

Number of results per page

Response

The request was a success.

totalinteger

Total number of purchase orders

pageinteger

Current page number

pagesinteger

Total number of pages

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"
    }
  }
}