Orders
List sale orders
List the sale orders for the authenticated organization. Results are scoped to the API key's organization — you cannot access another organization's orders.
Rate limit: 120 requests burst, 60 requests/minute sustained.
get/orders/get-sale-orders/v1
Request
- Base URLhttps://api.collectpure.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
status'awaiting_payment' | 'payment_processing' | 'fufillment_in_progress' | 'payment_failed' | 'order_shipped' | 'order_complete' | 'order_cancelled' | 'partially_fufilled'
Filter by order status
limitinteger
Maximum number of orders to return (default 20, max 100)
offsetinteger
Number of orders to skip (for pagination)
Response
Default Response
Changes
No recorded changes to this operation across all 1 revision of this API.