AnnyInstall

Summary

Retrieve multiple orders with optional filtering, sorting, pagination, and inclusion of related entities from the Anny booking platform.

Inputs

• Authentication (required) — Choose the authentication method: OAuth2 or Access Token.
• Simplify — Return a simplified version of the response data instead of the raw API data (default true).
• Page Size — Number of results per page, from 1 to 30, default is 30.
• Page Number — The page number to retrieve, minimum 1, default is 1.
• Include — Comma-separated related entities to include with each order, e.g., "customer,items". Defaults include related customers, customer addresses, bookings' resources and services, and invoice items.
• Search — Text to search orders by various fields.
• Custom Filters — Add custom filter key-value pairs to refine the results, e.g., status or customer_id filters.
• Sort — Sort results by the created_at field either oldest first or newest first; default is oldest first.

Output shape

A list of order objects each potentially including related entities as requested.

The response respects pagination with Page Size and Page Number. The 'Simplify' parameter controls whether the data is raw or simplified for easier use. Custom filters apply API-level filtering with keys prefixed by 'filter[]'.

Examples

Example 1: Fetch the first 20 orders including related customer and items, simplified

Page Size=20, Page Number=1, Include="customer,items", Simplify=true

Example 2: Search orders with status active, sorted by newest first

Custom Filters with filter key 'status' and value 'active', Sort='-created_at'