> ## 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.

# Pesquisar cupons

> Busque cupons por código ou nome, e filtre por estado, tipo ou filial.

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

O ID da sua loja no Jelou Shop.

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

Número da página a retornar.

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

Quantidade de resultados por página (máx. 100).

**state** `string`

Filtra pelo estado derivado: `active`, `scheduled`, `expired`, `depleted` ou `inactive`.

**search** `object`

Objeto de busca por texto.

**Propriedades de busca**

**value** `string` *required*

Texto a buscar nos campos `code` e `name`.

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

Define se a busca diferencia maiúsculas de minúsculas.

**filters** `object[]`

Lista de filtros a aplicar.

**Propriedades de cada filtro**

**field** `string` *required*

Campo pelo qual filtrar: `status`, `discount_type`, `applies_to_all_branches` ou `branches.id`.

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

Operador de comparação. Valores suportados: `=`, `!=`, `<`, `<=`, `>`, `>=`, `like`, `not like`, `in`, `not in`.

**value** `string | boolean` *required*

Valor do filtro.

**sort** `object[]`

Ordenação dos resultados.

**Propriedades de cada sort**

**field** `string` *required*

Campo pelo qual ordenar: `created_at`, `valid_from`, `valid_until`, `code` ou `status`.

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

Direção da ordenação: `asc` ou `desc`.

```bash cURL theme={null}
curl -X POST "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/coupons/search?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": {
      "value": "black",
      "case_sensitive": false
    },
    "filters": [
      { "field": "discount_type", "operator": "=", "value": "percentage" },
      { "field": "status", "operator": "=", "value": true }
    ],
    "sort": [
      { "field": "valid_until", "direction": "asc" }
    ]
  }'
```

```json 200 Success theme={null}
{
  "data": [
    {
      "id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "code": "BLACKFRIDAY25",
      "name": "Black Friday 25%",
      "discount_type": "percentage",
      "discount_value": "25.000000",
      "status": true,
      "valid_from": "2026-11-25T00:00:00.000000Z",
      "valid_until": "2026-11-30T23:59:59.000000Z",
      "max_uses": 100,
      "once_per_client": true,
      "applies_to_all_branches": true,
      "uses_count": 0,
      "state": "scheduled",
      "created_at": "2026-07-02T15:30:00.000000Z",
      "updated_at": "2026-07-02T15:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 1
  }
}
```

> [!TIP]
>
> **Campos buscáveis:** `code`, `name`
> **Campos filtráveis:** `status`, `discount_type`, `applies_to_all_branches`, `branches.id`
> **Campos ordenáveis:** `created_at`, `valid_from`, `valid_until`, `code`, `status`


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