Skip to main content

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

NameTypeSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

NameTypeSampleDescription
errorstringError code, empty when no error returned
messagestringerror description
warningstringIf some data cannot respond normally, set the warning
request_idstring6f235f4a343e4feb8a9ed74c439f6663request id is unique for each request
responseobject[]response body
item_idint321234Recommended SKU's item id
item_status_liststring[]["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_liststring[]["best selling"]The corresponding tag (or tags) that belong to item_id, sequences follow as best selling>best ROI>top search
ongoing_ad_type_liststring[]["search ads", "discovery ads"]Current status of the ad on this item. For example- no ongoing promotion, search ads, discovery ads, boost ads