Introdução
Esta página documenta os filtros e os includes disponíveis para as rotasGET /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
includedisponí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âmetro | Tipo | Descrição |
|---|---|---|
state_uf | string | UF do estado do cliente. Exemplo: SP, MG, RJ… |
total_orders | int | Número total de pedidos realizados pelo cliente |
q | string | Busca 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
| Include | Descrição |
|---|---|
addresses | Lista de endereços associados ao cliente |
stats | Estatísticas gerais do cliente (ex: total de pedidos) |
clusters | Agrupamentos personalizados de clientes |