VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/API 4.0 (app móvel)

Avaliações

Devolve as avaliações aprovadas de um produto, com a nota média, para a tela de detalhe do app.

Avaliações são os comentários e notas que clientes deixam num produto. O app mostra a nota média e a lista de comentários na ficha do produto. Esta rota é anônima e só devolve avaliações aprovadas pela moderação da loja.

GET/api/4.0/sra_discussionPública

Avaliações de um produto

A ordem é da mais nova para a mais antiga.

Parâmetros de consulta

object_idstring
Id do produto (decimal ou UUID). Sem ele, a lista vem vazia em vez de dar erro.
object_typestringpadrão: P
PM
P avaliações de produto. M seria avaliação de seller, que a plataforma não tem: sempre vem vazia. Qualquer outro valor também vem vazio.
pageintegerpadrão: 1
Página, a partir de 1.
items_per_pageintegerpadrão: 20
Itens por página. (per_page é um sinônimo.) Valor menor que 1 vira 20.

Exemplo de requisição

bash
curl "$BASE_URL/api/4.0/sra_discussion?object_type=P&object_id=1585658495&items_per_page=10"

Resposta

200Avaliações retornadas
json
{
  "average_rating": 4.5,
  "posts": [
    {
      "post_id": "6d1f5b1e-3a52-4ac2-9c31-1c6d5a4f0e11",
      "name": "Maria S.",
      "message": "Chegou rápido e é exatamente como na foto.",
      "rating": 5,
      "timestamp": 1791676800
    }
  ],
  "search": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

average_ratingnumber
Nota média das avaliações aprovadas do produto. 0 quando não há.
posts[].post_idstring
Id da avaliação (UUID).
posts[].namestring
Nome de quem avaliou, como a loja o exibe.
posts[].messagestring
Texto da avaliação. Vazio quando o cliente só deu a nota.
posts[].ratinginteger
Nota de 1 a 5.
posts[].timestampinteger
Data da avaliação em Unix timestamp (segundos, UTC).
searchobject
Paginação: page, items_per_page e total_items. Atenção: aqui a chave é search, não params.

Erros

StatusQuandoCorpo
401Authorization presente mas não é uma ekey válida{"error":"unauthorized"}
500Falha ao listar{"error":"failed to list discussion","detail":"..."}
A paginação vem em search

As listas de produtos e categorias devolvem a paginação em params; as avaliações a devolvem em search. Se você reaproveita o leitor de paginação do catálogo, ajuste a chave.

Veja também

  • Produtos
  • Visão geral da API 4.0
Anterior
Sellers
Próxima
Páginas do app
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também