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

# List reviews

> The reviews left on the store's orders, a page at a time, newest first. A buyer leaves one for a paid order; an order nobody reviewed is given five stars by itself after seven days. `meta.summary` is the whole store's average and counts, whatever the filters. A review the store flagged for removal carries `flag`: how it stands (`open`, or `kept` with the answer given) and why it was flagged. One that was removed is no longer listed.

Needs the `reviews.read` permission (Read Reviews).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/reviews
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/reviews:
    get:
      tags:
        - Reviews
      summary: List reviews
      description: >-
        The reviews left on the store's orders, a page at a time, newest first.
        A buyer leaves one for a paid order; an order nobody reviewed is given
        five stars by itself after seven days. `meta.summary` is the whole
        store's average and counts, whatever the filters. A review the store
        flagged for removal carries `flag`: how it stands (`open`, or `kept`
        with the answer given) and why it was flagged. One that was removed is
        no longer listed.


        Needs the `reviews.read` permission (Read Reviews).
      operationId: reviews.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Which page of the list. The first is 1.
          schema:
            type: integer
            default: 1
        - name: perPage
          in: query
          required: false
          description: How many a page holds.
          schema:
            type: integer
            default: 20
        - name: rating
          in: query
          required: false
          description: 'Only reviews of this many stars: 1 to 5.'
          schema:
            type: integer
        - name: type
          in: query
          required: false
          description: Only reviews a buyer wrote, or only the ones given by themselves.
          schema:
            type: string
            enum:
              - buyer
              - automatic
        - name: search
          in: query
          required: false
          description: A buyer's email, an order's ID, or words from a review.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        rating:
                          type: integer
                        message:
                          type: string
                        automatic:
                          type: boolean
                        dateCreated:
                          type: string
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              productId:
                                type: string
                              productName:
                                type: string
                              variantName:
                                type: string
                        orderId:
                          type: string
                        customerId:
                          type: string
                        email:
                          type: string
                        orderAmount:
                          type: number
                        currencyCode:
                          type: string
                        flag:
                          type: object
                          properties:
                            id:
                              type: string
                            status:
                              type: string
                            reason:
                              type: string
                            reasonLabel:
                              type: string
                            note:
                              type: string
                            answer:
                              type: string
                            dateCreated:
                              type: string
                            dateDecided:
                              nullable: true
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          count:
                            type: integer
                          average:
                            type: integer
                          automatic:
                            type: integer
                          stars:
                            type: object
                            properties:
                              '1':
                                type: integer
                              '2':
                                type: integer
                              '3':
                                type: integer
                              '4':
                                type: integer
                              '5':
                                type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 3d3b35b8-90cf-4518-9708-cffaf2bec8f8
                    rating: 2
                    message: The key took an hour to arrive.
                    automatic: false
                    dateCreated: '2026-10-22T16:20:19Z'
                    items:
                      - productId: f463e265-097a-4235-bc2f-5239b19a9874
                        productName: Northwind Pro
                        variantName: 1 month
                    orderId: eab50b8e-fca6-4712-9b55-2f910b4bddf0
                    customerId: f637fc21-973d-43ec-a7db-f819a9ebf73a
                    email: ada@example.com
                    orderAmount: 9.99
                    currencyCode: USD
                    flag:
                      id: cd0fdab5-1d06-4cf3-aab4-7538db0aeaaf
                      status: open
                      reason: unrelated
                      reasonLabel: Not about this order
                      note: This is about another shop's delivery, not ours.
                      answer: ''
                      dateCreated: '2026-10-22T16:20:19Z'
                      dateDecided: null
                pages: 1
                total: 1
                meta:
                  summary:
                    count: 1
                    average: 2
                    automatic: 0
                    stars:
                      '1': 0
                      '2': 1
                      '3': 0
                      '4': 0
                      '5': 0
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const page = await shoply.reviews.list();

            // Or every row of every page:
            for await (const row of shoply.reviews.list()) {
              console.log(row);
            }
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $page = $shoply->reviews->list();

            // Or every row of every page:
            foreach ($shoply->reviews->list() as $row) {
                print_r($row);
            }
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.reviews.list()

            # Or every row of every page:
            for row in client.reviews.list():
                print(row)
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.