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

GETNotas do produto

Devolve a nota média, o total de avaliações e quantas há de cada nota de 1 a 5.

Serve ao cabeçalho de estrelas e ao histograma da página do produto ("4,5 de 5, 12 avaliações"). É mais leve que listar as avaliações. O módulo de avaliações precisa estar ligado e a resposta pode ser guardada em cache por 5 minutos.

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

Nota média e distribuição das avaliações

Parâmetros de caminho

idstringobrigatório

Id do produto. A rota ecoa o valor recebido em product_id.

Exemplo de requisição

bash

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

Resposta

200Notas retornadas

json

{"product_id":"5e833a7f-1a77-402c-835a-32594350d7a7","avg_rating":4.5,"total_reviews":12,"rating_distribution":[0,1,1,3,7]}

Campos da resposta

product_idstring

Id recebido na requisição.

avg_ratingnumber

Média das avaliações aprovadas. 0 sem avaliações.

total_reviewsinteger

Quantidade de avaliações aprovadas.

rating_distributionarray

Lista fixa de 5 inteiros: posição 0 é a contagem de 1 estrela e a posição 4, de 5 estrelas. No exemplo, 7 avaliações de 5 estrelas.

Erros

Status	Quando	Corpo de exemplo
403	O módulo de avaliações está desligado.	`{"error":"module_disabled","module":"product-reviews"}`
500	Falha ao ler as notas.	`{"error":"failed to get review stats","detail":"..."}`

Veja também