Skip to main content
GET
List purchases

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort
string

Sort order, use: created_at for descending order use '-' e.g. &sort=-created_at

page[number]
integer
page[size]
integer

Number of documents

fields[purchases]
string

Partial attributes as specified, e.g. fields[purchases]=amount_in_cents

filter[active]
boolean

Filter by active purchases (not deactivated), for example ?filter[active]=true

filter[deactivated]
boolean

Filter by deactivated purchases, for example ?filter[deactivated]=true

filter[referrer]
string

Filter by referrer, for example ?filter[referrer_cont]=•••••

filter[coupon_code_eq]
string

Filter by coupon code, for example ?filter[coupon_code_eq]=•••••

filter[site_id]
string

Filter by site_id, for example ?filter[site_id]=111

filter[customer_id]
string

Filter by customer_id, for example ?filter[customer_id]=456789

Response

Success, list of purchases which the current user may access

data
object[]