VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Carrinhos

Listar carrinhos

Retorna até 10 carrinhos de compras de clientes por requisição, com totais, dados do dono e informações de paginação.

Este endpoint retorna todos os carrinhos de compras dos clientes da sua loja Venddor. Cada requisição devolve os detalhes de até 10 carrinhos; use os parâmetros de paginação para obter mais resultados, se precisar. Chame-o para encontrar carrinhos abandonados, estudar o comportamento de compra ou alimentar uma campanha de recuperação.

GET/api/cartsAdmin

Listar todos os carrinhos de compras

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/"

Resposta

200Carrinhos retornados
json
{
  "carts": [
    {
      "cart_id": "123456",
      "user_id": "42",
      "ip_address": "192.168.1.100",
      "company_id": "1",
      "items_count": 3,
      "total": "149.97",
      "subtotal": "139.97",
      "shipping_cost": "10.00",
      "timestamp": "1712345678",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.com",
      "status": "O"
    },
    {
      "cart_id": "123457",
      "user_id": "0",
      "ip_address": "192.168.1.101",
      "company_id": "1",
      "items_count": 1,
      "total": "29.99",
      "subtotal": "29.99",
      "shipping_cost": "0.00",
      "timestamp": "1712345879",
      "firstname": "",
      "lastname": "",
      "email": "",
      "status": "O"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Campos da resposta

cartsarray
Array de objetos de carrinho.
cart_idstring
Identificador único do carrinho.
user_idstring
Id do usuário dono do carrinho. 0 para carrinhos de visitantes.
ip_addressstring
Endereço IP do cliente.
company_idstring
Id da empresa (vendedor) associada ao carrinho.
items_countinteger
Quantidade de itens no carrinho.
totalstring
Valor total do carrinho, incluindo o frete.
subtotalstring
Valor do carrinho antes do frete e dos impostos.
shipping_coststring
Custo do frete.
timestampstring
Timestamp Unix de quando o carrinho foi criado/atualizado.
firstnamestring
Nome do cliente (se informado).
lastnamestring
Sobrenome do cliente (se informado).
emailstring
E-mail do cliente (se informado).
statusstring
OCA

Status do carrinho. O é aberto (ativo), C é concluído (convertido em pedido) e A é abandonado.

Parâmetros de paginação na resposta

A API devolve informações básicas de paginação no objeto params.

CampoTipoDescrição
pageintegerNúmero da página atual
items_per_pageintegerQuantidade de itens exibidos por página
total_itemsintegerTotal de carrinhos que atendem aos critérios do filtro
Dica

Para ver o conteúdo de um carrinho específico, use o endpoint GET /api/carts/{cart_id}, descrito em Obter um carrinho.

Casos de uso comuns

  • Monitorar carrinhos abandonados
  • Analisar padrões e comportamento de compra
  • Implementar campanhas próprias de recuperação de carrinhos
  • Integrar com sistemas de CRM externos

Veja também

  • Paginação, ordenação e filtros
  • Obter um carrinho
Anterior
Carrinhos
Próxima
Paginação, ordenação e filtros
Nesta página
  • Exemplo de requisição
  • Resposta
  • Parâmetros de paginação na resposta
  • Casos de uso comuns
  • Veja também