Buscar filiais - Jelou AI Docs

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 }
    ],
    "includes": [
      { "relation": "products" }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

POST

ecommerce

apps

{app_id}

branches

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 }
    ],
    "includes": [
      { "relation": "products" }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

app_id

string

obrigatório

O ID da sua loja no Jelou Shop.

page

integer

padrão:"1"

Número da página a retornar.

limit

integer

padrão:"15"

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

object

Objeto de pesquisa por texto.

Mostrar Propriedades de pesquisa

value

string

obrigatório

Texto a pesquisar nos campos name e code.

case_sensitive

boolean

padrão:"false"

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

filters

object[]

Lista de filtros a aplicar.

Mostrar Propriedades de cada filtro

field

string

obrigatório

Campo pelo qual filtrar: status ou code.

operator

string

padrão:"="

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

value

string | boolean

obrigatório

Valor do filtro.

includes

object[]

Lista de relações a expandir na resposta.

Mostrar Propriedades de cada include

relation

string

obrigatório

Nome da relação a incluir. Disponível: products.

sort

object[]

Ordenação dos resultados.

Mostrar Propriedades de cada sort

field

string

obrigatório

Campo pelo qual ordenar: created_at, updated_at, name ou code.

direction

string

padrão:"asc"

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

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 }
    ],
    "includes": [
      { "relation": "products" }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

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.

Campos pesquisáveis: name, code Campos filtráveis: status, code Campos ordenáveis: created_at, updated_at, name, code Relações disponíveis: products

Excluir filial

Produtos

⌘I