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

# Reply to a review

> Writes the store's reply to a review, shown under it on the store, to its buyer on their order's page, and on the dashboard. A review has one reply: sent again, it takes the place of the one there. Plain words, line breaks kept.

Refused for an automatic review, which has no words to reply to (`automatic_review`). The buyer is not emailed. Answers the review as [List reviews](/api-reference/reviews/list-reviews) has it, with `reply`.

Needs the `reviews.write` permission (Reply to Reviews).



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/reviews/{reviewId}/reply
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: Teams
  - name: Blacklist
  - name: Allowlist
  - 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/{reviewId}/reply:
    put:
      tags:
        - Reviews
      summary: Reply to a review
      description: >-
        Writes the store's reply to a review, shown under it on the store, to
        its buyer on their order's page, and on the dashboard. A review has one
        reply: sent again, it takes the place of the one there. Plain words,
        line breaks kept.


        Refused for an automatic review, which has no words to reply to
        (`automatic_review`). The buyer is not emailed. Answers the review as
        [List reviews](/api-reference/reviews/list-reviews) has it, with
        `reply`.


        Needs the `reviews.write` permission (Reply to Reviews).
      operationId: reviews.reply
      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: reviewId
          in: path
          required: true
          description: The review, by its `id`.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  description: The reply, up to 1,000 characters.
              required:
                - message
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      review:
                        type: object
                        properties:
                          id:
                            type: string
                          rating:
                            type: integer
                          message:
                            type: string
                          automatic:
                            type: boolean
                          imported:
                            type: boolean
                          dateCreated:
                            type: string
                          reply:
                            type: object
                            properties:
                              message:
                                type: string
                              dateReplied:
                                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
              example:
                success: true
                message: null
                code: null
                data:
                  review:
                    id: f9fab83f-7dfc-43bf-9e17-e2e25da1a491
                    rating: 2
                    message: The key took an hour to arrive.
                    automatic: false
                    imported: false
                    dateCreated: '2026-10-28T10:47:39Z'
                    reply:
                      message: >-
                        Sorry about the wait. A payment provider was slow that
                        afternoon, and we have added a second one since.
                      dateReplied: '2026-10-28T10:47:39Z'
                    items:
                      - productId: 1ca55f9c-07c6-4ef0-9857-f53b28980e86
                        productName: Northwind Pro
                        variantName: 1 month
                    orderId: 0bc856cf-ab60-4545-81fa-296427554704
                    customerId: e769833c-bc29-4074-b692-33d505674dac
                    email: ada@example.com
                    orderAmount: 9.99
                    currencyCode: USD
                    flag:
                      id: 989dd588-cc55-4627-92c2-3fe3df1f6330
                      status: open
                      reason: unrelated
                      reasonLabel: Not about this order
                      note: This is about another shop's delivery, not ours.
                      answer: ''
                      dateCreated: '2026-10-28T10:47:39Z'
                      dateDecided: null
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '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 result = await shoply.reviews.reply("REVIEW_ID", {
              message: "...",
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->reviews->reply('REVIEW_ID', [
                'message' => '...',
            ]);
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.reviews.reply("REVIEW_ID", message="...")
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  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'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      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.