Buscar produtos

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" }
    ]
  }'

POST

ecommerce

apps

{app_id}

products

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" }
    ]
  }'

Ao contrário de listar, este endpoint aplica filtros, pesquisa, scopes e ordenação, enviados no corpo da solicitação.

string

obrigatório

O ID da sua loja no Jelou Shop.

integer

padrão:"1"

Número da página a retornar.

integer

padrão:"15"

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

boolean

Se presente, a resposta é um arquivo XLSX com os produtos que atendem aos filtros, em vez de JSON.

object

Objeto de pesquisa por texto.

Mostrar Propriedades de pesquisa

string

obrigatório

Texto a pesquisar nos campos name e sku.

boolean

padrão:"false"

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

object[]

Lista de filtros a aplicar.

Mostrar Propriedades de cada filtro

string

obrigatório

Campo pelo qual filtrar: created_at, price, has_tax ou categories.id.

string

padrão:"="

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

string | number | boolean | array

obrigatório

Valor do filtro. Use um array com os operadores in e not in.

object[]

Lista de scopes (filtros predefinidos) a aplicar.

Mostrar Propriedades de cada scope

string

obrigatório

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é].

array

Parâmetros do scope. Para whereDate: ["2026-01-01", "2026-01-31"].

object[]

Ordenação dos resultados.

Mostrar Propriedades de cada sort

string

obrigatório

Campo pelo qual ordenar. Disponível: created_at.

string

padrão:"asc"

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

object[]

Lista de relações a expandir na resposta.

Mostrar Propriedades de cada include

string

obrigatório

Nome da relação. Disponíveis: media, categories, attributes, prices, variations, variations.media, variations.productAttributes, attributeTypes, featureValues.

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" }
    ]
  }'

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

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

⌘I

Primeiros Passos

Desenvolvedor

Jelou CLI

Mensagens Outbound

Gestão

Marketplace

Canais

Configuração

Faturamento