v2.product.search_item
GET /api/v2/product/search_item
Use this call to search item.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/search_item
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 |
|---|---|---|---|---|
| offset | string | False | 0 | 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. |
| page_size | int | True | 10 | the size of one page. |
| item_name | string | False | apple | name of item. |
| attribute_status | int | False | 2 | 1:get item lack of requires attribute. 2:get item lack of optional attribute. |
| item_sku | string | False | sku | sku. If you search for item_sku and item_name at the same time, only the results that match item_sku will be returned. If you search for item_sku and attribute_status at the same time, the results that match both item_sku and attribute_status will be returned. |
| item_status | string[] | False | ["NORMAL"] | NORMAL/BANNED/UNLIST/REVIEWING/SELLER_DELETE/SHOPEE_DELETE If you want to search multiple status, please upload the url like this: item_status=NORMAL&item_status=BANNED |
| deboost_only | boolean | False | true | If deboost_only is true, then API will return items whose deboost is true, if deboost_only is empty or false, then API will return items whose deboost is true and false simultaneously |
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_id_list | int[] | List of item ID. | |
| total_count | int | Total num of items match condation. | |
| next_offset | string | If has_next_page is true, this value need set to next request.offset |