post
https://{subdomain}.myshoplaza.com/openapi/2025-06/comments
Allows users to add a comment to a specific product.
Requireswrite_commentsaccess scope.
The Create Comment API enables adding a comment to a specific product.
This API is especially useful for:
- Enabling customer feedback on products.
- Collecting product ratings and reviews.
- Building social proof through user-generated content.
- Gathering customer insights through comments.
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
comment | object | Yes | The comment object containing all comment details | - |
comment.product_id | string | Yes | Product's ID to which the comment belongs | "prod_12345" |
comment.user_name | string | Yes | User name who posted the comment | "JohnDoe" |
comment.star | int32 | Yes | Rating provided by the user (range: 1 to 5) | 4 |
comment.like | int32 | Yes | Number of likes for the comment | 0 |
comment.created_at | string | Yes | Timestamp when the comment was created (YYYY-MM-DD HH:mm:ss) | "2025-06-01 14:30:00" |
comment.content | string | Yes | Content of the comment | "Great product quality!" |
comment.country | string | No | Country code where the comment was created from | "US" |
comment.images | array of strings | No | URLs of images attached to the comment | ["https://example.com/image1.jpg", "https://example.com/image2.jpg"] |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | Descriptive message of the response | |
data.comment.id | integer | 12345 | Unique identifier for the comment |
data.comment.store_id | integer | 67890 | ID of the store where comment was posted |
data.comment.user_name | string | "JohnDoe" | User name who posted the comment |
data.comment.email | string | "[email protected]" | Email of the commenter |
data.comment.star | string | "4" | Rating provided by the user |
data.comment.like | integer | 0 | Number of likes for the comment |
data.comment.content | string | "Great product quality!" | Content of the comment |
data.comment.images | array of strings | ["https://example. com/image1.jpg"] | URLs of images attached to the comment |
data.comment.status | integer | 1 | Status of the comment (0/1) |
data.comment.type | integer | 0 | Type of comment |
data.comment.product_id | string | "prod_12345" | Product ID the comment belongs to |
data.comment.created_at | string | "2025-06-01 14:30:00" | Timestamp when comment was created |
data.comment.updated_at | string | "2025-06-01 14:30:00" | Timestamp when comment was last updated |
data.comment.country | string | "US" | Country code of comment origin |
data.comment.is_featured | integer | 0 | Whether comment is featured (0/1) |
data.comment.is_verified | integer | 0 | Whether comment is verified (0/1) |
data.comment.client_id | string | "client_123" | Client identifier |
data.comment.anonymous | integer | 0 | Whether comment is anonymous (0/1) |
data.comment.product_published | integer | 1 | Whether product is published (0/1) |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |