Docs Avaliações

Definiciones

Calificación

Representa la opinión de un cliente sobre un pedido.La entidad de calificación tiene:

metadatos (fecha de creación e indicadores de status)
opcionalmente un comentario
opcionalmente una respuesta al comentario
las respuestas de un cuestionario
una puntuación del 1 al 5 para la experiencia en su conjunto

Presentación en el Portal do Parceiro:

Más sobre modelado en la sección de detalles.

Las calificaciones son válidas durante 3 meses después de creadas.

Publicación

Una calificación se considera pública, es decir, visible para los clientes, si cumple uno de los siguientes criterios:

no tiene comentario
tiene un comentario y han pasado 7 días
tiene un comentario y una respuesta
tiene una moderación rechazada

Además, la calificación debe ser válida (no descartable).El modelado presenta esta interpretación en la flag published.

Las calificaciones eliminadas no son visibles para los clientes, pero la tienda aún puede verlas.

Comentario

Es un texto que el cliente adjunta a la Calificación.Cuando hay un comentario la calificación tiene un período de respuesta de 7 días, en donde la tienda puede abrir una solicitud de moderación si lo desea. Este proceso se conoce como Flujo de Moderación.

Los comentarios pueden modificarse mediante la intervención de iFood para, por ejemplo, eliminar contenido ofensivo.

Respuesta

Es la réplica de la tienda frente a una calificación del cliente mediante un texto.Una calificación puede recibir una respuesta siempre que:

tenga un comentario
sea válida (no descartado)
este dentro del período de respuesta (7 días después de la creación)

La respuesta tiene un límite mínimo de 10 y un máximo de 300 caracteres.

Las respuestas pueden modificarse mediante la intervención de iFood para, por ejemplo, eliminar contenido ofensivo.

Eliminación de calificaciones

A las calificaciones que se eliminan se les asigna la flag discarded=true y dejan de ser públicas.Los escenarios para eliminar son:

expiración del período de validez de 3 meses
solicitudes de moderación aceptadas

Flujo de moderación

Cuando la tienda no está de acuerdo con la calificación de un cliente, puede solicitar una moderación de iFood para mediar en la decisión de eliminar una calificación.

El flujo de moderación actualmente solo está disponible en el Portal do Parceiro.

Tipos de status de la moderación

Estado	Descripción
REQUESTED	Estado inicial cuando la tienda solicitó moderación
APPROVED	Se aceptó la solicitud de moderación, es decir, se eliminó la calificación.
DENIED	La solicitud de moderación fue rechazada y la calificación sigue siendo válid
MODERATED	Se ha cambiado el contenido de la calificación (por ejemplo, para proteger datos personales o eliminar contenido ofensivo)

Cuestionario

Es una agrupación de preguntas dirigidas al cliente, contiene una versión (por ejemplo, v3) y un identificador único (UUID).Tenga en cuenta que la construcción del cuestionario es dinámica, se pueden agregar o quitar preguntas a lo largo de la existencia de una versión. Más sobre las versiones en la sección de detalles.

El cuestionario se presenta únicamente en el GETde una sola calificación (omitido en el listado).

Pregunta

Es un elemento de un cuestionario, identificado por UUID y por el título.Ejemplo:

{
  "questions": [
    {
      "id": "a1cdf161-62b9-4ccf-ad91-8e9898655e39",
      "type": "BINARY",
      "title": "Você gostou da entrega?"
    },
    {
      "id": "8e075d05-d1e3-49f4-b2b5-f11c58428852",
      "type": "CHOICE",
      "title": "Do que você gostou?"
    }
  ]
}

Tipos de Preguntas

El tipo de pregunta define la respuesta esperada.

Tipo	Descrição
RATING	Valor número
BINARY	Verdadero o Falso
CHOICE	Selección de Tags
TEXT	Texto abierto

Respuestas a una pregunta

Es la lista de respuestas a una pregunta.Ejemplo:

{
  "answers": [
    {
      "id": "a441afc3-ab63-4254-8f00-219de3f916fd",
      "title": "Sim, gostei"
    }
  ]
}

{
  "answers": [
    {
      "id": "c05f04f8-4af4-42c7-bf57-6bc3392d1d4e",
      "title": "Bem temperada"
    },
    {
      "id": "6d579be3-68b8-454f-9a5f-f7b3aaed1a0f",
      "title": "Temperatura certa"
    },
    {
      "id": "83af4a03-f6d5-4a19-b918-64c195e0cf08",
      "title": "Saborosa"
    }
  ]
}

Resumen

Información que conforma la nota de la tienda en la plataforma.

Más sobre el resumen en la sección de detalles.

Uso de la API

