v2.product.get_item_list_by_content_diagnosis
POST /api/v2/product/get_item_list_by_content_diagnosis
Query the list of products and their content quality details by content quality level or content issues.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/get_item_list_by_content_diagnosis
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_size | int32 | True | 5 | the size of one page. Max=48 |
| offset | string | False | "" | Specifies the starting entry of data to return in the current call. Default is empty. if data is more than one page, the offset can be some entry to start next call. |
| quality_level | int32[] | False | [1,2] | Item's latest content quality level. Applicable values: 1: TO_BE_IMPROVED 2: QUALIFIED 3: EXCELLENT |
| issue_type | int32[] | False | [1,2,3,4,5,6,7,8,9,10,11] | 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 If you need to pass both quality_level and issue_type, the logic are as follows: - When quality_level is 1, issue_type can only be 1, 2, 3, 4, 5 - When quality_level is 2, issue_type can only be 6, 7, 8, 9, 10, 11 - When quality_level is 3, issue_type can only be empty |
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. | |
| 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 | ||
| item_list | object[] | ||
| item_id | int64 | Shopee's unique identifier for an item. | |
| 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 | |
| unfinished_task | object[] | ||
| 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 | |
| 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 | |
| total_count | int64 | 30 | Total num of items match condition. |
| has_next_page | boolean | true | This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items. |
| next_offset | string | "800253323,1723540627,800253323" | If has_next_page is true, this value need set to next request.offset |