The Comment object represents user-generated reviews or feedback associated with products in the system. Comments include essential details such as ratings, content, images, and metadata to enhance customer engagement and provide insights for product improvement.
Requires
commentsaccess scope.
Comment properties
| Field | Type | Desc | |
|---|---|---|---|
| id | string | ||
| store_id | string | Store ID | |
| product_id | string | ID of the reviewed product | |
| user_name | string | Username | |
| string | |||
| country | string | Country | |
| star | integer | Rating stars | |
| image | string | Links to review images, separated by ';', maximum of five images supported. | |
| like | integer | Number of likes | |
| is_featured | string | Whether it's featured ("0" or "1") | |
| is_verified | string | Whether it's verified ("0" or "1") | |
| client_id | string | Client ID | |
| anonymous | integer | Whether it's anonymous (0 for real name, 1 for anonymous) | |
| created_at | string (ISO-8601) | Review creation time | |
| updated_at | string (ISO-8601) | Last modification time |
Example
{
"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
}
Key Use Cases for the Comment Object:
-
Create Comment API
Allows users to submit individual product reviews, including a star rating, images, and textual feedback, directly linked to a product. -
Batch Comment API
Enables bulk submission of multiple comments at once, optimizing workflows for importing or updating reviews during system migrations or data imports. -
Get Comment List API
Retrieves a list of comments for a specific product or multiple products, filtered and sorted by parameters such as creation date, star rating, and status.