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

> Pesquise filiais por nome ou código e filtre por status ou outros campos.

<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. 100).
</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 `code`.
    </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: `status` ou `code`.
    </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 | boolean" required>
      Valor do filtro.
    </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: `created_at`, `updated_at`, `name` ou `code`.
    </ParamField>

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

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

<Note>
  Cada filial na resposta inclui `products_count` com a quantidade de produtos **ativos** associados. Se você omitir `sort`, os resultados são ordenados por `created_at` ascendente.
</Note>

<Tip>
  **Campos pesquisáveis:** `name`, `code`
  **Campos filtráveis:** `status`, `code`
  **Campos ordenáveis:** `created_at`, `updated_at`, `name`, `code`
</Tip>