REST API Documentation
/nexus/purchases
Get list of purchases
For requests using an OAuth Access Token for a particular member, only the members own purchases will be included
Parameters
| Name | Type | Description |
|---|---|---|
customers
|
string | Comma-delimited list of customer IDs - if provided, only invoices belonging to those customers are returned. Ignored for requests using an OAuth Access Token for a particular member |
active
|
int | If 1, only active purchases are returned. If 0, only inactive |
canceled
|
int | If 1, only canceled purchases are returned. If 0, only not canceled |
itemApp
|
string | If specified, only purchases with this application key are returned |
itemType
|
string | If specified, only purchases with this item type are returned |
itemId
|
int | If specified, only purchases with this item ID are returned |
parent
|
int | If specified, only purchases with which are children of the purchase with the ID specified are returned |
show
|
int | If 1, only purchases which show in the Admin CP are returned, if 0, only purchases which do not |
sortBy
|
string | What to sort by. Can be 'start' (for purchase date), 'expire' (for the epiry date) or do not specify for ID |
sortDir
|
string | Sort direction. Can be 'asc' or 'desc' - defaults to 'asc' |
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
This endpoint doesn't throw any exceptions.
Response
This endpoint doesn't return a response.