Visão Geral
Filtros e includes disponíveis para consulta de carrinhos abandonados em /checkout/carts
Introdução
Esta página documenta os filtros e os includes disponíveis para a rota GET /checkout/carts, que retorna os carrinhos abandonados de clientes.
Esses parâmetros permitem buscar carrinhos por nome, e-mail, telefone, UTM, status de pagamento, data de criação e mais. Além disso, é possível expandir a resposta com dados relacionados ao cliente, pagamento, itens, endereço e promoções.
Você encontrará aqui:
- Descrição de filtros suportados (busca textual, UTM, status, data).
- Includes para enriquecer o retorno com entidades vinculadas.
- Exemplo prático de requisição com múltiplos parâmetros.
Esta página complementa a documentação de consulta de carrinhos abandonados, com foco em flexibilidade e detalhamento da resposta.
Filtros disponíveis para carrinhos abandonados (/checkout/carts)
| Parâmetro | Tipo | Descrição |
|---|---|---|
q | string | Termo de busca. A API buscará pelo nome, e-mail ou telefone do cliente |
utm_source[] | array | Lista carrinhos com base no utm_source |
utm_campaign[] | array | Lista carrinhos com base no utm_campaign |
status | string | Filtra por status do pagamento. Valor aceito: payment_refused |
date | string | Intervalo de datas. Exemplo: ?date=created_at:2017-05-21|2017-05-30 |
Includes disponíveis em carrinhos abandonados (/checkout/carts e /checkout/carts/{id})
Use o parâmetro include para expandir o retorno com dados relacionados ao carrinho.
Você pode incluir múltiplos valores separados por vírgula, por exemplo:
?include=customer,items,payment
| Include | Descrição |
|---|---|
customer | Dados do cliente associado ao carrinho |
payment | Dados do método de pagamento selecionado |
address | Endereço associado ao carrinho |
promocode | Cupom aplicado no carrinho (se houver) |
items | Lista de itens adicionados ao carrinho |
seller | Vendedor associado (em contexto de marketplace) |