> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Search products

> Filter, search and sort products, and optionally export them to XLSX.

Unlike [list](https://docs.jelou.ai/en/api/shop/products/list.md), this endpoint does apply filters, search, scopes and sorting, sent in the request body.

**app\_id** `string` *required*

Your store ID in Jelou Shop.

**page** `integer` (default: 1)

Page number to return.

**limit** `integer` (default: 15)

Number of results per page (max. 200).

**download** `boolean`

If present, the response is an **XLSX** file with the products matching the filters, instead of JSON.

**search** `object`

Text search object.

**Search properties**

**value** `string` *required*

Text to search in the `name` and `sku` fields.

**case\_sensitive** `boolean` (default: false)

Whether the search is case-sensitive.

**filters** `object[]`

List of filters to apply.

**Properties of each filter**

**field** `string` *required*

Field to filter by: `created_at`, `price`, `has_tax` or `categories.id`.

**operator** `string` (default: =)

Comparison operator. Supported values: `=`, `!=`, `<`, `<=`, `>`, `>=`, `like`, `not like`, `in`, `not in`.

**value** `string | number | boolean | array` *required*

Filter value. Use an array with the `in` and `not in` operators.

**scopes** `object[]`

List of scopes (predefined filters) to apply.

**Properties of each scope**

**name** `string` *required*

Scope name. Available:

* `withDiscount` — only products with a discount.
* `withoutDiscount` — only products without a discount.
* `whereDate` — products created between two dates. Requires `parameters: [from, to]`.

**parameters** `array`

Scope parameters. For `whereDate`: `["2026-01-01", "2026-01-31"]`.

**sort** `object[]`

Result ordering.

**Properties of each sort**

**field** `string` *required*

Field to sort by. Available: `created_at`.

**direction** `string` (default: asc)

Sort direction: `asc` or `desc`.

**includes** `object[]`

List of relations to expand in the response.

**Properties of each include**

**relation** `string` *required*

Relation name. Available: `media`, `categories`, `attributes`, `prices`, `variations`, `variations.media`, `variations.productAttributes`, `attributeTypes`, `featureValues`.

```bash cURL theme={null}
curl -X POST "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/products/search?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": {
      "value": "t-shirt",
      "case_sensitive": false
    },
    "filters": [
      { "field": "price", "operator": ">=", "value": 10 },
      { "field": "has_tax", "operator": "=", "value": true }
    ],
    "scopes": [
      { "name": "withDiscount" }
    ],
    "sort": [
      { "field": "created_at", "direction": "desc" }
    ],
    "includes": [
      { "relation": "variations" }
    ]
  }'
```

> [!TIP]
>
> **Searchable fields:** `name`, `sku`
> **Filterable fields:** `created_at`, `price`, `has_tax`, `categories.id`
> **Sortable fields:** `created_at`
> **Scopes:** `withDiscount`, `withoutDiscount`, `whereDate`
> **Available relations:** `media`, `categories`, `attributes`, `prices`, `variations`, `variations.media`, `variations.productAttributes`, `attributeTypes`, `featureValues`

> [!NOTE]
>
> To export the results to XLSX add `?download` to the URL. The response will be the file instead of JSON.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.