​
Introdução

Esta página documenta os filtros e os includes disponíveis para as rotas GET /customers.

Esses parâmetros permitem que você realize buscas refinadas por nome, e-mail, UF e número total de pedidos. Também é possível enriquecer a resposta da API com dados relacionados como endereços, estatísticas e agrupamentos personalizados de clientes.

Você encontrará aqui:

  • Descrição dos filtros suportados (UF, total de pedidos, busca textual).
  • Parâmetros include disponíveis para expandir a resposta com entidades relacionadas (endereços, estatísticas, clusters).
  • Exemplo prático de uso com filtros combinados.

Esta página é uma introdução à documentação de consulta no endpoint de clientes, e Visualização de um cliente com foco na flexibilidade e personalização das consultas.

​
Filtros disponíveis para a consulta geral de clientes (/customers)

ParâmetroTipoDescrição
state_ufstringUF do estado do cliente. Exemplo: SP, MG, RJ…
total_ordersintNúmero total de pedidos realizados pelo cliente
qstringBusca textual por nome ou e-mail do cliente

​
Includes disponíveis nas rotas de clientes (/customers e /customers/{id})

Use o parâmetro include para retornar dados relacionados no mesmo payload da resposta.

Você pode incluir múltiplos valores separados por vírgula, por exemplo:
?include=addresses,stats

IncludeDescrição
addressesLista de endereços associados ao cliente
statsEstatísticas gerais do cliente (ex: total de pedidos)
clustersAgrupamentos personalizados de clientes

​
Exemplo completo de requisição com filtros e includes

GET {alias}/customers?state_uf=SP&total_orders=5&include=addresses,stats