Skip to content

Lista de Desejos (Admin)

Visão Geral

Este módulo permite que usuários administrativos consultem as listas de desejos dos clientes cadastrados na loja ❤️.

Por meio dele, é possível acompanhar os produtos salvos pelos clientes, auxiliando em análises de comportamento e estratégias comerciais.

Permissão

Todas as rotas exigem autenticação via middleware UserAuth, além da validação do escopo apropriado.

  • CUSTOMER_READ: necessário para consulta de listas de desejos

Listagem de Listas de Desejos

GET /customers/wish-list

Endpoint responsável por listar todas as listas de desejos dos clientes

Descrição

Endpoint que permite aos usuários administrativos listar todas as listas de desejos cadastradas pelos clientes da loja ❤️.

Destinado ao painel administrativo, possibilita uma visão geral das listas criadas, auxiliando no acompanhamento de preferências e comportamento de consumo.

A utilização requer as permissões adequadas de leitura, garantindo controle de acesso às informações.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação do usuário

Parâmetros de Query

Todos os parâmetros são enviados como query string no formato estruturado.

Campos de Condição Disponíveis

CampoTipoDescrição
idintegerFiltrar por ID da lista de desejo
customerIdintegerFiltrar por ID do cliente
namestringFiltrar pelo nome da lista
shareListbooleanFiltrar por listas compartilhadas

Campos de Ordenação Disponíveis

CampoDescrição
idOrdenar pelo identificador
createdAtOrdenar pela data de criação

Exemplo de Requisição

1curl --request GET \
2  --url '{{MAIN_URL}}/customers/wish-list?limit=10&offset=0' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "registers": [
3    {
4      "id": 1,
5      "customerId": 123,
6      "name": "Minha Lista",
7      "shareList": true,
8      "default": true,
9      "uriCode": "abc123xyz",
10      "createdAt": "2026-01-15 10:30:00"
11    },
12    {
13      "id": 2,
14      "customerId": 456,
15      "name": "Presentes de Natal",
16      "shareList": false,
17      "default": false,
18      "uriCode": "def456uvw",
19      "createdAt": "2026-01-10 14:20:00"
20    }
21  ],
22  "pagination": {
23    "limit": 10,
24    "offset": 0,
25    "pages": 5,
26    "registers": 48
27  }
28}

Detalhe de Lista de Desejo

GET /customers/wish-list/{customerWishListId}

Endpoint responsável por retornar o detalhe de uma lista de desejo

Descrição

Endpoint que permite aos usuários administrativos visualizar os detalhes de uma lista de desejo específica ❤️.

A consulta inclui os produtos adicionados à lista, possibilitando análise completa do conteúdo salvo pelo cliente.

Destinado ao painel administrativo, auxilia no acompanhamento de preferências e interações do cliente com a loja.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação do usuário

Parâmetros de URL

ParâmetroTipoObrigatórioDescrição
customerWishListIdintegerSimID da lista de desejo

Exemplo de Requisição

1curl --request GET \
2  --url '{{MAIN_URL}}/customers/wish-list/123' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "id": 123,
5    "customerId": 456,
6    "name": "Minha Lista de Desejos",
7    "shareList": true,
8    "default": true,
9    "uriCode": "abc123xyz",
10    "createdAt": "2026-01-15 10:30:00",
11    "products": {
12      "registers": [
13        {
14          "id": 789,
15          "type": "product",
16          "sku": "SKU001",
17          "name": "Produto Exemplo",
18          "priority": 1,
19          "basePrice": 99.90,
20          "active": true,
21          "review": null,
22          "isGiftCard": false,
23          "stock": null,
24          "stocks": null,
25          "originalPrice": null,
26          "price": null,
27          "priceRules": null,
28          "brand": null,
29          "flags": null,
30          "tax": null,
31          "parentProduct": null,
32          "indicatedProducts": null,
33          "relatedProducts": null,
34          "filters": null,
35          "seals": null,
36          "mainCategory": null,
37          "categories": null,
38          "categoryBreadcrumb": null,
39          "dimensions": null,
40          "parentProductId": null,
41          "haveChildren": false,
42          "combination": [],
43          "currentAttributes": null,
44          "variations": null,
45          "medias": null,
46          "bannerGroups": [],
47          "status": null,
48          "createdAt": "2025-09-30 14:38:49",
49          "updatedAt": "2026-01-13 20:26:35",
50          "url": "",
51          "urls": [],
52          "linkedTradePolicies": [1],
53          "description": null
54        }
55      ],
56      "pagination": {
57        "limit": 10,
58        "offset": 0,
59        "pages": 1,
60        "registers": 1
61      }
62    }
63  }
64}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código InternoCódigo HTTPDescrição
UAPPI_STORE_WISH_LIST_NOT_FOUND404Lista de desejo não encontrada

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;