v2.ams.get_optimization_suggestion_product

GET /api/v2/ams/get_optimization_suggestion_product

Retrieve products with suggestions to improve performance

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/get_optimization_suggestion_product

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_no	int32	True	1	Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
page_size	int32	True	20	Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.
rcmd_reason_filter	string	True	product_opportunities	Recommended types. Applicable values: product_opportunities optimize_increase_commission_rate optimize_extend_promotion_period

Response Parameters

Name	Type	Sample	Description
error	string	error_business	Indicate error type if hit error. Empty if no error happened.
message	string	Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.	Indicate error details if hit error. Empty if no error happened.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
item_list	object[]
item_id	int64	123	Item ID
item_name	string	test	Item Name
rcmd_reason	string[]	["severe_shortage","high_popularity"]	Recommend reason. Applicable values: severe_shortage high_popularity optimize_commission_rate extend_time_period
campaign_id	int64	123	Campaign ID
commission_rate	float	1.1	Commission Rate, 1.11 means 1.11%, support two decimal places
period_start_time	timestamp	1735660800	Period Start Time
period_end_time	timestamp	1735660800	Period End Time, if get 32503651199 (2999-12-31 23:59:59), it means no limit
affiliate_count	int64	123	The total number of affiliates who have ever shared the product in the last 90 days
item_sold	int64	123	If the requested rcmd_reason_filter is product_opportunition, it is represented as item sales. Other scenarios are the total number of item sold for each product of the shop through AMS in the last 90 days
campaign_status	string	Ongoing	Campaign Status: Upcoming Ongoing Terminating
l2_category_order_count	int64	123	The total number of AMS orders for the product's L2 category in the last 30 days, only available when requested rcmd_reason_filter is product_opportunition
suggest_min_rate	float	1.1	Minimum suggested commission rate, 1.1 means 1.1%, support two decimal places
suggest_max_rate	float	1.2	Maximum suggested commission rate, 1.2 means 1.2%, support two decimal places
prefill_rate	float	1.1	Prefill rate, 1.1 means 1.1%, support two decimal places
prefill_subsidy_rate	float	1.2	Prefill subsidy rate, platform commission rate calculated based on seller commission, 1.2 means 1.2%, support two decimal places
display_price	string	1.23	Display price
has_subsidy_data	boolean	true	Has subsidy rate
total	int32	1000	Total number of items that match the condition
has_more	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 orders.