Sign in

v7

latestOpenAPI 3.1.02026-08-051856761.1 MB
orders
public

Export Orders

Export orders as a CSV file.

Scopes: orders:read

get/v1/orders/export

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The product ID.

OR
string[]

Filter by product ID.

'draft' | 'pending' | 'paid' | 'refunded' | 'partially_refunded' | 'void'
OR
OrderStatus[]

Filter by order status.

created_afterstring date-time nullable

Only include orders created after this date. Must include a UTC offset.

Only include orders created after this date. Must include a UTC offset.

created_beforestring date-time nullable

Only include orders created before this date. Must include a UTC offset.

Only include orders created before this date. Must include a UTC offset.

timezonestring

Time zone used to render dates in the CSV.

Time zone used to render dates in the CSV.

'email' | 'created_at' | 'product' | 'net_amount' | 'currency' | 'status' | 'invoice_number' | 'customer_name' | 'billing_name' | 'billing_country' | 'subtotal_amount' | 'discount_amount' | 'tax_amount' | 'total_amount' | 'refunded_amount' | 'billing_reason'
OR
OrderExportColumn[]

Columns to include in the CSV, in order. Defaults to email, created_at, product, net_amount, currency, status and invoice_number.

Response

Successful Response