Carrinhos
A API de carrinhos dá acesso aos carrinhos de compras dos seus clientes, para analisar o comportamento e recuperar carrinhos abandonados.
A API de carrinhos permite acessar e gerenciar os carrinhos de compras dos seus clientes. Você pode consultar os dados dos carrinhos, analisar o comportamento dos clientes e acompanhar carrinhos abandonados para melhorar a sua taxa de conversão. A referência mostra a URL base como https://www.venddor.com.br/api/carts; nos exemplos ela aparece como $BASE_URL/api/carts, com as credenciais HTTP Basic de um administrador ($EMAIL:$API_KEY).
Como funciona
Um registro de carrinho aparece em uma de duas situações. No painel de administração da Venddor você vê esses carrinhos em Marketing > Carrinhos abandonados/ativos (Abandoned/Live carts).
- O cliente adiciona produtosO sistema cria um registro de carrinho para o cliente.
- O carrinho fica ativoO cliente continua navegando pela loja. É um carrinho ativo.
- O cliente saiSe o cliente sai da loja sem comprar os produtos e sem removê-los do carrinho, o carrinho fica abandonado.
Carrinhos ativos e carrinhos abandonados
- Carrinhos ativos: o cliente adicionou produtos ao carrinho e continua navegando pela loja.
- Carrinhos abandonados: o cliente adicionou produtos ao carrinho, mas saiu da loja sem comprar esses produtos nem removê-los do carrinho.
Conceitos principais
O que a listagem aceita
O GET /api/carts retorna uma lista de todos os carrinhos do sistema. Todos os parâmetros de consulta são opcionais.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página dos resultados paginados. Padrão: 1 |
items_per_page | integer | Não | Quantidade de itens por página. Padrão: 10, máximo: 100 |
sort_by | string | Não | Campo de ordenação. Opções: date, total. Padrão: date |
sort_order | string | Não | Sentido da ordenação. Opções: asc, desc. Padrão: desc |
abandoned_only | boolean | Não | Se true, retorna só os carrinhos abandonados. Padrão: false |
Um exemplo de requisição que retorna 25 carrinhos abandonados por página:
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts?abandoned_only=true&items_per_page=25"Consultar e excluir um carrinho
O GET /api/carts/{cart_id} retorna as informações detalhadas de um carrinho específico, e o DELETE /api/carts/{cart_id} o exclui. Nos dois, o parâmetro de caminho é o identificador único do carrinho (integer, obrigatório).
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/12345"
curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/12345"As páginas Obter um carrinho e Excluir um carrinho desta seção escrevem o caminho com o id do usuário (/api/carts/{user_id}).
Recuperação de carrinhos abandonados
Use a API de carrinhos para identificar carrinhos abandonados e aplicar estratégias de recuperação:
- Crie campanhas automáticas de e-mail para os clientes com carrinhos abandonados.
- Ofereça descontos personalizados com base no conteúdo do carrinho.
- Analise os pontos de abandono mais comuns no seu processo de checkout.
Análise do comportamento do cliente
Entenda os padrões de compra dos seus clientes:
- Acompanhe quais produtos são adicionados com frequência aos carrinhos, mas não são comprados.
- Identifique os horários de pico de compra a partir dos timestamps de criação dos carrinhos.
- Analise o valor médio dos carrinhos e as combinações de produtos.
Endpoints
| Método | Caminho | Finalidade | Autenticação |
|---|---|---|---|
| GET | /api/carts | Listar todos os carrinhos, veja também Paginação, ordenação e filtros | Administrador |
| GET | /api/carts/{cart_id} | Obter um carrinho específico, veja também Detalhes do carrinho | Administrador |
| DELETE | /api/carts/{cart_id} | Excluir um carrinho | Administrador |
Erros comuns
- Pedir mais de 100 itens por página. O máximo de
items_per_pageé 100. - Usar a flag
abandoned_onlypara achar carrinhos de um cliente. Use os filtros de Paginação, ordenação e filtros (email,user_id,cname). - Excluir um carrinho de que você ainda precisa para análise. A exclusão é permanente, então guarde uma cópia dos dados antes.
- Misturar as duas listas de opções de ordenação. A visão geral aceita
dateetotal, enquanto a página de filtros fala emcustomeroudate.