stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.reply_comment
Use this api to reply comments from buyers in batch.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/product/reply_comment |
| Production URL | https://partner.shopeemobile.com/api/v2/product/reply_comment |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/reply_comment |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| comment_list | object[] | Yes | The list of comment. The limit is between 1 and 100. | |
| comment_list.comment_id | int | Yes | 1540927 | The identity of comment. |
| comment_list.comment | string | Yes | Your smile is the direction of our efforts, welcome to your next visit! | The content of the comment. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| request_id | string | 3e0976b06baa4e059b278ef1fdae1f01 | The identifier for an API request for error tracking. | |
| error | string | product.duplicate_request | Indicate error type if hit error. Empty if no error happened. | |
| message | string | You has replied this comment already. | Indicate error details if hit error. Empty if no error happened. | |
| response | object | Detail informations you are querying. | ||
| response.result_list | object[] | The result list of the request comment list. | ||
| response.result_list.comment_id | int | 1540927 | The identity of comment. | |
| response.result_list.fail_error | string | product.error_not_exist | Indicate error details if one element hit error. | |
| response.result_list.fail_message | string | The Comment you replied does not exist. | Indicate error type if one element hit error. | |
| warning | string[] | ["14609238"] | Indicate warning message you should take care. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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 |
§6 Request samples
Request samples
§7 Payload
Payload
{
"comment_list": [
{
"comment_id": 1540927,
"comment": "Your smile is the direction of our efforts, welcome to your next visit!"
}
]
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"error": "",
"message": "",
"response": {
"result_list": [
{
"comment_id": 1540927
}
]
},
"request_id": "3e0976b06baa4e059b278ef1fdae1f01"
}
§10 Error example
Error example
§11 JSON
JSON
{
"error": "error_param",
"message": "Wrong parameters, detail: comment_list is a required field.",
"request_id": "5389f6ecf527b7a9d040f642fceb38a0"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| product.duplicate_request | You has replied this comment already. | |
| product.comment_length_invalid | Comment length should be between 1 and 500. Please update the comment. | |
| product.error_permission | Reply comment failed. Shop token invalid, please try to re-auth to partner. | |
| product.error_not_exist | The Comment you replied does not exist. | |
| product.duplicate_comment_id | Duplicate comment id { cmm_id}. | |
| error_not_found | Wrong parameters, detail: {msg}. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_permission | Sorry you don't have the permission, detail: {msg}. | |
| error_server | System error. Please try again later. | |
| product.get_token_failed | Get token failed. | |
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| error_inner | Our system is taking some time to respond, please try later. | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_item_not_found | Product not found | |
| error_inner | Update item failed {{.error_info}} | |
| error_inner | Update item failed {{.error_info}} | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_auth | Your shop can not use model level dts | |
| error_system_busy | Our system is taking some time to respond, please try later. |
§13 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App 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_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The 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_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The 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_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your 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_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
变化记录
相对上一发布版本,本文内容有变化。
本版没有改过这篇(或它是新增页),没有可比的上一版。
