Skip to content

Avaliações

Visão Geral

As avaliações são análises e críticas feitas por compradores sobre um produto, serviço ou ferramenta, permitindo relatar experiência, satisfação pessoal e recomendações para outros clientes.

Elas trazem transparência para a decisão de compra e fornecem ao lojista feedbacks valiosos, possibilitando melhorias e ajustes para aumentar a satisfação dos clientes.

Entidades Relacionadas

No contexto Uappi, as avaliações estão relacionadas a três tipos principais: App, Produto e Canal de Venda. Apesar das particularidades de cada um, todos compartilham muitas características em relação as avaliações.

Apps - Usuário

Um App funciona como um plug-in para a loja, adicionando funcionalidades extras como login social, métodos de pagamento, cálculo de frete, envio de e-mails ou integração com redes sociais.

As avaliações de Apps permitem ao lojista analisar experiências de outros usuários, ajudando a decidir se vale a pena ativar determinada ferramenta no ecossistema da loja.

Canal de Venda - Cliente

O canal de venda define como a loja é disponibilizada e acessada pelos clientes, incluindo o domínio e o contexto de operação.

As avaliações nesse contexto refletem a experiência do cliente com a loja, indicando confiabilidade e qualidade do serviço/produtos, além de fornecer feedback direto ao lojista.

Produto - Cliente

Um produto pode ser físico ou digital, incluindo serviços, plataformas ou funcionalidades. O foco principal é o valor entregue ao usuário.

As avaliações de produtos ajudam outros clientes a tomar decisões mais conscientes, enquanto permitem ao lojista entender satisfação, pontos fortes e melhorias necessárias.

Regras gerais para Avaliações

  • Uma avaliação não pode ser feita mais de uma vez por item (App, produto ou canal de venda)
  • Toda avaliação feita por um cliente é cadastrada inicialmente como inativa; a ativação é responsabilidade do lojista (no caso de Apps, apenas o Admin Sources)
  • Qualquer ativação ou desativação de avaliação recalcula a nota média do item, considerando ou desconsiderando a avaliação atual

Detalhe da avaliação de produtos

GET /reviews/{reviewId}/product

Detalhes de uma avaliação de produtos

Descrição

Endpoint responsável por retornar todas as informações detalhadas de uma avaliação específica 📝🔎.

Trata-se de uma rota de uso exclusivo no contexto administrativo, sendo acessível apenas por usuários com perfil admin.

Permite a consulta completa dos dados da avaliação para fins de gestão, moderação ou análise interna.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
reviewIdintegerSimID único da avaluação

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/reviews/{reviewId}/product\
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    
6  }'

✅ Resposta de Sucesso

1{
2  "id": 1,
3  "name": "eric",
4  "email": "eric@email.com",
5  "comment": "Gostei do produto, eeee nota 10",
6  "recommended": false,
7  "score": 3,
8  "active": false,
9  "masked": false,
10  "createdAt": "2026-01-26 18:40:14",
11  "updatedAt": "2026-01-27 13:02:36",
12  "productId": 1,
13  "customerId": 1,
14  "medias": [],
15  "product": {
16    "productId": 1,
17    "brandId": 1,
18    "brandName": "TechBrand",
19    "mainCategoryId": 0,
20    "mainCategoryName": "",
21    "type": "product",
22    "sku": "SKU123321",
23    "name": "Techbrand smartphone case",
24    "active": true,
25    "url": "/tech-brand-smartphone-case.html",
26    "comparisonPrice": 50,
27    "stock": 20,
28    "medias": []
29  }
30}

⚠️ 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.

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_TOOLS_REVIEW_NOT_FOUND",
6    "message": "The requested evaluation was not found."
7  }
8}

Listagem de avaliação de produto

GET /reviews/product

listagem de todas as avaliações de produto feita por usuários do painel.

Descrição

Endpoint administrativo responsável por retornar todas as avaliações de produtos realizadas por clientes 🛍️⭐.

Permite que o lojista visualize as avaliações relacionadas aos seus produtos.

Por estar em contexto administrativo, o endpoint retorna as avaliações independentemente do status (ativas ou inativas), possibilitando gestão e moderação completas.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Campos Disponíveis (fields)

