v2.ams.get_targeted_campaign_settings

GET /api/v2/ams/get_targeted_campaign_settings

For each campaign, return: campaign basic info (name, status, promotion period, message), selected product list (with product name & ID), selected affiliate list (with affiliate names)

Endpoint URL

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

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
campaign_id	int64	True	101	Campaign id for query. Note: For campaigns with campaign_source = ShopeeManaged, cannot be queried for details through this API.

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.
campaign_name	string	campaign name	The name of the current campaign.
commission_status	string	Ongoing	Campaign Status: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
period_start_time	timestamp	1735660800	The start time of the current campaign.
period_end_time	timestamp	32503651199	The end time of the current campaign, if get 32503651199 (2999-12-31 23:59:59), it means no limit.
is_set_budget	boolean	true	Has the current campaign set a budget. Note: TH not supported
budget	float	10000.0	The budget of the current campaign. Note: TH not supported
budget_cost	float	500.5	The budget already spent on the current campaign. Note: TH not supported
seller_message	string	Hello, pleasant cooperation.	The message displayed to affiliates.
pending_terminated_time	timestamp	1735660800	Pending Terminated Time.
affiliate_list	object[]		The list of affiliates associated with the current campaign.
affiliate_id	int64	11301234567	The unique key for affiliate, can call v2.ams.query_affiliate_list to get affiliate details.
item_list	object[]		The list of items associated with the current campaign.
item_id	int64	101	Item ID.
item_name	string	item a	Item Name.
rate	float	1.1	Commission rate of current item, 1.1 means 1.1%, support two decimal places.
max_commission_rate_current_day	float	1.1	Max Commission Rate Current Day, 1.1 means 1.1%, support two decimal places.
commission_protection_list	object[]		Commission Protection List.
commission_rate	float	1.1	Commission Rate, 1.1 means 1.1%, support two decimal places.
protection_period_end_time	timestamp	1735660800	Protection Period End Time.