v2.product.get_comment

GET /api/v2/product/get_comment

Use this api to get comment by shop_id, item_id, or comment_id, get up to 1000 comments.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/product/get_comment

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
item_id	int64	False	16509872	The identity of product item.
comment_id	int64	False	120590834	The identity of comment.
cursor	string	True		Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
page_size	int32	True	10	Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.

Response Parameters

Name	Type	Sample	Description
request_id	string	3e0976b06baa4e059b278ef1fdae1f01	The identifier for an API request for error tracking.
error	string	common.error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid access_token.	Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
more	boolean	false	This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments. But only respond 500 comments at most through OpenAPI, if there are more than 500, this field "more" also respond "true".
item_comment_list	object[]		The comment data list of the items.
order_sn	string	200922CTK2J6KN	Shopee's unique identifier for an order.
comment_id	string	120590834	The identity of comment.
comment	string	thank you	The content of the comment.
buyer_username	string	tom	The username of the buyer who posted the comment.
item_id	int64	16509872	The commented item's id
model_id	int64	0	Shopee's unique identifier for a model of an item. It will only return 0 now. Will be offline on 2024-12-27, please switch to use model_id_list.
rating_star	int32	5	Buyer's rating for the item.
editable	string	EDITABLE	The editable status of the comment. The value may be one of EXPIRED/EDITABLE/HAVE_EDIT_ONCE.
hidden	boolean	false	The comment is hidden or not.
create_time	timestamp	1603153057	The create time of the comment.
comment_reply	object		The reply of the comment.
reply	string	Thank you for your support. Look forward to your next visit.	The content of reply.
hidden	boolean	false	The comment reply is hidden or not.
create_time	timestamp	1712053073	The time the seller replied to the comment.
model_id_list	int64[]		List of model id of the buyer's purchase corresponding to the comment.
media	object
image_url_list	string[]		List of image url uploaded by the buyer in the comment.
video_url_list	string[]		List of video url uploaded by the buyer in the comment.
next_cursor	string	"20"	If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.