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

Lista de desejos e dados do cliente

Como o cliente logado guarda produtos para depois e grava preferências próprias na conta.

A lista de desejos (wishlist) guarda produtos que o cliente quer comprar depois: o coração da página de produto e a tela "Meus favoritos". Esta seção também documenta o armazenamento de dados do cliente (/data/{type}), um espaço chave-valor privado por cliente, útil para preferências do app (tema, filtros salvos, últimos termos pesquisados).

Pontos-chave
  • Todas as rotas desta seção exigem um cliente logado. Sem token a resposta é 401.
  • A lista de desejos depende do módulo wishlist. Em lojas sem ele, todas as rotas respondem 403 feature_not_available.
  • Cada cliente tem a sua lista; o productId é o UUID do produto. Adicionar duas vezes é inofensivo.
  • Preços na lista são inteiros em centavos.
  • Com chave de API (em vez de login), ela precisa dos escopos customer:read (leituras) e customer:write (gravações).

Como funciona

  1. Marcar o coração

    Adicionar e remover grava ou apaga o produto da lista. Para pintar o coração ao abrir a página, use Contar e verificar.

  2. Mostrar o contador

    Contar e verificar devolve o total de favoritos para o ícone do cabeçalho.

  3. Mostrar Meus favoritos

    Listar a lista de desejos devolve os produtos com nome, imagem e preço, do mais recente para o mais antigo, paginados.

Conceitos-chave

Quem é o dono

A lista pertence ao usuário do token. Não existe parâmetro para ver a lista de outra pessoa.

Produtos que somem

A lista exibe só produtos ativos e não excluídos. Um favorito cujo produto foi desativado continua gravado, mas deixa de aparecer na lista e em total. O contador de Contar e verificar conta tudo o que está gravado, então pode ser maior que total da lista.

Dados do cliente

/data/{type} guarda um JSON qualquer sob um nome (type) escolhido por você, uma entrada por cliente e nome. Serve para pequenas preferências; não use para dados sensíveis nem grandes volumes.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/storefront/wishlistListar a lista de desejosCliente
GET/api/v1/storefront/wishlist/countContar os favoritosCliente
GET/api/v1/storefront/wishlist/{productId}/checkVerificar um produtoCliente
POST/api/v1/storefront/wishlist/{productId}Adicionar à listaCliente
DELETE/api/v1/storefront/wishlist/{productId}Remover da listaCliente
GET/api/v1/storefront/data/{type}Ler dados do clienteCliente
PUT/api/v1/storefront/data/{type}Gravar dados do clienteCliente
DELETE/api/v1/storefront/data/{type}Apagar dados do clienteCliente

Erros comuns

  • Chamar sem token. Responde 401 missing authorization header.
  • Usar o slug no lugar do UUID em /wishlist/{productId}. Responde 400 invalid product_id.
  • Esperar [] na lista vazia. items chega null; trate como vazio.
  • Comparar o contador com total. Podem diferir (veja "Produtos que somem").
  • Mandar PUT /data/{type} sem data. Responde 400 data is required.
  • Apagar um type que não existe. Responde 400 (não 404), com uma mensagem em inglês.

Próximos passos

Adicionar e remover
Marque e desmarque favoritos.
Listar favoritos
Monte a tela Meus favoritos.
Dados do cliente
Guarde preferências na conta.
Anterior
Contestações
Próxima
Listar a lista de desejos
Nesta página
  • Como funciona
  • Conceitos-chave
  • Quem é o dono
  • Produtos que somem
  • Dados do cliente
  • Endpoints
  • Erros comuns
  • Próximos passos