POpolar
orders
public

Export Orders

Changed on

Export orders as a CSV file.

Scopes: orders:read

get/v1/orders/export

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/orders/export
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: orders:read)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

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

The product ID.

OR
string[]
'draft' | 'pending' | 'paid' | 'refunded' | 'partially_refunded' | 'void'
OR
OrderStatus[]
created_afterstring date-time nullable

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.

timezonestring

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[]

Response

Successful Response

Changes

  • 964f974aceffRevision changes
    • info

      added the new optional query request parameter columns

    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter timezone