Search sales
lightspeedxseries_search_salesFind sales by date range (UTC), state, outlet, register, user, customer, payment type, product or invoice number. Uses offset paging: pass next_offset to continue (null = last page). Replies can be large: for totals over a period use sales_summary instead of paging through this. GET /search?type=sales.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | Sale state. On-account and layby sales are state closed (they differ by attributes). | |
| offset | No | Offset for the next page: pass next_offset from the previous call (default 0). | |
| date_to | No | Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z). | |
| user_id | No | Only sales by this staff user. | |
| date_from | No | Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone. | |
| outlet_id | No | Only sales at this outlet. | |
| page_size | No | Records per page (max 1000). | |
| product_id | No | Only sales containing this product. | |
| customer_id | No | Only sales to this customer. | |
| register_id | No | Only sales on this register. | |
| invoice_number | No | ||
| payment_type_id | No | Only sales with this payment type (the payment type's config_id, shown as payments[].type.config_id in a sale). |