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

Lista de desejos

O que é a lista de desejos, o formato dos ids e preços e o mapa das três operações /wishlists.

A lista de desejos guarda os produtos que um cliente marcou para comprar depois. A vitrine mostra a lista para o próprio cliente; estas rotas deixam um sistema externo (app, CRM, ferramenta de e-mail marketing) ler a lista, adicionar um produto ou remover outro, com o contrato da API 1.0.

Pontos-chave
  • Toda chamada precisa de credencial: HTTP Basic e-mail:chave_de_api ou Authorization: Bearer <JWT>.
  • O cliente é sempre informado por user_id (UUID). A rota não deduz o cliente da credencial.
  • O product_id também é um UUID, e só produtos ativos entram na lista.
  • Preços saem como texto decimal ("49.90"), em reais.
  • Adicionar duas vezes o mesmo produto não duplica: a segunda chamada responde 201 e nada muda.

Como funciona

Abas

A API 1.0 original organizava a lista em abas. Aqui existe uma única aba, chamada default (nome Wishlist). Os valores de scope get_tabs e get_wishlist continuam aceitos para que clientes antigos funcionem sem mudanças.

Fluxo típico

  1. Ler a lista

    Listar a lista de desejos com o user_id do cliente.

  2. Adicionar um produto

    Adicionar produto com user_id e product_id.

  3. Remover

    Remover produto quando o cliente desistir do item.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1.0/wishlistsListar a lista de desejosCredencial válida
POST/api/v1.0/wishlistsAdicionar produtoCredencial válida
DELETE/api/v1.0/wishlistsRemover produtoCredencial válida

Erros comuns

  • Esquecer o user_id. Responde 400 user_id is required.
  • Mandar um id que não é UUID. Um user_id fora do formato UUID volta como 500.
  • Mandar o product_id no corpo do DELETE. O DELETE lê user_id e product_id da query string.
  • Remover um item que não está na lista. Responde 500 com item not found in wishlist, não 404.
  • Esperar mais de 250 itens por página. Valores acima de 250 voltam ao padrão de 10.

Próximos passos

Listar a lista de desejos
Os três formatos de leitura.
Adicionar produto
Inclua um produto na lista de um cliente.
Anterior
Rastreio por token de app
Próxima
Listar lista de desejos
Nesta página
  • Como funciona
  • Abas
  • Fluxo típico
  • Endpoints
  • Erros comuns
  • Próximos passos