v2.ams.get_targeted_campaign_list

GET /api/v2/ams/get_targeted_campaign_list

Retrieve all current targeted campaigns created by the seller

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_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

Request Parameters

Name	Type	Required	Sample	Description
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), and the "page_no" to start next 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.
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.
campaign_id_list	string	False	101,102,103	The list of campaign_id for query, different campaign id should be split by comma and at most 50 campaigns.
campaign_name	string	False	campaign a	Campaign name for query.
campaign_status	string	False	Upcoming	Campaign status for query. Applicable values: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
period_start_time	timestamp	False	1735660800	Campaign period start time for query.
period_end_time	timestamp	False	32503651199	Campaign period end time for query.
item_id	int64	False	101	Item id for query.
item_name	string	False	product a	Item name for query.

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.
total_count	int32	30	The total count of targeted campaigns that meet the query criteria.
commission_list	object[]		Targeted campaign list.
campaign_id	int64	101	The unique key for the current campaign.
campaign_name	string	campaign a	The name of the current campaign.
campaign_status	string	Ongoing	Campaign Status: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
campaign_source	string	Seller	Source of campaign setup. Applicable values:  - ShopeeManaged (Note: You cannot view the details or edit this campaign. If you try to do so, an 'invalid campaign_id' error will occur.) - Seller - Unknown
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
last_editor	string	example@example.com	The last editor of the current campaign.
last_edit_time	timestamp	1735660800	The last edit time of the current campaign.
affiliate_count	int32	20	The total count of affiliates associated with the current campaign.
item_count	int32	20	The total count of items associated with the current campaign.
min_rate	float	10.0	The min commission rate of the current campaign.
max_rate	float	25.0	The max commission rate of the current campaign.