v2.ads.get_recommended_item_list
GET /api/v2/ads/get_recommended_item_list
Use this API to get the list of recommended SKU (Shop level) with the corresponding tag, i.e top search/best selling/best ROI tag.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_recommended_item_list
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 |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Error code, empty when no error returned | |
| message | string | error description | |
| warning | string | If some data cannot respond normally, set the warning | |
| request_id | string | 6f235f4a343e4feb8a9ed74c439f6663 | request id is unique for each request |
| response | object[] | response body | |
| item_id | int32 | 1234 | Recommended SKU's item id |
| item_status_list | string[] | ["blocked"] | This is param to indicate the status of items, so sellers can know whether an item is eligible for ads or not. |
| sku_tag_list | string[] | ["best selling"] | The corresponding tag (or tags) that belong to item_id, sequences follow as best selling>best ROI>top search |
| ongoing_ad_type_list | string[] | ["search ads", "discovery ads"] | Current status of the ad on this item. For example- no ongoing promotion, search ads, discovery ads, boost ads |