Especifique apenas os campos necessários para otimizar a performance:

CampoDescrição
productsTrás um objeto simples produto avaliado
mediasTrás as fotos tiradas pelo cliente sobre o produto avaliado

Campos de Condição Disponíveis

CampoTipoDescrição
productIdintegerFiltra avaliações por id do produto
customerIdintegerFiltra avaliações por cliente
salesChannelIdintegerFiltra avaliações por canal de venda
namestringFiltra avaliações pelo nome
emailstringFiltra avaliações pelo e-mail de quem avaliou
recommendedbooleanFiltra avaliações por clientes que recomendam ou não o produto (true/false)
scoreintFiltra avaliações pela nota (de 0 a 5)
createdAtstringFiltra avaliações baseado na data de cadastro

Campos de Ordenação Disponíveis

CampoDescrição
idOrdena a listagem pelo id da avaliação
productIdOrdena a listagem pelo id do produto
nameOrdena a listagem pelo nome da avaliação
scoreOrdena a listagem pela nota da avaliação
createdAtOrdena a listagem pela data em que a avaliação foi criada
updatedAtOrdena a listagem pela data em que a avaliação foi atualizada

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/reviews/product\
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "fields": [
6      
7    ]
8  }'

✅ Resposta de Sucesso

1{
2"registers": [
3    {
4      "id": 1,
5      "name": "eric",
6      "email": "eric@email.com",
7      "comment": "Gostei do produto, eeee nota 10",
8      "recommended": false,
9      "score": 4,
10      "active": false,
11      "masked": false,
12      "createdAt": "2026-01-26 18:40:14",
13      "updatedAt": "2026-01-27 13:02:36",
14      "productId": 1,
15      "customerId": 1,
16      "medias": [],
17      "product": {
18        "productId": 1,
19        "brandId": 1,
20        "brandName": "TechBrand",
21        "mainCategoryId": 1,
22        "mainCategoryName": "tech",
23        "type": "product",
24        "sku": "SKU123321",
25        "name": "TechBrand smartphone case",
26        "active": true,
27        "url": "/tech-brand-smartphone-case.html",
28        "comparisonPrice": 50,
29        "stock": 20,
30        "medias": [],
31        "combination": [],
32        "currentAttributes": []
33      }
34    }
35  ],
36  "pagination": {
37    "limit": 10,
38    "offset": 0,
39    "pages": 1,
40    "registers": 1
41  }
42}

Alterar status de avaliação de produto

PUT /review/{reviewId}/product

Rota para editar o status de exibição de uma avaliação de produto.

Descrição

Endpoint responsável por editar o status de visualização de uma avaliação de cliente sobre um produto ⚙️⭐.

A alteração do status define se a avaliação será ou não exibida para os clientes.

Essa modificação impacta diretamente na nota média do produto, pois sempre que o status é alterado, o sistema realiza um novo cálculo, acrescentando ou desconsiderando a avaliação conforme seu estado atual.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
reviewIdintegerSimID único da entidade de avaliação

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/review/{reviewId}/product\
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3	"data": true
4}

⚠️ 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.

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_TOOLS_REVIEW_NOT_FOUND",
6    "message": "The requested evaluation was not found."
7  }
8}

Excluir avaliação do produto

DELETE /review/{reviewId}/product

Exclusão de avaliação de usários sobre o produto

Descrição

Endpoint responsável por excluir uma avaliação de usuário sobre um produto 🗑️⭐.

A exclusão impacta diretamente na nota média do produto, pois o cálculo é refeito desconsiderando a avaliação removida, garantindo que a pontuação reflita apenas as avaliações válidas.

As avaliações mencionadas neste contexto não são exibidas para clientes finais, sendo destinadas exclusivamente ao uso interno da plataforma.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
reviewdintegerSimID único da entidade de avaliação

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/review/{reviewId}/product\
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3	"data": true
4}

⚠️ 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. 

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_TOOLS_REVIEW_NOT_FOUND",
6    "message": "The requested evaluation was not found."
7  }
8}

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

Institucional

;