Rate Limit Cada cliente evaluador de API está limitado a 10 solicitudes por segundo (para el mismo token). Si excede el límite de solicitudes, el cliente puede ser bloqueado temporalmente. En estos casos, recibirás el código 429 como respuesta.

Listado de calificaciones

Para obtener las calificaciones usa la API GET /merchants/{merchantId}/reviews

El filtro de rango de fechas predeterminado para filtrar las calificaciones es de 7 días previos hasta la fecha actual (al igual que en el Portal do Parceiro).

Solicitud:

curl --location --request GET 'https://merchant-api.ifood.com.br/review/v1.0/merchants/6b487a27-c4fc-4f26-b05e-3967c2331882/reviews?addCount=true' \
--header 'Authorization: Bearer TOKEN

Respuesta:

{
  "page": 1,
  "size": 3,
  "total": 3,
  "pageCount": 1,
  "reviews": [
    {
      "id": "a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a",
      "comment": "Muito bom, adorei!",
      "createdAt": "2021-04-07T01:46:59.722169Z",
      "discarded": false,
      "moderated": false,
      "published": false,
      "order": {
        "id": "bbec78f9-d579-414b-9120-37fda7968824",
        "createdAt": "2021-04-07T00:39:30.902486Z"
      },
      "score": 5.0,
      "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
    },
    {
      "id": "38db7090-c13f-48a3-9431-7a11beb89730",
      "createdAt": "2021-04-08T14:11:14.333868Z",
      "discarded": false,
      "moderated": false,
      "published": true,
      "order": {
        "id": "67f2d08c-9b2f-4cee-87cd-57ae87a40d03",
        "createdAt": "2021-03-29T00:20:00.830751Z"
      },
      "score": 5.0,
      "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
    },
    {
      "id": "2841b0ca-c474-4580-81cc-82cb9b36d184",
      "createdAt": "2021-02-07T22:46:52.221000Z",
      "comment": "Tive um problema com o pedido!",
      "discarded": false,
      "moderated": false,
      "published": true,
      "order": {
        "id": "1cfbb732-d787-411e-a891-5ed15b1e4716",
        "createdAt": "2021-02-07T12:01:00.231445Z"
      },
      "score": 3.0,
      "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
    }
  ]
}

Obtener detalles de una calificación

Usando el id de una reseña obtenida de la lista, es posible obtener información más detallada a través de la API GET /merchants/{merchantId}/reviews/{reviewId}Solicitud:

curl --location --request GET 'https://merchant-api.ifood.com.br/review/v1.0/merchants/6b487a27-c4fc-4f26-b05e-3967c2331882/reviews/a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a' \
--header 'Authorization: Bearer TOKEN

Respuesta:

{
  "id": "a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a",
  "comment": "Muito bom, adorei!",
  "createdAt": "2021-04-07T01:46:59.722169Z",
  "customerName": "Consumidor teste 1",
  "discarded": false,
  "moderated": false,
  "published": true,
  "order": {
    "id": "c0acd22a-27c2-4556-8b50-4b4eb2948882",
    "createdAt": "2021-04-07T00:39:30.902486Z"
  },
  "questions": [
    {
      "id": "7e7346ca-b24e-46c9-bda4-62411a8eb2fe",
      "type": "CHOICE",
      "title": "Do que você mais gostou?"
      "answers": [
        {
          "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": "ac8cce95-c69d-4668-bb8b-1f41d1518f73",
          "title": "Bons ingredientes"
        }
      ]
    }
  ],
  "score": 5.0,
  "surveyId": "2c35c485-9f23-464d-bd83-cf6ecd1c71e0"
}

Respondiendo a una calificación

Usando el id de una calificación no publicada, la respuesta se puede enviar a través de la API POST /merchants/{merchantId}/reviews/{reviewId}/answersSolicitud:

curl --location --request POST 'https://merchant-api.ifood.com.br/review/v1.0/merchants/6b487a27-c4fc-4f26-b05e-3967c2331882/reviews/a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a/answers' \
--header 'Authorization: Bearer TOKEN \
--header 'Content-Type: application/json' \
--data-raw '{
	"text": "Obrigado por seu feedback!"
}'

Respuesta:

{
  "text": "Obrigado por seu feedback!",
  "createdAt": "2021-04-08T15:04:30.902322Z",
  "reviewId": "a26c8718-b1f5-44a0-8f06-ecc71ddfcd5a"
}

Obtener un resumen

Para obtener un resumen agrupado, utiliza la API GET /merchants/{merchantId}/summarySolicitud:

curl --location --request GET 'https://merchant-api.ifood.com.br/review/v1.0/merchants/6b487a27-c4fc-4f26-b05e-3967c2331882/summary' \
--header 'Authorization: Bearer TOKEN

Respuesta:

{
  "totalReviewsCount": 138,
  "validReviewsCount": 65,
  "score": 4.4
}