List purchase orders
Changed onRetrieve a paginated list of purchase orders with optional filtering by status, warehouse, dates, and other criteria.
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/purchase_orders
- AuthAPI key in header api-key
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
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
/response's property type changed from no type toobjectfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
/response propertyallOflist for the response status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking