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

# Buscar produtos

> Filtre, pesquise e ordene produtos e, opcionalmente, exporte-os para XLSX.

Ao contrário de [listar](/pt/guias/integracoes/e-commerce/api-productos/listar), este endpoint aplica filtros, pesquisa, scopes e ordenação, enviados no corpo da solicitação.

<ParamField path="app_id" type="string" required>
  O ID da sua loja no Jelou Shop.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Número da página a retornar.
</ParamField>

<ParamField query="limit" type="integer" default="15">
  Quantidade de resultados por página (máx. 200).
</ParamField>

<ParamField query="download" type="boolean">
  Se presente, a resposta é um arquivo **XLSX** com os produtos que atendem aos filtros, em vez de JSON.
</ParamField>

<ParamField body="search" type="object">
  Objeto de pesquisa por texto.

  <Expandable title="Propriedades de pesquisa">
    <ParamField body="value" type="string" required>
      Texto a pesquisar nos campos `name` e `sku`.
    </ParamField>

    <ParamField body="case_sensitive" type="boolean" default="false">
      Define se a pesquisa diferencia maiúsculas de minúsculas.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="filters" type="object[]">
  Lista de filtros a aplicar.

  <Expandable title="Propriedades de cada filtro">
    <ParamField body="field" type="string" required>
      Campo pelo qual filtrar: `created_at`, `price`, `has_tax` ou `categories.id`.
    </ParamField>

    <ParamField body="operator" type="string" default="=">
      Operador de comparação. Valores suportados: `=`, `!=`, `<`, `<=`, `>`, `>=`, `like`, `not like`, `in`, `not in`.
    </ParamField>

    <ParamField body="value" type="string | number | boolean | array" required>
      Valor do filtro. Use um array com os operadores `in` e `not in`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="scopes" type="object[]">
  Lista de scopes (filtros predefinidos) a aplicar.

  <Expandable title="Propriedades de cada scope">
    <ParamField body="name" type="string" required>
      Nome do scope. Disponíveis:

      * `withDiscount` — apenas produtos com desconto.
      * `withoutDiscount` — apenas produtos sem desconto.
      * `whereDate` — produtos criados entre duas datas. Requer `parameters: [de, até]`.
    </ParamField>

    <ParamField body="parameters" type="array">
      Parâmetros do scope. Para `whereDate`: `["2026-01-01", "2026-01-31"]`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="sort" type="object[]">
  Ordenação dos resultados.

  <Expandable title="Propriedades de cada sort">
    <ParamField body="field" type="string" required>
      Campo pelo qual ordenar. Disponível: `created_at`.
    </ParamField>

    <ParamField body="direction" type="string" default="asc">
      Direção da ordenação: `asc` ou `desc`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="includes" type="object[]">
  Lista de relações a expandir na resposta.

  <Expandable title="Propriedades de cada include">
    <ParamField body="relation" type="string" required>
      Nome da relação. Disponíveis: `media`, `categories`, `attributes`, `prices`, `variations`, `variations.media`, `variations.productAttributes`, `attributeTypes`, `featureValues`.
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample>
  ```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": "camiseta",
        "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" }
      ]
    }'
  ```
</RequestExample>

<Tip>
  **Campos pesquisáveis:** `name`, `sku`
  **Campos filtráveis:** `created_at`, `price`, `has_tax`, `categories.id`
  **Campos ordenáveis:** `created_at`
  **Scopes:** `withDiscount`, `withoutDiscount`, `whereDate`
  **Relações disponíveis:** `media`, `categories`, `attributes`, `prices`, `variations`, `variations.media`, `variations.productAttributes`, `attributeTypes`, `featureValues`
</Tip>

<Note>
  Para exportar os resultados para XLSX, adicione `?download` à URL. A resposta será o arquivo em vez de JSON.
</Note>