🔒
Requires read_comments access scope.

The Get Comment List API Retrieve a list of comments for a specific product or across multiple products, based on various filters.

This API is especially useful for:

Displaying product reviews on storefronts
Analyzing customer sentiment across products

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Cursor for pagination	`"abc123"`
`page_size`	int32	No	Limit per page (default: 20)	`50`
`product_id`	string	No	Filter comments by product ID	`"prod_12345"`
`created_at_min`	string	No	Filter comments created after this timestamp (YYYY-MM-DDTHH:mm:ssZ)	`"2025-01-01T00:00:00Z"`
`created_at_max`	string	No	Filter comments created before this timestamp (YYYY-MM-DDTHH:mm:ssZ)	`"2025-06-01T23:59:59Z"`
`updated_at_min`	string	No	Filter comments updated after this timestamp (YYYY-MM-DDTHH:mm:ssZ)	`"2025-05-01T00:00:00Z"`
`updated_at_max`	string	No	Filter comments updated before this timestamp (YYYY-MM-DDTHH:mm:ssZ)	`"2025-05-31T23:59:59Z"`
`sort_by`	string	No	Field to sort by (`star`, `created_at`, `like`)	`"star"`
`sort_direction`	string	No	Sort direction (`asc` or `desc`)	`"desc"`
`status`	string	No	Filter by comment status (`1` for published, `0` for unpublished)	`"1"`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"success"`	Status code of the response
`message`	string	`"Comments retrieved successfully"`	Operation result message
`data.comments`	array of comment object		List of comment objects
`data.comments[]. id`	integer	`12345`	Unique identifier for the comment
`data.comments[]. store_id`	integer	`67890`	ID of the store where comment was posted
`data.comments[]. user_name`	string	`"JohnDoe"`	User name who posted the comment
`data.comments[]. email`	string	`"john@example.com"`	Email of the commenter
`data.comments[]. star`	string	`"4"`	Rating provided by the user
`data.comments[]. like`	integer	`5`	Number of likes for the comment
`data.comments[]. content`	string	`"Great product!"`	Content of the comment
`data.comments[]. images`	array of strings	`["https://example. com/image1.jpg"]`	URLs of images attached to the comment
`data.comments[]. status`	integer	`1`	Status of the comment (`0`=unpublished, `1`=published)
`data.comments[]. type`	integer	`0`	Type of comment
`data.comments[]. product_id`	string	`"prod_12345"`	Product ID the comment belongs to
`data.comments[]. created_at`	string	`"2025-05-15T14:30:00Z"`	Timestamp when comment was created
`data.comments[]. updated_at`	string	`"2025-05-16T09:15:00Z"`	Timestamp when comment was last updated
`data.comments[]. country`	string	`"US"`	Country code of comment origin
`data.comments[]. is_featured`	integer	`0`	Whether comment is featured (`0`=no, `1`=yes)
`data.comments[]. is_verified`	integer	`1`	Whether comment is verified (`0`=no, `1`=yes)
`data.comments[]. client_id`	string	`"client_123"`	Client identifier
`data.comments[]. anonymous`	integer	`0`	Whether comment is anonymous (`0`=no, `1`=yes)
`data.comments[]. product_published`	integer	`1`	Whether product is published (`0`=no, `1`=yes)
`data.cursor`	string	`"next_page_token"`	Pagination cursor for next page
`data.has_more`	boolean	`true`	Whether more comments are available

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK