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

Contar e verificar favoritos

Devolve quantos produtos há na lista de desejos e se um produto específico está nela.

Duas consultas leves para a interface: o número do ícone de favoritos no cabeçalho e o estado do coração (cheio ou vazio) na página de produto ou nos cards de uma vitrine.

Contar

GET/api/v1/storefront/wishlist/countCliente

Quantidade de favoritos do cliente

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN de um cliente logado.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/wishlist/count" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Contagem
json
{"count": 3}

Campos da resposta

countinteger
Quantos produtos estão gravados na lista, inclusive os que deixaram de estar ativos.

Verificar um produto

GET/api/v1/storefront/wishlist/{productId}/checkCliente

Diz se um produto está na lista

Parâmetros de caminho

productIduuidobrigatório
Id do produto (UUID completo).

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/wishlist/5e833a7f-1a77-402c-835a-32594350d7a7/check" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Estado do produto
json
{"in_wishlist": true, "product_id": "5e833a7f-1a77-402c-835a-32594350d7a7"}

Campos da resposta

in_wishlistboolean
true se o produto está na lista do cliente.
product_iduuid
O id consultado.

Erros

StatusQuandoCorpo de exemplo
400productId não é um UUID.{"error":"invalid product_id","detail":"product_id must be a valid UUID"}
401Sem token.{"error":"missing authorization header"}
403A loja não tem o módulo, ou a chave de API não tem customer:read.{"error":"feature_not_available","feature":"wishlist","detail":"switched off for this store"}
Pinte vários corações com uma chamada

Não há rota que verifique vários produtos de uma vez. Em uma vitrine, busque a lista inteira uma vez e marque os corações no cliente em vez de chamar check por card.

Veja também

  • Listar a lista de desejos
  • Adicionar e remover
Anterior
Listar a lista de desejos
Próxima
Adicionar e remover favorito
Nesta página
  • Contar
  • Exemplo de requisição
  • Resposta
  • Verificar um produto
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também