Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

Sale → Get Many

AI-generated

Summary

Retrieve multiple sales records from Hyros, optionally filtered and paginated, returning a list of sales matching the specified criteria.

Inputs

  • Return All — Choose whether to retrieve all sales or limit the number returned.
  • Limit — Specify the maximum number of sales to return when not returning all, between 1 and 250.
  • Filters — Set filters to narrow sales results by emails, sale IDs, lead IDs, product tags, refunded state, recurring status, date ranges (both creation and update), and page ID for pagination.

Output shape

a list of sales objects matching the filter criteria and pagination settings

When 'Return All' is true, all matching sales are returned. Otherwise, results are limited to the 'Limit' parameter. Filters accept comma-separated strings or specific enum values, and multiple filters can be combined to refine results. Pagination is supported via 'Page ID'.

Examples

Example 1: Retrieve up to 100 non-recurring, non-refunded sales tagged with 'electronics' created after January 1, 2023

Set 'Return All' to false, 'Limit' to 100, and within Filters specify 'Is Recurring Sale' as 'Non-Recurring', 'Sale Refunded State' as 'Non-Refunded', 'Product Tags' as 'electronics', and 'From Date' as '2023-01-01T00:00:00Z'.

Links

Discussion