Added
2026-05 New Sales Search Filters and Sorting
6 days ago by ReadMe GitHub Action
The GET /api/2026-01/search endpoint now supports additional filter parameters and sort fields when searching for sales (type=sales).
New Filter Parameters
| Parameter | Type | Description |
|---|---|---|
register_id | UUID | Filter by register. |
payment_type_id | UUID | Filter by payment type used in the sale. |
product_id | UUID | Filter by product included in the sale. |
sale_total | number | Filter by exact sale total amount. |
customer_name | string | Filter by customer name. Supports prefix matching. |
time_from | string | Lower time-of-day limit (local time) for the sale. Format: H:MM or HH:MM (e.g. 09:00). Use with timezone. When provided without time_to, defaults time_to to 24:00. |
time_to | string | Upper time-of-day limit (local time) for the sale. Format: H:MM or HH:MM (e.g. 17:00). Use with timezone. When provided without time_from, defaults time_from to 00:00. |
timezone | string | IANA timezone identifier used to interpret time_from and time_to (e.g. America/Toronto). Defaults to UTC. |
register_id, payment_type_id, and product_id can be used multiple times to search for objects with different values.
New Sort Fields
The following fields can now be passed to the order_by parameter when searching for sales:
| Fields | Type | Description |
|---|---|---|
customer_name | string | Sort by the name of the customer on the sale. |
user_name | string | Sort by the name of the user who processed the sale. |
payment_type_name | string | Sort by the name of the payment type used. |
sale_total | number | Sort by the total amount of the sale. |
🔒 Requires: sales:read scope
