Tool to retrieve a paginated list of orders. Use when you need to browse orders with support for filtering by status, customer, dates, and other attributes.
sortstringSort results by attributes. Prefix with '-' for descending order (e.g., '-created_at').
fieldsarraySpecify which fields to include instead of defaults. Example: ['id', 'number', 'status']
includestringSideload related resources (comma-separated). Supported: customer, coupon, start_location.
page_sizestringNumber of items per page for pagination.
page_numberstringPage number for pagination.
filter_numberintegerFilter orders by order number.
filter_statusstringFilter orders by order status (e.g., reserved, confirmed).
filter_archivedbooleanFilter orders by archived status.
filter_stops_atstringFilter orders by rental end date. Use ISO 8601 format or comparison operators.
filter_starts_atstringFilter orders by rental start date. Use ISO 8601 format or comparison operators.
filter_created_atstringFilter orders by creation date. Use ISO 8601 format or comparison operators.
filter_updated_atstringFilter orders by last update date. Use ISO 8601 format or comparison operators.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.