> ## 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.

# Reply to Review

> Reply to one review identified by its OmniCommerce UUID in the URL. Requires `reviews:write`. Supply `reply` or set `generateWithAi: true`. `submit` defaults to true; set false with AI generation to return a draft without posting. Optional `instructions` guide AI writing. AI generation uses organization AI credits.

Read `data.submitted` for confirmed marketplace submission. Generated text is retained when submission fails. Unsupported marketplaces return their capability limitation. Check review state before retrying an unconfirmed submission. Amazon review requests are separate.



## OpenAPI

````yaml /openapi.json post /api/v1/reviews/{reviewId}/reply
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: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - 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/{reviewId}/reply:
    post:
      tags:
        - reviews
      summary: Reply to Review
      description: >-
        Reply to one review identified by its OmniCommerce UUID in the URL.
        Requires `reviews:write`. Supply `reply` or set `generateWithAi: true`.
        `submit` defaults to true; set false with AI generation to return a
        draft without posting. Optional `instructions` guide AI writing. AI
        generation uses organization AI credits.


        Read `data.submitted` for confirmed marketplace submission. Generated
        text is retained when submission fails. Unsupported marketplaces return
        their capability limitation. Check review state before retrying an
        unconfirmed submission. Amazon review requests are separate.
      operationId: post_v1_reviews_by_reviewid_reply
      parameters:
        - name: reviewId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reply:
                  description: >-
                    Seller reply to send to this review. Omit when
                    generateWithAi is true.
                  type: string
                  minLength: 1
                  maxLength: 500
                generateWithAi:
                  default: false
                  description: >-
                    Generate a reply using the review context and organization
                    brand voice. Uses AI credits.
                  type: boolean
                submit:
                  default: true
                  description: >-
                    true submits the reply to the marketplace. With
                    generateWithAi, false returns a draft without submitting.
                  type: boolean
                instructions:
                  description: >-
                    Optional writing instructions for AI-generated replies.
                    Requires generateWithAi.
                  type: string
                  minLength: 1
                  maxLength: 2000
                organizationId:
                  description: >-
                    Required for session auth. API keys already belong to one
                    organization.
                  type: string
                  minLength: 1
                  maxLength: 160
              additionalProperties: false
      responses:
        '200':
          description: The reply or draft result for this review.
          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:
                      success:
                        type: boolean
                      reviewId:
                        type: string
                      submitted:
                        type: boolean
                        description: >-
                          True only when the marketplace reply service confirms
                          success. False for a draft or unconfirmed submission.
                      reply:
                        type: string
                      model:
                        type: string
                      error:
                        type: string
                      sellerCenterUrl:
                        type: string
                    required:
                      - success
                      - reviewId
                      - submitted
                required:
                  - ok
                  - apiVersion
                  - operationId
                  - status
                  - warnings
                  - recommendations
                  - links
                  - data
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '403':
          description: Missing the `reviews:write` 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.