stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.get_item_violation_info
get item violation info
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/product/get_item_violation_info |
| Production URL | https://partner.shopeemobile.com/api/v2/product/get_item_violation_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/get_item_violation_info |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| item_id_list | int[] | Yes | [34001,34002] | item_id list; limit [0,50] |
§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. | ||
| warning | string | Indicate waring details if hit waring. Empty if no waring happened. | ||
| request_id | string | The identifier for an API request for error tracking. | ||
| response | object | |||
| response.item_list | object[] | |||
| response.item_list.item_id | int | 3400133011 | Shopee's unique identifier for an item. | |
| response.item_list.item_name | string | test | Name of the item. | |
| response.item_list.item_status | string | BANNED | Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING. | |
| response.item_list.deboost | boolean | true | If deboost is true, means that the item's search ranking is lowered. | |
| response.item_list.item_status_details | object[] | |||
| response.item_list.item_status_details.violation_type | string | Prohibited Listing | Violation types defined by Shopee. Applicable values: Prohibited Listing; Counterfeit and IP Infringement; Spam; Inappropriate Image; Insufficient Information; Mall Listing Improvement; Other Listing Improvement | |
| response.item_list.item_status_details.violation_reason | string | License Reason | The reason for violation. | |
| response.item_list.item_status_details.suggestion | string | Upload license | Shopee provides you with suggestions for modifying items. | |
| response.item_list.item_status_details.fix_deadline_time | timestamp | 1705227588 | Action required deadline. Empty if no deadline. | |
| response.item_list.item_status_details.update_time | timestamp | 1705054788 | Latest update time. | |
| response.item_list.deboost_details | object[] | |||
| response.item_list.deboost_details.violation_type | string | Prohibited Listing | Violation types defined by Shopee. Applicable values: Prohibited Listing; Counterfeit and IP Infringement; Spam; Inappropriate Image; Insufficient Information; Mall Listing Improvement; Other Listing Improvement | |
| response.item_list.deboost_details.violation_reason | string | Wrong Category | The reason for violation. | |
| response.item_list.deboost_details.suggestion | string | The item is in wrong category, please update to the suggested_category | Shopee provides you with suggestions for modifying items. | |
| response.item_list.deboost_details.suggested_category | object[] | |||
| response.item_list.deboost_details.suggested_category.category_id | int | 107478 | ID for Shopee suggested category. | |
| response.item_list.deboost_details.suggested_category.category_name | string | Personal Care | Default name for Shopee suggested category. | |
| response.item_list.deboost_details.fix_deadline_time | timestamp | 1705202227 | Action required deadline. Empty if no deadline. | |
| response.item_list.deboost_details.update_time | timestamp | 1704943027 | Latest update time. | |
| response.item_list.fail_error | string | Indicate error type if one element hit error. | ||
| response.item_list.fail_message | string | Indicate error details if one element hit error. |
§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 Response sample
Response sample
§7 JSON
JSON
{
"message": null,
"request_id": "3cc224310e5b57eeb70a9b202ba5d341",
"response":{
"item_list":[
{
"item_id": 800903588,
"item_name":"testing product",
"item_status":"BANNED",
"deboost":true,
"item_status_details":[
{
"violation_type":"Prohibited Listing",
"violation_reason":"License Reason",
"suggestion":"Upload license",
"update_time": 1705054788,
"fix_deadline_time": 1705227588
}
],
"deboost_details":[
{
"violation_type":"Prohibited Listing",
"violation_reason":"Wrong Category",
"suggestion":"The item is in wrong category, please update to the suggested_category",
"suggested_category":[
{
"category_id":100005,
"category_name":"Health"
},
{
"category_id":107478,
"category_name":"Personal Care"
}
],
"update_time": 1704943027,
"fix_deadline_time": 1705202227,
}
]
}
]
}
}
§8 Error example
Error example
§9 JSON
JSON
Fail:
{
"error": "error_param",
"message": "Request items over limit, should be less than 50",
"request_id": "e18d6d920680f0ddabf1a9cd7f2d5141"
}
Partial Fail:
{
"message": null,
"request_id": "80e9cf02db62236d9c05834a5e466a41",
"response": {
"item_list": [
{
"item_id": 843025868,
"item_name": "item 39 test",
"item_status": "BANNED",
"deboost": false,
"item_status_details": [
{
"fix_deadline_time": 1705228281,
"suggestion": "Upload license",
"update_time": 1705055481,
"violation_reason": "License Reason",
"violation_type": "Prohibited Listing"
}
]
}
{
"item_id": 843024518,
"fail_error": "error_param",
"fail_message": "Invalid request item_id"
},
{
"item_id": 43026711,
"fail_error": "error_param",
"fail_message": "Invalid request item_id"
}
]
}
}
§10 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 | |
| error_inner | System error, please try again later | |
| error_param | Invalid request item_id | |
| error_param | The item_id_list is required | |
| error_param | Request items over limit, should be less than 50 | |
| error_param | item_status does not match latest violation |
§11 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. |
§12 Update log
Update log
| Date | Change |
|---|---|
| 2024-01-18 | New API |
