> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repediu.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Avaliações

> Notas e comentários deixados pelos clientes, ligados à venda e ao cliente que avaliou

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.

<Info>
  `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.
</Info>

Filtre pelo período com `from`/`to` (datas inclusivas) e pagine com `cursor`/`nextCursor`.

<Tip>
  Cruzando `saleId` com [Obter pedido](/open-delivery/obter-pedido) você descobre **o que** o cliente comprou na venda mal avaliada; cruzando `customerId` com [Clientes (CRM)](/crm-parceiro/clientes) você vê se o crítico é um cliente frequente ou ocasional.
</Tip>

## Erros

| HTTP  | `code` no corpo | Quando acontece                                                   | O que fazer                                                            |
| ----- | --------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `400` | `BAD_REQUEST`   | `from`/`to` mal formatados, janela invertida ou `cursor` inválido | Corrija o parâmetro indicado em `details`                              |
| `401` | `UNAUTHORIZED`  | Token ausente, inválido ou expirado                               | Gere um novo token em [Obter token](/open-delivery/obter-token)        |
| `403` | `FORBIDDEN`     | Token sem o escopo exigido pela rota                              | Confirme as permissões da credencial com a Repediu                     |
| `404` | `NOT_FOUND`     | Merchant inexistente **ou fora do escopo**                        | Confirme o `id` em [Listar merchants](/open-delivery/listar-merchants) |

<Card title="Cupons" icon="ticket" href="/crm-parceiro/cupons">
  As vendas com cupom — mesmo padrão de `saleId` e `customerId` desta rota.
</Card>


## OpenAPI

````yaml openapi.yaml GET /v1/stores/{merchantId}/ratings
openapi: 3.0.1
info:
  title: Repediu — API de integração
  description: >-
    API de integração da Repediu: rotas Open Delivery 2.0 (capabilities CRM),
    dado bruto do CRM do parceiro (/v1/stores) e métricas agregadas
    (/v1/stores/.../metrics). A autenticação usa o fluxo client_credentials: o
    token identifica a aplicação integradora e dá acesso a todos os
    estabelecimentos (merchants) que ativaram a integração.
  version: v2
servers:
  - url: https://public-api.repediu.com.br
    description: Produção
security:
  - Bearer: []
paths:
  /v1/stores/{merchantId}/ratings:
    get:
      tags:
        - CRM do parceiro
      summary: Avaliações
      description: >-
        Avaliações recebidas pela loja — nota, comentário, data e plataforma de
        origem. Cada item referencia a venda (saleId) e o cliente (customerId).
      operationId: listStoreRatings
      parameters:
        - $ref: '#/components/parameters/MerchantIdPath'
        - $ref: '#/components/parameters/CrmFrom'
        - $ref: '#/components/parameters/CrmTo'
        - $ref: '#/components/parameters/CrmCursor'
        - $ref: '#/components/parameters/CrmLimit'
      responses:
        '200':
          description: Página de avaliações do período.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingListResponse'
              example:
                items:
                  - ratingId: 7041
                    saleId: 1107300
                    customerId: 18452
                    stars: 5
                    review: Chegou quentinho, como sempre!
                    ratingDate: '2026-08-15T12:03:00+00:00'
                    integrationId: Ifood
                nextCursor: null
        '400':
          $ref: '#/components/responses/InvalidDateRange'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/MerchantNotFound'
components:
  parameters:
    MerchantIdPath:
      name: merchantId
      in: path
      required: true
      description: Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.
      schema:
        type: string
        format: uuid
    CrmFrom:
      name: from
      in: query
      description: Início do período (data, inclusive). Deve ser anterior ou igual a to.
      schema:
        type: string
        format: date
    CrmTo:
      name: to
      in: query
      description: Fim do período (data, inclusive).
      schema:
        type: string
        format: date
    CrmCursor:
      name: cursor
      in: query
      description: >-
        Cursor opaco da próxima página, retornado em nextCursor. Omita na
        primeira chamada.
      schema:
        type: string
    CrmLimit:
      name: limit
      in: query
      description: Itens por página. Valores acima de 500 são limitados a 500.
      schema:
        type: integer
        format: int32
        default: 100
        maximum: 500
  schemas:
    RatingListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              ratingId:
                type: integer
                format: int32
              saleId:
                type: integer
                format: int32
                description: >-
                  Venda avaliada — mesmo id (numérico) do pedido em GET
                  /od/v2/orders/{orderId}.
              customerId:
                type: integer
                format: int32
              stars:
                type: integer
                format: int32
              review:
                type: string
                nullable: true
              ratingDate:
                type: string
                format: date-time
              integrationId:
                type: string
                description: >-
                  Plataforma de origem da avaliação (ex. Ifood, AnotaAi,
                  Google).
        nextCursor:
          type: string
          nullable: true
          description: Cursor da próxima página. Null quando não há próxima página.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Código do erro (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND,
            INTERNAL_SERVER_ERROR).
        message:
          type: string
        details:
          type: array
          nullable: true
          description: Lista de mensagens de validação, quando aplicável.
          items:
            type: string
  responses:
    InvalidDateRange:
      description: from/to mal formatados, janela invertida ou cursor inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: BAD_REQUEST
            message: One or more validation errors occurred
            details:
              - from should be less than or equal to to
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: UNAUTHORIZED
            message: Invalid client credentials.
            details: null
    InsufficientScope:
      description: Token sem o escopo exigido pela rota.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: FORBIDDEN
            message: The access token does not have the required scope.
            details: null
    MerchantNotFound:
      description: Merchant inexistente ou fora do escopo da aplicação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: NOT_FOUND
            message: Merchant not found.
            details: null
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token de acesso emitido por POST /od/v2/oauth/token (fluxo
        client_credentials). Envie no header Authorization como `Bearer
        <token>`.

````