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

# List Reviews

> List marketplace product reviews, newest first unless `sortBy` says otherwise. Requires `reviews:read`.

Use `priority=unreplied` for a reply queue. `replyRestriction` is null when a reply will be accepted.



## OpenAPI

````yaml /openapi.json get /api/v1/reviews
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/reviews:
    get:
      tags:
        - reviews
      summary: List Reviews
      description: >-
        List marketplace product reviews, newest first unless `sortBy` says
        otherwise. Requires `reviews:read`.


        Use `priority=unreplied` for a reply queue. `replyRestriction` is null
        when a reply will be accepted.
      operationId: get_v1_reviews
      parameters:
        - name: organizationId
          in: query
          required: false
          description: >-
            Required for session auth. API keys already belong to one
            organization.
          schema:
            type: string
            maxLength: 160
        - name: q
          in: query
          required: false
          description: >-
            Search the comment, product name or SKU, marketplace item id, and
            review id.
          schema:
            type: string
            maxLength: 200
        - name: marketplace
          in: query
          required: false
          schema:
            type: string
            enum:
              - shopee
              - lazada
              - tiktok
              - shopify
              - zalora
              - amazon
              - ebay
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - open
              - replied
              - hidden
              - handoff
              - solicited
              - ineligible
        - name: priority
          in: query
          required: false
          description: >-
            `unreplied`: open reviews the marketplace allows a reply to.
            `negative`: rating of 3 or lower.
          schema:
            type: string
            enum:
              - unreplied
              - negative
        - name: store
          in: query
          required: false
          description: >-
            Comma-separated store (account) ids from `GET
            /api/v1/marketplaces/connected`.
          schema:
            type: string
            maxLength: 1000
        - name: productId
          in: query
          required: false
          description: >-
            A product or variant UUID. Includes reviews of the whole product
            family.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: sortBy
          in: query
          required: false
          description: >-
            Comma-separated sort keys: reviewed_desc, reviewed_asc, rating_desc,
            rating_asc, status_asc, status_desc, marketplace_asc,
            marketplace_desc, product_asc, product_desc. Defaults to
            reviewed_desc.
          schema:
            type: string
            maxLength: 200
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          required: false
          schema:
            default: 0
            type: integer
            minimum: 0
            maximum: 9007199254740991
      responses:
        '200':
          description: A page of reviews.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                    const: developer_v1
                  operationId:
                    type: string
                  status:
                    type: string
                    enum:
                      - accepted
                      - completed
                      - failed
                  jobId:
                    type: string
                  productId:
                    type: string
                  warnings:
                    type: array
                    items:
                      type: string
                  recommendations:
                    type: array
                    items:
                      type: string
                  links:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: string
                  data:
                    type: object
                    properties:
                      reviews:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            platform:
                              type: string
                              enum:
                                - shopee
                                - lazada
                                - tiktok
                                - shopify
                                - zalora
                                - amazon
                                - ebay
                            accountId:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Marketplace store id.
                            storeName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            productId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            productName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            productSku:
                              anyOf:
                                - type: string
                                - type: 'null'
                            productThumbnailUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                            orderId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            externalItemId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            externalReviewId:
                              type: string
                            externalOrderId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            kind:
                              type: string
                              enum:
                                - product_review
                                - solicitation
                              description: >-
                                `solicitation` rows are Amazon orders you can
                                send a review request for.
                            status:
                              type: string
                              enum:
                                - open
                                - replied
                                - hidden
                                - handoff
                                - solicited
                                - ineligible
                            rating:
                              anyOf:
                                - type: number
                                - type: 'null'
                            comment:
                              anyOf:
                                - type: string
                                - type: 'null'
                            sellerReply:
                              anyOf:
                                - type: string
                                - type: 'null'
                            sellerRepliedAt:
                              anyOf:
                                - type: string
                                - type: 'null'
                            canReply:
                              type: boolean
                              description: The marketplace's own reply eligibility flag.
                            replyRestriction:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Why a reply is not possible right now, or null
                                when `review.reply` will be accepted.
                            reviewedAt:
                              anyOf:
                                - type: string
                                - type: 'null'
                            marketplaceListingUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Public marketplace product page, when it can be
                                resolved.
                            sellerCenterUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                            firstSeenAt:
                              type: string
                            lastSeenAt:
                              type: string
                          required:
                            - id
                            - platform
                            - accountId
                            - storeName
                            - productId
                            - productName
                            - productSku
                            - productThumbnailUrl
                            - orderId
                            - externalItemId
                            - externalReviewId
                            - externalOrderId
                            - kind
                            - status
                            - rating
                            - comment
                            - sellerReply
                            - sellerRepliedAt
                            - canReply
                            - replyRestriction
                            - reviewedAt
                            - marketplaceListingUrl
                            - sellerCenterUrl
                            - firstSeenAt
                            - lastSeenAt
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      limit:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      offset:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      hasMore:
                        type: boolean
                      nextOffset:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                    required:
                      - reviews
                      - total
                      - limit
                      - offset
                      - hasMore
                      - nextOffset
                required:
                  - ok
                  - apiVersion
                  - operationId
                  - status
                  - warnings
                  - recommendations
                  - links
                  - data
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '403':
          description: Missing the `reviews:read` scope
        '429':
          description: Rate limit exceeded
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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