You can use the Store API call to retrieve information about online store orders and products, and set the status of an existing order.
Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum. If you are not an experienced programmer, consider using Make (formerly Integromat) to build automated workflows with Wild Apricot.
Store API functions
The Store API call supports the following functions. To view the Swagger documentation for each function, click the appropriate link below.
- Retrieve information about a particular order
- Retrieve information about a range of orders
- Set the status of an existing order
- Retrieve information about a particular product
- Retrieve information about all your products
Filtering the results
You can filter the results of the Store API call so that only those orders that match the filter criteria will be included. For example, you might want to retrieve orders with a particular order status or payment status, or between certain dates. Within your filter criteria, you can use relational operators to include a range of orders, and use logical operators to combine multiple criteria.
You can filter events using the following fields:
| Field | Description | Possible values |
|---|---|---|
| Status | The status of the store order. | Fulfilled, Unfulfilled, Cancelled |
| PaymentStatus | The status of the order invoice. | NoInvoice, Paid, PartiallyPaid, Unpaid, Free |
| From | The start date of the range | Any date using the yyyy-mm-dd format |
| To | The end date of the range | Any date using the yyyy-mm-dd format |
