🔒

Requires write_comments access scope. More access scope

The Create Comment API allows users to add a comment to a specific product. This includes details such as user feedback, star ratings, images, and likes.This API is especially useful for:

1. Gathering customer feedback for products.
2. Displaying product reviews on the storefront.3. Tracking user engagement with ratings and comments.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Body Parameters

Response Explanation

Successful Response

Response Fields

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Request Examples

curl --request POST \
  --url https://{shopdomain}.myshoplaza.com/openapi/2022-01/comments \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'access-token: YOUR_ACCESS_TOKEN' \
  --data '{
    "product_id": "33f1b4f6-94...",
    "username": "Joey",
    "star": 5,
    "image": "http://abc.com/img.jpg;http://def.com/img.jpg",
    "like": 100,
    "created_at": "2019-07-10 15:00:00",
    "content": "Cheap but beautiful",
    "country": "CN"
  }'

Success Response Example

{
  "comment": {
    "id": 23532434,
    "store_id": 633130,
    "username": "Joey",
    "email": "",
    "star": "5.0",
    "like": 10,
    "content": "Cheap but beautiful",
    "img": "[\"https:\\/\\/photokit.com\\/features\\/images\\/image-text-after.webp\"]",
    "status": 1,
    "type": 1,
    "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
    "created_at": "2024-04-24 14:02:39",
    "updated_at": "2024-04-25 08:22:58",
    "country": "CN",
    "is_featured": 0,
    "is_verified": 0,
    "client_id": null,
    "anonymous": 0
  }
}

Error Response Example

{
  "error": "store is not active"
}

Error Details