Docs Avaliações Detalhes de Avaliações

Avaliação

Listagem

Campos

Campo	Tipo	Descrição
page	integer	Página atual
size	integer	Tamanho da página
total	integer	Número total de avaliações
pageCount	integer	Número total de páginas

reviews

Campo	Tipo	Descrição
id	uuid	Identificador único da avaliação
comment	string	Texto redigido pelo consumidor
reply	string	Réplica em texto da loja
createdAt	date	Data de criação da avaliação
score	double	Nota da avaliação
discarded	boolean	Flag que indica se a avaliação foi descartada
moderated	boolean	Flag que indica se a avaliação foi moderada
published	boolean	Flag que indica se a avaliação foi publicada para os consumidores
moderationStatus	enum	Status da moderação, se existir
surveyId	uuid	Identificador único da versão do questionário

reviews[].order

Campo	Tipo	Descrição
id	uuid	Identificador único do pedido
shortId	string	Identificador curto do pedido
createdAt	date	Data de criação do pedido

Exemplos

{
  "page": 1,
  "size": 10,
  "reviews": [
    {
      "id": "a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a",
      "comment": "Lanche gostoso e saboroso. Entregador top, chegou rapidinho.",
      "createdAt": "2021-04-07T01:46:59.722169Z",
      "discarded": false,
      "moderated": false,
      "published": true,
      "order": {
        "id": "bbec78f9-d579-414b-9120-37fda7968824",
        "shortId": "1234",
        "createdAt": "2021-04-07T00:39:30.902486Z"
      },
      "score": 5.0,
      "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
    }
  ],
  "total": 1,
  "pageCount": 1
}

Detalhes

Campos

Campo	Tipo	Descrição
id	uuid	Identificador único da avaliação
comment	string	Texto redigido pelo consumidor
reply	string	Réplica em texto da loja
createdAt	date	Data de criação da avaliação
score	double	Nota da avaliação
customerName	string	Primeiro nome do consumidor
discarded	boolean	Flag que indica se a avaliação foi descartada
moderated	boolean	Flag que indica se a avaliação foi moderada
published	boolean	Flag que indica se a avaliação foi publicada para os consumidores
moderationStatus	enum	Status da moderação, se existir
surveyId	uuid	Identificador único da versão do questionário

order

Campo	Tipo	Descrição
id	uuid	Identificador único do pedido
shortId	string	Identificador curto do pedido
createdAt	date	Data de criação do pedido

questions

Campo	Tipo	Descrição
id	uuid	Identificador único da pergunta
type	enum	Tipo de pergunta
title	string	Texto da pergunta

questions[].answers

Campo	Tipo	Descrição
id	uuid	Identificador único da resposta
title	string	Texto da resposta

Exemplos

{
  "id": "7e5605cf-ce31-4df7-9367-a38a6bc7a20f",
  "comment": "Chegou muito rápido, ingredientes de qualidade, tempero gostoso 😋",
  "createdAt": "2021-03-30T00:32:32.820884Z",
  "customerName": "Elisa",
  "discarded": false,
  "moderated": false,
  "published": true,
  "order": {
    "id": "23651b6d-042e-4c66-8e1a-ee2a92544e4f",
    "shortId": "1234",
    "createdAt": "2021-03-29T03:10:28.552082Z"
  },
  "questions": [
    {
      "id": "7e7346ca-b24e-46c9-bda4-62411a8eb2fe",
      "type": "CHOICE",
      "title": "Do que você mais gostou?",
      "answers": [
        {
          "id": "05e8622f-be9f-4692-b087-25a06d02cc59",
          "title": "Educação"
        },
        {
          "id": "e4e21ee1-965f-419c-935f-cca827946fe5",
          "title": "Cuidado com o pedido"
        },
        {
          "id": "13f1f750-05e2-4930-bcca-030ffdb6b9c0",
          "title": "Paciência"
        },
        {
          "id": "7a1ad2b3-21ba-4978-9313-8cfac19b5f84",
          "title": "Dentro do prazo"
        }
      ]
    },
    {
      "id": "a1cdf161-62b9-4ccf-ad91-8e9898655e39",
      "type": "BINARY",
      "title": "Você gostou da entrega?",
      "answers": [
        {
          "id": "a441afc3-ab63-4254-8f00-219de3f916fd",
          "title": "Sim, gostei"
        }
      ]
    },
    {
      "id": "8e075d05-d1e3-49f4-b2b5-f11c58428852",
      "type": "CHOICE",
      "title": "Do que você gostou?",
      "answers": [
        {
          "id": "6d579be3-68b8-454f-9a5f-f7b3aaed1a0f",
          "title": "Temperatura certa"
        },
        {
          "id": "ac8cce95-c69d-4668-bb8b-1f41d1518f73",
          "title": "Bons ingredientes"
        },
        {
          "id": "83af4a03-f6d5-4a19-b918-64c195e0cf08",
          "title": "Saborosa"
        },
        {
          "id": "5f98443b-55b4-463b-97cc-0ceba62054c2",
          "title": "Boa aparência"
        }
      ]
    },
    {
      "id": "395d869b-4f51-476d-9160-4f0a18ddce97",
      "type": "RATING",
      "title": "O que você achou da comida?",
      "answers": [
        {
          "id": "7aaef29a-4e0a-409b-8e0b-2bc4586fb66d",
          "title": "5"
        }
      ]
    }
  ],
  "score": 5.0,
  "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
}

