Skip to main content
GET
Avaliações
Retorna as avaliações recebidas pela loja: a nota (stars), o comentário (review, quando o cliente escreveu um), a data e a origem. Cada avaliação referencia a venda avaliada (saleId) e o cliente que avaliou (customerId) — os mesmos identificadores das demais rotas.
integrationId informa de qual plataforma a avaliação veio (por exemplo Ifood, AnotaAi, Google) — é o nome da integração como texto, útil para separar a reputação por canal.
Filtre pelo período com from/to (datas inclusivas) e pagine com cursor/nextCursor.
Cruzando saleId com Obter pedido você descobre o que o cliente comprou na venda mal avaliada; cruzando customerId com Clientes (CRM) você vê se o crítico é um cliente frequente ou ocasional.

Erros

Cupons

As vendas com cupom — mesmo padrão de saleId e customerId desta rota.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

Parâmetros de consulta

from
string<date>

Início do período (data, inclusive). Deve ser anterior ou igual a to.

to
string<date>

Fim do período (data, inclusive).

cursor
string

Cursor opaco da próxima página, retornado em nextCursor. Omita na primeira chamada.

limit
integer<int32>
padrão:100

Itens por página. Valores acima de 500 são limitados a 500.

Intervalo obrigatório: x <= 500

Resposta

Página de avaliações do período.

items
object[]
nextCursor
string | null

Cursor da próxima página. Null quando não há próxima página.