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

GETListar a lista de desejos

Devolve os produtos favoritos do cliente logado, do mais recente para o mais antigo.

Alimenta a tela "Meus favoritos". Cada item traz o necessário para um card de produto: nome, slug, primeira imagem e preço atual em centavos. Só entram produtos ativos e não excluídos.

GET/api/v1/storefront/wishlistCliente

Lista a lista de desejos do cliente logado

Parâmetros de consulta

pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página, de 1 a 100. Fora disso volta a 20.

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN de um cliente logado.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/wishlist?page=1&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Favoritos retornados
json
{
  "items": [
    {
      "product_id": "5e833a7f-1a77-402c-835a-32594350d7a7",
      "product_name": "LEAD-DOC Caneca Esmaltada 350ml",
      "product_slug": "lead-doc-caneca-esmaltada-350ml",
      "product_image": "https://minhaloja.io.venddor.com.br/media/caneca.jpg",
      "price": 5290,
      "created_at": "2026-10-11T21:10:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

itemsarray
Favoritos da página. Vem null (não []) quando a lista está vazia.
items[].product_iduuid
Id do produto.
items[].product_namestring
Nome do produto.
items[].product_slugstring
Slug, para montar o link da página do produto.
items[].product_imagestring
URL da primeira imagem. Ausente se o produto não tem imagem.
items[].priceinteger
Preço do produto em centavos (5290 = R$ 52,90).
items[].created_atstring
Quando foi favoritado, RFC 3339 em UTC.
totalinteger
Total de favoritos ativos, em todas as páginas.

Erros

StatusQuandoCorpo de exemplo
401Sem token.{"error":"missing authorization header"}
403A loja não tem o módulo de lista de desejos, ou a chave de API não tem customer:read.{"error":"feature_not_available","feature":"wishlist","detail":"switched off for this store"}
A página e o total

A resposta não devolve page nem per_page; guarde os valores que você enviou. Para saber se há próxima página, compare page * per_page com total.

Veja também

  • Adicionar e remover
  • Contar e verificar
Anterior
Lista de desejos e dados do cliente
Próxima
Contar e verificar favoritos
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também