stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.get_item_content_diagnosis_result
Get the content quality details (including content quality level, content issues, and system suggestions) for specific product list.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/product/get_item_content_diagnosis_result |
| Production URL | https://partner.shopeemobile.com/api/v2/product/get_item_content_diagnosis_result |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/get_item_content_diagnosis_result |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| item_id_list | int64[] | Yes | [10760653,10943921] | item_id list; limit [1,48] |
§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.success_item_list | object[] | |||
| response.success_item_list.item_id | int64 | Shopee's unique identifier for an item. | ||
| response.success_item_list.quality_level | int32 | Item's latest content quality level. Applicable values: 0: NONE (No quality level for item in SELLER_DELETE / SHOPEE_DELETE / BANNED status) 1: TO_BE_IMPROVED 2: QUALIFIED 3: EXCELLENT | ||
| response.success_item_list.unfinished_task | object[] | |||
| response.success_item_list.unfinished_task.issue_type | int32 | Item's content issue. Applicable values: 1: TOO_FEW_IMAGES 2: WRONG_CATEGORY 3: TOO_FEW_ATTRIBUTES_FOR_QUALIFIED 4: LACK_OF_SIZE_CHART 5: LACK_OF_STANDARD_VARIATION 6: LACK_BRAND 7: TOO_SHORT_DESCRIPTION 8: TOO_SHORT_OR_TOO_LONG_NAME 9: WRONG_WEIGHT 10: LACK_OF_VIDEO 11: TOO_FEW_ATTRIBUTES_FOR_EXCELLENT | ||
| response.success_item_list.unfinished_task.suggestion | string | System suggestion for item's content issue. Applicable values: Add at least 3 images; Adopt suggested category Add at least 1 attributes Add size chart Adopt the color or size variation Add brand info Add at least 100 characters or 1 image for desc Add characters for name to 25~100 Adopt suggested weight Add video Add at least 3 attributes | ||
| response.failure_item_list | object[] | |||
| response.failure_item_list.item_id | int64 | Shopee's unique identifier for an item. | ||
| response.failure_item_list.failed_reason | string | Item's failure reason. |
§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
{
"item_id_list": [
843988729,
100760653,
100957110,
100918814,
102202080
]
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"error": "",
"message": "",
"request_id": "da1037d29ee6ace6d18aa6055d825a41:020000fbf46a4f4b:010000107ff628b4",
"response": {
"failure_item_list": [
{
"failed_reason": "Query failed due to invalid item ID. Please verify the ID and try again",
"item_id": 843988729
}
],
"success_item_list": [
{
"item_id": 100760653,
"quality_level": 3
},
{
"item_id": 100957110,
"quality_level": 2,
"unfinished_task": [
{
"issue_type": 10,
"suggestion": "Add video"
},
{
"issue_type": 8,
"suggestion": "Add characters for name to 25~100"
},
{
"issue_type": 7,
"suggestion": "Add at least 100 characters or 1 image for description"
},
{
"issue_type": 11,
"suggestion": "Add at least 3 attributes"
}
]
},
{
"item_id": 100918814,
"quality_level": 1,
"unfinished_task": [
{
"issue_type": 1,
"suggestion": "Add at least 3 images"
},
{
"issue_type": 3,
"suggestion": "Add at least 1 attribute"
}
]
},
{
"item_id": 102202080,
"quality_level": 0
}
]
},
"warning": ""
}
§10 Error example
Error example
§11 JSON
JSON
{
"error": "product.error_invalid_item_list",
"message": "Invalid item_id_list, please verify the ID and try again",
"request_id": "20d5eadeec0b764503619ccc90edac41:02000068d6b9984b:0100005eadd10add"
}
§12 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_invalid_item_list | Invalid item_id_list, please verify the ID and try again |
§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. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2024-08-14 | New API |
