API legada/Guia rápido/Conteúdo e características do produto

Avaliações (discussions)

Lista as avaliações de clientes de um produto no formato de discussões da Venddor 1.0.

Na Venddor 1.0, as opiniões dos clientes sobre um produto chamam-se discussões (discussions). Na Venddor elas são as avaliações do produto: nota de 1 a 5 e um texto. Esta rota devolve, no formato de discussão da Venddor 1.0, as avaliações de um produto, da mais nova para a mais antiga.

Esta rota é só de leitura. Para criar, moderar ou apagar avaliações, a API tem as rotas de nível de loja /api/v1.0/discussions (que não fazem parte desta página).

GET/api/v1.0/products/{product_id}/discussionsAdmin

Avaliações (discussões) de um produto

Autenticação: HTTP Basic (e-mail:chave_de_api) de um administrador, ou Authorization: Bearer <JWT>. Também responde em /api/products/{product_id}/discussions; nessa forma os ids seguem o estilo decimal em string das rotas /api.

Avaliações de produtos excluídos não aparecem. Produto sem avaliações ou id que não existe responde 200 com lista vazia.

Parâmetros de caminho

product_idstringobrigatório

Id do produto (UUID em /api/v1.0; decimal em string em /api).

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Valor fora dessa faixa volta ao padrão 10.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/products/48e87591-5fb1-40da-b32e-edec3a8c596d/discussions?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Resposta

200Avaliações do produto

json

{
  "discussions": [
    {
      "thread_id": "5a1f7c0e-3b0d-4c0e-9f6a-0d2d7b1c9a10",
      "object_type": "P",
      "object_id": "48e87591-5fb1-40da-b32e-edec3a8c596d",
      "name": "Maria S.",
      "message": "Chegou rápido e funciona muito bem.",
      "rating_value": 5,
      "status": "A",
      "timestamp": 1791687385
    }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

discussionsarray

Avaliações da página, da mais nova para a mais antiga.

discussions[].thread_idstring

Id da avaliação.

discussions[].object_typestring

Sempre "P" (produto).

discussions[].object_idstring

Id do produto.

discussions[].namestring

Nome de quem avaliou. Para visitante sem nome, Anonymous.

discussions[].messagestring

Texto da avaliação. Vazio quando o cliente só deu a nota.

discussions[].rating_valueinteger

Nota de 1 a 5.

discussions[].statusstring

AND

A aprovada, N pendente de moderação, D recusada.

discussions[].timestampinteger

Criação, em Unix timestamp (segundos).

paramsobject

Paginação: page, items_per_page e total_items (total de avaliações do produto, de todas as páginas).

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	`product_id` fora do formato UUID	`{"message":"...","status":500}`

Veja também