v2.account_health.get_punishment_history
GET /api/v2/account_health/get_punishment_history
Get the punishment records generated in the current quarter.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/account_health/get_punishment_history
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 |
|---|---|---|---|---|
| page_no | int32 | False | 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 | False | 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 | True | 1 | The status of punishment. Applicable values: 1: Ongoing 2: Ended |
Response Parameters
| Name | Type | 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 | ||
| punishment_list | object[] | The punishment records generated in the current quarter. | |
| issue_time | timestamp | The time when punishment are issued. | |
| start_time | timestamp | Start time in the duration of this punishment record. | |
| end_time | timestamp | End time in the duration of this punishment record. | |
| 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 | |
| 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 | |
| reference_id | int64 | Reference ID for this punishment record. | |
| 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 | |
| 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) | |
| total_count | int32 | Total number of punishment records. |