List orders
Changed onRetrieve a paginated list of your orders across every source (Shopify, BigCommerce, Weebly, Wix, and orders reported via this API), most recently created first.
Orders imported before Privy began denormalizing order timestamps may be excluded when a date filter is applied.
Rows carry the full order shape, so no per-order follow-up is needed, and the only filters are the placed-date ones — none by contact, email, or status.
Required scope: orders_read
Request
- Base URLhttps://api.privy.com/v1
- AuthHTTP bearer
Query parameters
Page number (starts at 1).
Number of results per page. Values outside 10–100 are clamped to the nearest bound.
Only orders placed strictly after this ISO 8601 datetime (or date). Zone-less datetimes are interpreted as UTC; bare dates as midnight US Eastern time.
Only orders placed strictly before this ISO 8601 datetime (or date). Zone-less datetimes are interpreted as UTC; bare dates as midnight US Eastern time.
Headers
Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.
Response
A paginated list of orders.
Example response
{
"data": [
{
"order_id": 1001,
"source": "api",
"email": "buyer@example.com",
"phone": "+12025550123",
"total_amount": "95.00",
"currency_code": "USD",
"placed_at": "2026-06-01T12:00:00Z",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"shipment_status": "in_transit",
"subtotal": 90,
"discounts": [
{
"code": "SAVE10",
"amount": 10
}
],
"tax_lines": [
{
"title": "VAT",
"amount": 5
}
],
"total_items": 2,
"line_items": [
{
"sku": "SKU-1",
"title": "Sample Product",
"quantity": 2
}
],
"billing_address": {
"first_name": "Jane",
"last_name": "Shopper",
"name": "Jane Shopper",
"address1": "123 Main St",
"address2": "Apt 101",
"city": "Boston",
"state_code": "MA",
"country_code": "US",
"postal_code": "02118"
},
"shipping_address": {
"first_name": "Jane",
"last_name": "Shopper",
"name": "Jane Shopper",
"address1": "123 Main St",
"address2": "Apt 101",
"city": "Boston",
"state_code": "MA",
"country_code": "US",
"postal_code": "02118"
},
"accepts_email_marketing": true,
"accepts_sms_marketing": true,
"integration": {
"store_name": "My Store",
"store_url": "https://mystore.example.com"
},
"created_at": "2026-06-01T12:00:05Z",
"updated_at": "2026-06-01T12:00:05Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 142,
"total_pages": 6
}
}Changes
- warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status
- warning
- info
endpoint added
- info