快工助手跨境电商知识与商机助手
快工云仓服务介绍

v2.product.get_comment

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.product.get_comment

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

#

§2 Overview

Overview

FieldValue
ModuleProduct
API typeShop
HTTP methodGET
Path/api/v2/product/get_comment
Production URLhttps://partner.shopeemobile.com/api/v2/product/get_comment
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/product/get_comment
Rate limit[0,0,0]
PermissionERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Customized APP; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
item_idint64No16509872The identity of product item.
comment_idint64No120590834The identity of comment.
cursorstringYesSpecifies 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_sizeint32Yes10Each 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.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstring3e0976b06baa4e059b278ef1fdae1f01The identifier for an API request for error tracking.
errorstringcommon.error_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.morebooleanfalseThis 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".
response.item_comment_listobject[]The comment data list of the items.
response.item_comment_list.order_snstring200922CTK2J6KNShopee's unique identifier for an order.
response.item_comment_list.comment_idstring120590834The identity of comment.
response.item_comment_list.commentstringthank youThe content of the comment.
response.item_comment_list.buyer_usernamestringtomThe username of the buyer who posted the comment.
response.item_comment_list.item_idint6416509872The commented item's id
response.item_comment_list.model_idint640Shopee'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.
response.item_comment_list.rating_starint325Buyer's rating for the item.
response.item_comment_list.editablestringEDITABLEThe editable status of the comment. The value may be one of EXPIRED/EDITABLE/HAVE_EDIT_ONCE.
response.item_comment_list.hiddenbooleanfalseThe comment is hidden or not.
response.item_comment_list.create_timetimestamp1603153057The create time of the comment.
response.item_comment_list.comment_replyobjectThe reply of the comment.
response.item_comment_list.comment_reply.replystringThank you for your support. Look forward to your next visit.The content of reply.
response.item_comment_list.comment_reply.hiddenbooleanfalseThe comment reply is hidden or not.
response.item_comment_list.comment_reply.create_timetimestamp1712053073The time the seller replied to the comment.
response.item_comment_list.model_id_listint64[]List of model id of the buyer's purchase corresponding to the comment.
response.item_comment_list.mediaobject
response.item_comment_list.media.image_url_liststring[]List of image url uploaded by the buyer in the comment.
response.item_comment_list.media.video_url_liststring[]List of video url uploaded by the buyer in the comment.
response.next_cursorstring"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.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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
#

§6 Request samples

Request samples

#

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/product/get_comment?shop_id=shop_id&partner_id=partner_id&timestamp=timestamp&comment_id=120590834&page_size=10&item_id=16509872&access_token=access_token&sign=sign")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/product/get_comment?access_token=access_token&comment_id=120590834&item_id=16509872&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/product/get_comment?page_size=10&item_id=16509872&access_token=access_token&sign=sign&shop_id=shop_id&partner_id=partner_id&timestamp=timestamp&comment_id=120590834'
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/product/get_comment?access_token=access_token&comment_id=120590834&item_id=16509872&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
  "error": "",
  "message": "",
  "response": {
    "item_comment_list": [
      {
        "comment_id": 120590834,
        "comment": "Very nice",
        "buyer_username": "tom",
        "order_sn": "200922CTK2J6KN",
        "item_id": 16509872,
        "model_id": 0,
        "create_time": 1603153057,
        "rating_star": 5,
        "editable": "EDITABLE",
        "hidden": false,
        "cmt_reply": {
          "reply": "Thank you for your support. Look forward to your next visit.",
          "hidden": false
        }
      }
    ],
    "more": true,
    "next_cursor": "20"
  },
  "request_id": "3e0976b06baa4e059b278ef1fdae1f01"
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
    "error": "error_param",
    "message": "Wrong parameters, detail: page_size is a required field.",
    "request_id": "eb660538346ab05cdfcb86569dfc9262"
}
#

§15 Errors

Errors

ErrorDescriptionSolution
product.cmt_not_existThe comment is not exist. Please check the comment.
error_not_foundWrong parameters, detail: {msg}.
error_paramWrong parameters, detail: {msg}.
error_permissionSorry you don't have the permission, detail: {msg}.
error_serverSystem error. Please try again later.
product.get_cmt_failedGet comment failed. Please try again later.
product.item_cmt_combine_wrongItem id of cmt is not the same as item id get from param.
product.item_not_existItem (ID {item_id}) is not exist.
common.invalid_shopShop id is invalid. Please check your shop.
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
error_innerOur system is taking some time to respond, please try later.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_item_not_foundProduct not found
error_innerUpdate item failed {{.error_info}}
error_innerUpdate item failed {{.error_info}}
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_authYour shop can not use model level dts
error_system_busyOur system is taking some time to respond, please try later.
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§17 Update log

Update log

DateChange
2024-09-25add model_id_list, media > image_url_list, media > video_url_list, comment_reply > create_time response parameters
#