API atual/Referência completa/Avaliações e perguntas

GETResumo das avaliações

Devolve um texto-síntese das avaliações do produto e os aspectos mais citados, quando existe.

Quando um produto tem avaliações suficientes (a partir de 5), a loja gera um resumo em texto que reúne o consenso dos compradores, com os aspectos mais citados (por exemplo "conforto", "prazo de entrega") e o sentimento de cada um. Use para o bloco "O que os clientes dizem".

Um produto sem resumo é um estado normal da página, não um erro: a resposta é 200 com corpo null. O resumo é atualizado periodicamente. A rota exige que o recurso de avaliações esteja ligado na loja e a resposta pode ser guardada por 5 minutos.

GET/api/v1/storefront/products/{id}/reviews/summaryPública

Resumo das avaliações de um produto

Parâmetros de caminho

iduuidobrigatório

Id do produto (UUID completo).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/reviews/summary"

Resposta

200Resumo retornado

json

{
  "summary_text": "A maioria dos compradores aprova o acabamento e a resistência da caneca. Algumas avaliações citam o prazo de entrega como ponto de atenção.",
  "aspects": [
    {"aspect": "acabamento", "sentiment": "positive", "mention_count": 4, "review_ids": ["3f8a2d10-6a54-4a0e-9c0d-5f1d7a2b9e44"]},
    {"aspect": "prazo de entrega", "sentiment": "negative", "mention_count": 1, "review_ids": ["8c2e0b61-1d3f-4b7a-a5e9-6d4f2c1b0a37"]}
  ],
  "reviews_count": 12,
  "generated_at": "2026-10-09T03:00:00Z"
}

Sem resumo disponível (resposta real da loja de teste, o corpo é o literal null):

200Sem resumo

json

null

Campos da resposta

summary_textstring

Texto-síntese em português, de 4 a 6 frases.

aspectsarray

Até 6 aspectos citados nas avaliações.

aspects[].aspectstring

Nome do aspecto.

aspects[].sentimentstring

positivenegativemixed

Sentimento predominante.

aspects[].mention_countinteger

Quantas avaliações citam o aspecto.

aspects[].review_idsarray

Ids das avaliações que citam o aspecto, para destacá-las na lista.

reviews_countinteger

Quantas avaliações aprovadas entraram no resumo.

generated_atstring

Quando o resumo foi gerado, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
403	O recurso de avaliações está desligado na loja.	`{"error":"feature_not_available","feature":"reviews","detail":"switched off for this store"}`
500	Falha ao ler o resumo.	`{"error":"failed to read summary","detail":"..."}`

Veja também

GETResumo das avaliações

Devolve um texto-síntese das avaliações do produto e os aspectos mais citados, quando existe.

GET/api/v1/storefront/products/{id}/reviews/summaryPública

Resumo das avaliações de um produto

Parâmetros de caminho

iduuidobrigatório

Id do produto (UUID completo).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/reviews/summary"

Resposta

200Resumo retornado

json

{
  "summary_text": "A maioria dos compradores aprova o acabamento e a resistência da caneca. Algumas avaliações citam o prazo de entrega como ponto de atenção.",
  "aspects": [
    {"aspect": "acabamento", "sentiment": "positive", "mention_count": 4, "review_ids": ["3f8a2d10-6a54-4a0e-9c0d-5f1d7a2b9e44"]},
    {"aspect": "prazo de entrega", "sentiment": "negative", "mention_count": 1, "review_ids": ["8c2e0b61-1d3f-4b7a-a5e9-6d4f2c1b0a37"]}
  ],
  "reviews_count": 12,
  "generated_at": "2026-10-09T03:00:00Z"
}

Sem resumo disponível (resposta real da loja de teste, o corpo é o literal null):

200Sem resumo

json

null

Campos da resposta

summary_textstring

Texto-síntese em português, de 4 a 6 frases.

aspectsarray

Até 6 aspectos citados nas avaliações.

aspects[].aspectstring

Nome do aspecto.

aspects[].sentimentstring

positivenegativemixed

Sentimento predominante.

aspects[].mention_countinteger

Quantas avaliações citam o aspecto.

aspects[].review_idsarray

Ids das avaliações que citam o aspecto, para destacá-las na lista.

reviews_countinteger

Quantas avaliações aprovadas entraram no resumo.

generated_atstring

Quando o resumo foi gerado, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
403	O recurso de avaliações está desligado na loja.	`{"error":"feature_not_available","feature":"reviews","detail":"switched off for this store"}`
500	Falha ao ler o resumo.	`{"error":"failed to read summary","detail":"..."}`