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

Listagem de avaliações de Canal de venda em detalhes

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 em 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, análise ou moderação interna.

Parâmetros de Query

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/reviews/{reviewId}/sales-channel\
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": "Essa é definitivamente uma das lojas já feitas",
6  "recommended": true,
7  "score": 5,
8  "active": false,
9  "masked": false,
10  "createdAt": "2026-01-26 18:36:54",
11  "updatedAt": "2026-01-30 13:55:57",
12  "salesChannelId": 1,
13  "customerId": 1,
14  "salesChannelDomain": "https://sualoja.com.br"
15}

⚠️ 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 canal de venda

Descrição

Endpoint responsável por retornar todas as avaliações sobre canais de venda (loja) 🏬⭐.

Permite que o lojista visualize as avaliações relacionadas à sua loja.

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

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/reviews/sales-channel \
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2  "registers": [
3			{
4				"id": 1,
5				"name": "joão",
6				"email": "joão@email.com",
7				"comment": "Essa é definitivamente uma das lojas já feitas",
8				"recommended": true,
9				"score": 5,
10				"active": false,
11				"masked": false,
12				"createdAt": "2026-01-26 18:36:54",
13				"updatedAt": "2026-01-26 18:36:54",
14				"salesChannelId": 1,
15				"customerId": 1,
16				"salesChannelDomain": "https://sualoja.com.br"
17			}
18		],
19		"pagination": {
20			"limit": 10,
21			"offset": 0,
22			"pages": 1,
23			"registers": 1
24		}
25}

Alterar status de avaliação de canal de venda

Descrição

Endpoint responsável por editar o status de visualização de uma avaliação de cliente sobre o canal de venda (loja) ⚙️🏬⭐.

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

Essa modificação impacta diretamente na nota média da loja, 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

Parâmetros da URL

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/review/{reviewId}/sales-channel\
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 canal de venda

Descrição

Endpoint responsável por excluir uma avaliação de cliente sobre um canal de venda (loja) 🗑️🏬.

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

Este é um endpoint de contexto administrativo, permitindo que um usuário autorizado realize a exclusão da avaliação de um cliente.

Parâmetros de Query

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/review/{reviewId}/sales-channel\
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}