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

# Listar avaliações

> Retorna a lista de avaliações do estabelecimento.



## OpenAPI

````yaml /reference/api-loja.json get /api/partner/v1/merchant/reviews
openapi: 3.1.0
info:
  title: API Loja
  version: '1.0'
  description: >-
    A API de loja é responsável por fornecer informações referentes ao
    estabelecimento.


    O limite de requições desse endpoint é diferente dos demais, sendo limitado
    a 5 requisições por minuto.
  contact:
    email: integracao@cardapioweb.com
    url: https://cardapioweb.com
    name: Cardápio Web
servers:
  - url: https://integracao.sandbox.cardapioweb.com
    description: Sandbox
  - description: Produção
    url: https://integracao.cardapioweb.com
security:
  - apiKey: []
tags:
  - name: Avaliações
  - name: Clientes
  - name: Cupons
  - name: Loja
paths:
  /api/partner/v1/merchant/reviews:
    parameters: []
    get:
      tags:
        - Avaliações
      summary: Listar avaliações
      description: Retorna a lista de avaliações do estabelecimento.
      operationId: get-reviews
      parameters:
        - schema:
            type: string
            format: date-time
            example: '2023-01-01T00:00:00-03:00'
          in: query
          name: start_date
          description: >-
            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.
        - schema:
            type: string
            example: '2023-06-30T23:59:59-03:00'
          in: query
          name: end_date
          description: >-
            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.
        - schema:
            type: number
            minimum: 1
            default: 1
          in: query
          name: page
        - schema:
            type: number
            default: 100
            minimum: 1
            maximum: 100
          in: query
          name: per_page
      responses:
        '200':
          description: Lista de avaliações retornada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  reviews:
                    type: array
                    description: Lista de avaliações retornadas.
                    items:
                      $ref: '#/components/schemas/Review'
                  pagination:
                    type: object
                    description: >-
                      Informações sobre a paginação dos resultados de
                      avaliações.
                    properties:
                      current_page:
                        type: integer
                        description: Página atual.
                      total_pages:
                        type: integer
                        description: Total de páginas disponíveis com os filtros aplicados.
                      total_reviews:
                        type: integer
                        description: >-
                          Total de avaliações encontradas com os filtros
                          aplicados.
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Review:
      title: Review
      x-stoplight:
        id: xw08izplnsluq
      type: object
      properties:
        id:
          type: integer
          x-stoplight:
            id: x6xr5nt95jr6z
          example: 564815
          description: Identificador único da avaliação.
        order_id:
          type: integer
          x-stoplight:
            id: ib76g20dwlvvk
          example: 958647521
          description: ID do pedido relacionado à avaliação.
        customer_id:
          type: integer
          x-stoplight:
            id: eh6ckhoqbm4pl
          example: 6589647
          description: ID do cliente que fez a avaliação.
        rating:
          type: number
          x-stoplight:
            id: vqfguw0l7x5dx
          format: float
          example: 5
          minimum: 1
          maximum: 5
          description: Média das notas dadas pelo cliente.
        comment:
          type: string
          x-stoplight:
            id: d8ou6wws985hr
          example: Deu tudo certo!
          description: Comentário adicional fornecido pelo cliente.
        created_at:
          type: string
          x-stoplight:
            id: krkl18ihpwwdo
          format: date-time
          example: '2025-05-07T15:45:45.393-03:00'
          description: Data e hora em que a avaliação foi registrada.
        answers:
          type: array
          x-stoplight:
            id: 7wwkno2oeb2pl
          description: Lista de respostas para perguntas específicas da pesquisa.
          items:
            x-stoplight:
              id: vlr5nztft5mrz
            type: object
            properties:
              question_id:
                type: integer
                x-stoplight:
                  id: uz0vimvuotqus
                example: 239
                description: ID da pergunta respondida.
              question:
                type: string
                x-stoplight:
                  id: wkk5w9d3f92ho
                example: Atendimento
                description: Descrição da pergunta respondida.
              answer:
                type: string
                x-stoplight:
                  id: uuggm86m8u827
                example: '5'
                description: Resposta fornecida para a pergunta.
    Unauthorized:
      type: object
      x-stoplight:
        id: 43a37f11m9auy
      examples:
        - code: 4010
          message: Token inválido
      title: Unauthorized
      x-internal: false
      properties:
        code:
          type: integer
          description: Código interno de identificação do erro
        message:
          type: string
          description: Mensagem de resumo do erro
      required:
        - code
        - message
  responses:
    Unauthorized:
      description: >-
        Não autorizado. Não foi enviado o token no header "X-API-KEY" ou ele é
        inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
  securitySchemes:
    apiKey:
      name: X-API-KEY
      type: apiKey
      in: header
      description: >-
        Token específico do estabelecimento integrado. Disponível na seção de
        integrações do Portal do estabelecimento.

````