Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
merchant
/
reviews
Listar avaliações
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/reviews \
  --header 'X-API-KEY: <api-key>'
{
  "reviews": [
    {
      "id": 564815,
      "order_id": 958647521,
      "customer_id": 6589647,
      "rating": 5,
      "comment": "Deu tudo certo!",
      "created_at": "2025-05-07T15:45:45.393-03:00",
      "answers": [
        {
          "question_id": 239,
          "question": "Atendimento",
          "answer": "5"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_reviews": 123
  }
}

Autorizações

X-API-KEY
string
header
obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Parâmetros de consulta

start_date
string<date-time>

Data de início do período para filtrar os pedidos com base na data de criação, com a possibilidade de retroceder no máximo 3 anos a partir da data atual.

Exemplo:

"2023-01-01T00:00:00-03:00"

end_date
string

Data de término do período para filtrar os pedidos com base na data de criação, assegurando que o intervalo não ultrapasse 6 meses.

Exemplo:

"2023-06-30T23:59:59-03:00"

page
number
padrão:1
Intervalo obrigatório: x >= 1
per_page
number
padrão:100
Intervalo obrigatório: 1 <= x <= 100

Resposta

Lista de avaliações retornada com sucesso

reviews
Review · object[]

Lista de avaliações retornadas.

pagination
object

Informações sobre a paginação dos resultados de avaliações.

Última modificação em 27 de junho de 2026