v2.ams.get_open_campaign_added_product

GET /api/v2/ams/get_open_campaign_added_product

Retrieve all products currently in the Open Campaign, including campaign status, commission rate, and promotion period

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_added_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_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.
cursor	string	False	1234,5678	Specifies the starting entry of data to return in the current call. Default is "" or not passed. If data is more than one page, the cursor can be some entry to start next call.
sort_by	string	False	commission_rate	Use this field to specify which field to use to sort the returned item list. Sort by update_time and commission_id in descending order by default. Available values: commission_rate: Sort by commission_rate in ascending order -commission_rate: Sort by commission_rate in descending order
search_type	string	False	ITEM_NAME	Search type: ITEM_NAME or ITEM_ID
search_content	string	False	test	Search for item_name or item_id, item_id should be split by comma and at most 50 items.

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
item_list	object[]
item_id	int64	123	Item ID
item_name	string	test	Item Name
campaign_id	int64	123	Campaign ID
campaign_status	string	Ongoing	Campaign Status: Upcoming Ongoing Terminating
commission_rate	float	1.11	Commission Rate, 1.1 means 1.1%, 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
pending_terminated_time	timestamp	1735660800	Pending Terminated Time
commission_protection_list	object[]		Commission Protection List
commission_rate	float	1.21	Commission Rate, 1.1 means 1.1%, support two decimal places
protection_period_end_time	timestamp	1735660800	Protection Period End Time
max_commission_rate_current_day	float	1.21	Max Commission Rate Current Day, 1.1 means 1.1%, support two decimal places
total_count	int32	1000	Total number of items that match the condition
cursor	string	1234,5678	Pass the content in the next request as cursor to get the next page data
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.