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

Adicionar e remover favorito

Inclui ou retira um produto da lista de desejos do cliente logado.

O gesto de tocar no coração. Adicionar é idempotente: repetir a chamada não duplica nem dá erro. Remover um produto que não está na lista também responde sucesso.

Adicionar

POST/api/v1/storefront/wishlist/{productId}Cliente

Adiciona um produto à lista de desejos

Sem corpo. Com chave de API, ela precisa do escopo customer:write.

Parâmetros de caminho

productIduuidobrigatório
Id do produto (UUID completo).

Exemplo de requisição

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

Resposta

200Adicionado
json
{"message": "added to wishlist"}

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:write.{"error":"feature_not_available","feature":"wishlist","detail":"switched off for this store"}
404O produto não existe.{"error":"product not found"}

Remover

DELETE/api/v1/storefront/wishlist/{productId}Cliente

Remove um produto da lista de desejos

Parâmetros de caminho

productIduuidobrigatório
Id do produto (UUID completo).

Exemplo de requisição

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

Resposta

200Removido
json
{"message": "removed from wishlist"}

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:write.{"error":"feature_not_available","feature":"wishlist","detail":"switched off for this store"}

As mensagens message são devolvidas em inglês.

Também existem rotas com corpo JSON

A loja expõe ainda GET e POST /api/v1/storefront/wishlist/items, com o id no corpo ({"product_id":"..."}), no formato da plataforma antiga. Para integrações novas, use as rotas desta página.

Veja também

  • Contar e verificar
  • Listar a lista de desejos
Anterior
Contar e verificar favoritos
Próxima
Dados do cliente
Nesta página
  • Adicionar
  • Exemplo de requisição
  • Resposta
  • Erros
  • Remover
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também