stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.account_health.get_penalty_point_history
Get the penalty point records generated in the current quarter.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | AccountHealth |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/account_health/get_penalty_point_history |
| Production URL | https://partner.shopeemobile.com/api/v2/account_health/get_penalty_point_history |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/account_health/get_penalty_point_history |
| Permission | ERP System; Seller In House System; Product Management; Order Management; Customized APP; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| page_no | int32 | No | 1 | Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.; Default is 1. |
| page_size | int32 | No | 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), and the "page_no" to start next 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. Default is 10. |
| violation_type | int64 | No | 5 | Applicable values: 5: High Late Shipment Rate; 6: High Non-fulfilment Rate; 7: High number of non-fulfilled orders; 8: High number of late shipped orders; 9: Prohibited Listings; 10: Counterfeit / IP infringement; 11: Spam; 12: Copy/Steal images; 13: Re-uploading deleted listings with no change; 14: Bought counterfeit from mall; 15: Counterfeit caught by Shopee; 16: High percentage of pre-order listings; 17: Confirmed Fraud attempts (total); 18: Confirmed Fraud attempts per week (All with vouchers only); 19: Fake return address; 20: Shipping fraud/abuse; 21: High No. of Non-responded Chat; 22: Rude chat replies; 23: Request buyer to cancel order; 24: Rude reply to buyer's review; 25: Violate Return/Refund policy; 101: Tier Reason; 3026: Misuse of Shopee’s IP; 3028: Violate Shop Name Regulations; 3030: Direct transactions outside of the Shopee platform; 3032: Shipping empty / incomplete parcels; 3034: Severe Violations on Shopee Feed; 3036: Severe Violations on Shopee LIVE; 3038: Misuse of Local Vendor Tag; 3040: Use of misleading shop tag in listing image; 3042: Counterfeit / IP Infringement test; 3044: Repeat Offender - IP infringement and Counterfeit listings; 3046: Violation of Live Animals Selling Policy; 3048: Chat Spam; 3050: High Overseas Return Refunds Rate; 3052: Privacy breach in buyer's review reply; 3054: Order Brushing; 3056: porn image; 3058: Incorrect Product Categories; 3060: Extremely High Non-Fulfilment Rate; 3062: Penalty of Affiliate Marketing Solution (AMS) Overdue Invoice Payment; 3064: Government-related listing; 3066: Listing invalid gifted items; 3068: High non-fulfilment rate (Next Day Delivery Orders); 3070: High Late Shipment Rate (Next Day Delivery Orders); 3072: OPFR Violation Value; 3074: Direct transactions outside Shopee platform via chat; 3090: Prohibited Listings-Extreme Violations; 3091: Prohibited Listings-High Violations; 3092: Prohibited Listings-Mid Violations; 3093: Prohibited Listings-Low Violations; 3094: Counterfeit Listings-Extreme Violations; 3095: Counterfeit Listings-High Violations; 3096: Counterfeit Listings-Mid Violations; 3097: Counterfeit Listings-Low Violations; 3098: Spam Listings-Extreme Violations; 3099: Spam Listings-High Violations; 3100: Spam Listings-Mid Violations; 3101: Spam Listings-Low Violations; 3145: Return/Refund Rate (Non-integrated Channel); 4130: Poor Product Quality |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| request_id | string | The identifier for an API request for error tracking. | ||
| response | object | |||
| response.penalty_point_list | object[] | The penalty point records generated in the current quarter. | ||
| response.penalty_point_list.issue_time | timestamp | 1728552398 | The time when penalty points are issued. | |
| response.penalty_point_list.latest_point_num | int32 | 0 | The latest penalty points issued under current penalty point record.; If seller raised appeal for this penalty point record and the appeal has been approved and Shopee adjusted the penalty point, then the original_point_num returns the penalty point before the adjustment, and latest_point_num returns the penalty point after the adjustment. | |
| response.penalty_point_list.original_point_num | int32 | 1 | The original penalty points issued under current penalty point record.; If seller raised appeal for this penalty point record and the appeal has been approved and Shopee adjusted the penalty point, then the original_point_num returns the penalty point before the adjustment, and latest_point_num returns the penalty point after the adjustment. | |
| response.penalty_point_list.reference_id | int64 | 764539404640322244 | Reference ID for this penalty point record. | |
| response.penalty_point_list.violation_type | int32 | 5 | Applicable values: 5: High Late Shipment Rate; 6: High Non-fulfilment Rate; 7: High number of non-fulfilled orders; 8: High number of late shipped orders; 9: Prohibited Listings; 10: Counterfeit / IP infringement; 11: Spam; 12: Copy/Steal images; 13: Re-uploading deleted listings with no change; 14: Bought counterfeit from mall; 15: Counterfeit caught by Shopee; 16: High percentage of pre-order listings; 17: Confirmed Fraud attempts (total); 18: Confirmed Fraud attempts per week (All with vouchers only); 19: Fake return address; 20: Shipping fraud/abuse; 21: High No. of Non-responded Chat; 22: Rude chat replies; 23: Request buyer to cancel order; 24: Rude reply to buyer's review; 25: Violate Return/Refund policy; 101: Tier Reason; 3026: Misuse of Shopee’s IP; 3028: Violate Shop Name Regulations; 3030: Direct transactions outside of the Shopee platform; 3032: Shipping empty / incomplete parcels; 3034: Severe Violations on Shopee Feed; 3036: Severe Violations on Shopee LIVE; 3038: Misuse of Local Vendor Tag; 3040: Use of misleading shop tag in listing image; 3042: Counterfeit / IP Infringement test; 3044: Repeat Offender - IP infringement and Counterfeit listings; 3046: Violation of Live Animals Selling Policy; 3048: Chat Spam; 3050: High Overseas Return Refunds Rate; 3052: Privacy breach in buyer's review reply; 3054: Order Brushing; 3056: porn image; 3058: Incorrect Product Categories; 3060: Extremely High Non-Fulfilment Rate; 3062: Penalty of Affiliate Marketing Solution (AMS) Overdue Invoice Payment; 3064: Government-related listing; 3066: Listing invalid gifted items; 3068: High non-fulfilment rate (Next Day Delivery Orders); 3070: High Late Shipment Rate (Next Day Delivery Orders); 3072: OPFR Violation Value; 3074: Direct transactions outside Shopee platform via chat; 3090: Prohibited Listings-Extreme Violations; 3091: Prohibited Listings-High Violations; 3092: Prohibited Listings-Mid Violations; 3093: Prohibited Listings-Low Violations; 3094: Counterfeit Listings-Extreme Violations; 3095: Counterfeit Listings-High Violations; 3096: Counterfeit Listings-Mid Violations; 3097: Counterfeit Listings-Low Violations; 3098: Spam Listings-Extreme Violations; 3099: Spam Listings-High Violations; 3100: Spam Listings-Mid Violations; 3101: Spam Listings-Low Violations; 3145: Return/Refund Rate (Non-integrated Channel); 4130: Poor Product Quality | |
| response.total_count | int32 | 8 | Total number of penalty point records. |
§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 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/account_health/get_penalty_point_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp&violation_type=5")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/account_health/get_penalty_point_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp&violation_type=5',
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/account_health/get_penalty_point_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp&violation_type=5'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/account_health/get_penalty_point_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp&violation_type=5"
payload={}
headers = {
}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{
"error": "",
"message": "",
"request_id": "e3e3e7f32548a9975af4ea6b51bd3c01:01000278f354dc17:00000049413a0a7b",
"response": {
"penalty_point_list": [
{
"issue_time": 1728634527,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 764883879797459160,
"violation_type": 12
},
{
"issue_time": 1728633960,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 764881498321979246,
"violation_type": 3064
},
{
"issue_time": 1728633764,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 764880677236639231,
"violation_type": 13
},
{
"issue_time": 1728552596,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 764540236400165696,
"violation_type": 3072
},
{
"issue_time": 1728552398,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 764539404640322244,
"violation_type": 23
},
{
"issue_time": 1728552246,
"latest_point_num": 3,
"original_point_num": 3,
"reference_id": 764538765474529390,
"violation_type": 13
},
{
"issue_time": 1728489600,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 17286145180003722,
"violation_type": 24
},
{
"issue_time": 1728489600,
"latest_point_num": 1,
"original_point_num": 1,
"reference_id": 17286145690002512,
"violation_type": 24
}
],
"total_count": 8
}
}
§13 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| 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 |
§14 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. |
§15 Update log
Update log
| Date | Change |
|---|---|
| 2025-05-08 | Add 4130: Poor Product Quality option for violation_type request and response parameter |
| 2024-11-05 | New API |
