---
title: "Search for resources"
method: GET
path: "/search"
tags: ["Search"]
---

# Search for resources

`GET /search`

This endpoint allows integrators to search all of the most commonly used resources, **sales**, **products** and **customers**. Each type allowing search by a number of different parameters.
### Supported resource types and attributes
- **Sales**
  - date_from
  - date_to
  - time_from
  - time_to
  - timezone
  - status
  - state
  - attributes
  - invoice_number
  - customer_id
  - user_id
  - outlet_id
  - register_id
  - payment_type_id
  - product_id
  - sale_total
  - customer_name
- **Products**
  - sku **_(values must be lowercased)_**
  - supplier_id
  - brand_id
  - tag_id
  - product_type_id
  - variant_parent_id
- **Customers**
  - customer_code
  - first_name
  - last_name
  - company_name
  - mobile
  - phone
  - email
### Sorting and pagination
Unlike other endpoints, search results from this endpoint can be sorted by any of the attributes above. Because of that, the default [pagination](https://x-series-api.lightspeedhq.com/docs/pagination#api-20) mechanism is not appropriate for this endpoint. Instead, this endpoint uses `offset` and `page_size` attributes to handle search results spanning multiple pages.

🔒 Requires one of the following:
- `sales:read` scope when searching for sales
- `products:read` scope when searching for products
- `customers:read` scope when searching for customers

## Query parameters

- `type` 'sales' | 'products' | 'customers', required
- `order_by` string
- `order_direction` 'asc' | 'desc'
- `page_size` integer
- `offset` integer
- `_id` string, UUID
- `-_id` string, UUID
- `deleted` boolean
- `status` string
- `state` string
- `attributes` string[]
- `invoice_number` string
- `customer_id` string, UUID
- `user_id` string, UUID
- `outlet_id` string, UUID
- `date_from` string
- `date_to` string
- `time_from` string
- `time_to` string
- `timezone` string
- `register_id` string, UUID
- `payment_type_id` string, UUID
- `product_id` string, UUID
- `sale_total` number, float
- `customer_name` string
- `sku` string
- `-sku` string
- `supplier_id` string, UUID
- `-supplier_id` string, UUID
- `brand_id` string, UUID
- `-brand_id` string, UUID
- `tag_id` string, UUID
- `-tag_id` string, UUID
- `product_type_id` string, UUID
- `-product_type_id` string, UUID
- `variant_parent_id` string, UUID
- `-variant_parent_id` string, UUID
- `customer_code` string
- `email` string
- `first_name` string
- `last_name` string
- `company_name` string
- `mobile` string
- `phone` string

## Response `200`

- SearchResponse
  - `data` object[] — A collection of objects of one of the supported types: sales, products or customers.

---

[API](https://skmtc.net/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.net/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)