Skip to main content
GET
/
orders
/
get-purchase-orders
/
v1
List purchase orders
curl --request GET \
  --url https://api.collectpure.com/orders/get-purchase-orders/v1 \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 123,
      "status": "pending_confirmation",
      "subtotal": 123,
      "salesTax": 123,
      "shipping": 123,
      "processingFee": 123,
      "total": 123,
      "currency": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "completeAt": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
status
enum<string>

Filter by order status

Available options:
pending_confirmation,
ready_for_shipment,
in_transit,
items_received,
check_in_progress,
order_complete,
order_cancelled,
check_in_complete
​
limit
integer
default:20

Maximum number of orders to return (default 20, max 100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of orders to skip (for pagination)

Required range: 0 <= x <= 9007199254740991

Response

200 - application/json

Default Response

​
data
object[]
required