Skip to main content

Reviews Widget

O widget consome a API Martan e espera o seguinte formato de resposta:
{
  "result": [
    {
      "id": "string",
      "display_name": "string",
      "rating": 5,
      "body": "string",
      "title": "string",
      "created_at": "2024-01-15T00:00:00Z",
      "verified_purchase": true,
      "is_recommended": true,
      "pictures": []
    }
  ],
  "count": 100,
  "meta": {
    "limit": 10,
    "offset": 0,
    "query": {
      "product_sku": "PROD-123"
    }
  }
}

Campos do Review

CampoTipoDescrição
idstringID único da avaliação
display_namestringNome do avaliador
ratingnumberNota de 1 a 5
bodystringTexto da avaliação
titlestringTítulo da avaliação
created_atstringData de criação (ISO 8601)
verified_purchasebooleanSe a compra foi verificada
is_recommendedbooleanSe o produto é recomendado
picturesarrayArray de URLs de imagens

Rating Widget

O widget de rating consome a API Martan no endpoint /api/v1/ratings.json?expand=metrics e espera o seguinte formato:
{
  "result": [
    {
      "sku": "PROD-123",
      "product_id": "123",
      "average": 4.5,
      "total": 120,
      "recommended": 100,
      "not_recommended": 5,
      "recommended_percentage": 83.33,
      "rate": {
        "one": 0,
        "two": 2,
        "three": 8,
        "four": 30,
        "five": 80
      }
    }
  ],
  "count": 1
}

Campos do Rating

CampoTipoDescrição
skustringSKU do produto
product_idstringID do produto
averagenumberMédia de avaliações (0-5)
totalnumberTotal de avaliações
recommendednumberNúmero de recomendações
not_recommendednumberNúmero de não recomendações
recommended_percentagenumberPercentual de recomendações
rateobjectDistribuição por estrelas
rate.onenumberQuantidade de avaliações com 1 estrela
rate.twonumberQuantidade de avaliações com 2 estrelas
rate.threenumberQuantidade de avaliações com 3 estrelas
rate.fournumberQuantidade de avaliações com 4 estrelas
rate.fivenumberQuantidade de avaliações com 5 estrelas
O widget faz cache dos dados no localStorage por 24 horas para otimizar performance. Apenas uma requisição à API é feita por página, mesmo com múltiplos componentes.