Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

purchase_orders

Get purchase order details

<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 detailed information about a specific purchase order including all products.

get/v2/purchase_orders/{purchase_order_id}

Response

Purchase order details retrieved successfully

purchase_order_idstring
order_numberstring
supplier_idstring
status'draft' | 'open' | 'receiving' | 'received' | 'cancelled' | 'closed'
order_datestring date-time
expected_delivery_datestring date-time
create_datestring date-time
modify_datestring date-time
payment_terms'none' | 'cash_on_delivery' | 'payment_on_receipt' | 'payment_in_advance' | 'net_7' | 'net_15' | 'net_30' | 'net_45' | 'net_60'
payment_status'none' | 'unpaid' | 'partially_paid' | 'paid' | 'refunded' | 'credit_issued' | 'other'
currency_codestring
shipping_carrierstring
tracking_numberstring
reference_numberstring
warehouse_idstring
note_to_supplierstring

Example response

{
  "purchase_order_id": "se-234",
  "order_number": "02162026-02",
  "supplier_id": "se-567",
  "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",
  "payment_terms": "net_30",
  "payment_status": "unpaid",
  "currency_code": "USD",
  "shipping_carrier": "UPS",
  "tracking_number": "1Z12345E1234567890",
  "reference_number": "REF-12345",
  "warehouse_id": "se-123456",
  "note_to_supplier": "Please expedite delivery",
  "products": [
    {
      "sku": "WIDGET-001",
      "supplier_sku": "SUPP-WIDGET-001",
      "quantity": 100,
      "cost": 9.99
    }
  ]
}