Questionário

As avaliações de uma mesma loja podem variar em versão e conteúdo de questionário, tendo diferentes perguntas e respostas.

Dada a natureza dinâmica da construção do questionário, prevemos uma mudança futura para adequação ao contexto da loja e do pedido (contudo mantendo a mesma modelagem).

Perguntas disponíveis

[
  {
    "id": "395d869b-4f51-476d-9160-4f0a18ddce97",
    "type": "RATING",
    "title": "O que você achou da comida?",
    "options": [
      {
        "id": "0b964db7-92f8-402f-978b-b6e1708b3693",
        "title": "1"
      },
      {
        "id": "b0ac7a06-88c9-47e7-85f0-e79965d6150c",
        "title": "2"
      },
      {
        "id": "526da72c-47fe-49b5-a41a-7bb601417c49",
        "title": "3"
      },
      {
        "id": "fede439f-1fbc-4e29-aa89-a46036d6fc73",
        "title": "4"
      },
      {
        "id": "7aaef29a-4e0a-409b-8e0b-2bc4586fb66d",
        "title": "5"
      }
    ]
  },
  {
    "id": "f244c3c7-4907-4d30-b69d-075699d2dd6a",
    "type": "CHOICE",
    "title": "O que pode melhorar?",
    "options": [
      {
        "id": "4afd519c-b978-4037-ba2e-a7e9f93c38a3",
        "title": "Sabor"
      },
      {
        "id": "4d4c2439-a300-4da2-a3d0-595514283ed9",
        "title": "Tempero"
      },
      {
        "id": "d5fff91e-7ba4-4d3d-8ec3-70bd712f25b3",
        "title": "Aparência"
      },
      {
        "id": "5b1da20d-52cb-449f-899a-ae39dd0341de",
        "title": "Quantidade"
      },
      {
        "id": "f4a65843-d318-49c4-9562-029bb491af4d",
        "title": "Embalagem"
      },
      {
        "id": "5f11ad52-9cb3-4ada-8219-68dbb7060816",
        "title": "Temperatura"
      },
      {
        "id": "dc28f089-eea4-42a8-9c4d-7935e1f4d7c3",
        "title": "Ingredientes"
      },
      {
        "id": "1fcae103-423d-4feb-a4de-a920513d8bb1",
        "title": "Ponto de cozimento"
      },
      {
        "id": "d538ac94-52cf-407a-aaee-73cc56cc7552",
        "title": "Itens errados"
      }
    ]
  },
  {
    "id": "8e075d05-d1e3-49f4-b2b5-f11c58428852",
    "type": "CHOICE",
    "title": "Do que você gostou?",
    "options": [
      {
        "id": "83af4a03-f6d5-4a19-b918-64c195e0cf08",
        "title": "Saborosa"
      },
      {
        "id": "c05f04f8-4af4-42c7-bf57-6bc3392d1d4e",
        "title": "Bem temperada"
      },
      {
        "id": "5f98443b-55b4-463b-97cc-0ceba62054c2",
        "title": "Boa aparência"
      },
      {
        "id": "1b6a5695-0028-4f21-85e7-4f7b30ab18a4",
        "title": "Boa quantidade"
      },
      {
        "id": "aaf56933-c595-4401-af92-15d8866061a5",
        "title": "Boa embalagem"
      },
      {
        "id": "6d579be3-68b8-454f-9a5f-f7b3aaed1a0f",
        "title": "Temperatura certa"
      },
      {
        "id": "ac8cce95-c69d-4668-bb8b-1f41d1518f73",
        "title": "Bons ingredientes"
      },
      {
        "id": "d0c7f9a5-569c-467b-b237-b77458de2851",
        "title": "No ponto certo"
      }
    ]
  }
]

Sumário

Agregações de soma e média sobre um agrupamento de avaliações.

A nota de uma loja é composta pela média das notas presentes nas avaliações válidas, ou seja, avaliações que:

não foram descartadas
data de criação inferior a 3 meses

Campos

Campo	Tipo	Descrição
totalReviewsCount	integer	Soma de todas as avaliações da loja
validReviewsCount	integer	Soma das avaliações contabilizadas na nota
score	double	Média de nota das avaliações válidas

Exemplo

{
  "totalReviewsCount": 142,
  "validReviewsCount": 53,
  "score": 4.3
}