v2.account_health.get_punishment_history

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

来自 Shopee 官方资料快照 · 2026-09-06 12:10:14

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.account_health.get_punishment_history

Get the punishment 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_punishment_history
Production URL	https://partner.shopeemobile.com/api/v2/account_health/get_punishment_history
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/account_health/get_punishment_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.
punishment_status	int32	Yes	1	The status of punishment. Applicable values: 1: Ongoing; 2: Ended

§4 Response parameters

Response parameters

Name	Type	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.punishment_list	object[]	The punishment records generated in the current quarter.
response.punishment_list.issue_time	timestamp	The time when punishment are issued.
response.punishment_list.start_time	timestamp	Start time in the duration of this punishment record.
response.punishment_list.end_time	timestamp	End time in the duration of this punishment record.
response.punishment_list.punishment_type	int32	Punishment Type of this punishment record. Applicable values: 103: Listings not displayed in category browsing 104: Listings not displayed in search 105: Unable to create new listings 106: Unable to edit listings 107: Unable to join marketing campaigns 108: No shipping subsidies 109: Account is suspended 600: Listings not displayed in search 601: Shop listings hide from recommendation 602: Listings not displayed in category browsing 1109: Listing Limit is reduced 1110: Listing Limit is reduced 1111: Listing Limit is reduced 1112: Listing Limit is reduced; 2008: Order Limit
response.punishment_list.reason	int32	Reason of this punishment record. Applicable values: 1: Tier 1; 2: Tier 2; 3: Tier 3; 4: Tier 4; 5: Tier 5; 1109: Listing Limit Tier 1; 1110: Listing Limit Tier 2; 1111: Listing Limit POL
response.punishment_list.reference_id	int64	Reference ID for this punishment record.
response.punishment_list.listing_limit	int32	Return the specific value of listing limit when punishment_type is: 1109: Listing Limit is reduced 1110: Listing Limit is reduced 1111: Listing Limit is reduced 1112: Listing Limit is reduced
response.punishment_list.order_limit	string	Return the specific percentage of order limit when punishment_type is: 2008: Order Limit; Daily Order Limit = X % * L28D ADO (Average Daily Order of this Shop in Past 28 Days)
response.total_count	int32	Total number of punishment records.

§5 Common parameters

Common 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

§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_punishment_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&punishment_status=1&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/account_health/get_punishment_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&punishment_status=1&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/account_health/get_punishment_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&punishment_status=1&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/account_health/get_punishment_history?access_token=access_token&page_no=1&page_size=10&partner_id=partner_id&punishment_status=1&shop_id=shop_id&sign=sign&timestamp=timestamp"

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": "e3e3e7f32548e92b41e998f5fdaaa601:0100028f2ced96f3:0000004e400ff9e3",
    "response": {
        "punishment_list": [
            {
                "end_time": 1731053730,
                "issue_time": 1728634530,
                "punishment_type": 1110,
                "reason": 1110,
                "reference_id": 764883890656512286,
                "start_time": 1728634530
            },
            {
                "end_time": 1731053161,
                "issue_time": 1728633961,
                "punishment_type": 602,
                "reason": 3,
                "reference_id": 764881502478534572,
                "start_time": 1728633961
            },
            {
                "end_time": 1731053161,
                "issue_time": 1728633961,
                "punishment_type": 108,
                "reason": 3,
                "reference_id": 764881502478534575,
                "start_time": 1728633961
            },
            {
                "end_time": 1731053161,
                "issue_time": 1728633961,
                "punishment_type": 107,
                "reason": 3,
                "reference_id": 764881502478534574,
                "start_time": 1728633961
            },
            {
                "end_time": 1730971452,
                "issue_time": 1728552252,
                "punishment_type": 1109,
                "reason": 1109,
                "reference_id": 764538790430638657,
                "start_time": 1728552252
            }
        ],
        "total_count": 5
    }
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "PARAMS_ERROR",
    "message": "'punishment_status' is a required property",
    "request_id": "e3e3e7f325ac9294b62375ce08e27201:0100026e5409c516:00000003fc419ab2",
    "response": null
}

§15 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

§16 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.

§17 Update log

Update log

Date	Change
2025-02-28	Add order_limit and listing_limit
2024-11-05	Update the api name to remove space
2024-11-05	New API

这条内容对你有帮助吗？