v2.ams.create_new_targeted_campaign

POST /api/v2/ams/create_new_targeted_campaign

Create a new campaign with custom product & affiliate selections, and basic info filling.

Endpoint URL

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

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_name	string	True	CAMPAIGN_NAME	The name of the current campaign.
period_start_time	timestamp	True	1735660800	The period start time of campaign, in seconds.
period_end_time	timestamp	True	32503651199	The period end time of campaign, in seconds. Can set 32503651199 (2999-12-31 23:59:59) represent of no limit.
is_set_budget	boolean	False	true	Budget allocation toggle for the current campaign. Note: TH not supported
budget	float	False	500000.0	Budget value set for the current campaign. Note: TH not supported
seller_message	string	True	Hello, pleasant cooperation.	The message displayed to affiliates.
item_list	object[]	True		The list of items associated with the current campaign.
item_id	int64	True	101	Item ID.
rate	float	True	1.1	Commission rate of current item, 1.1 means 1.1%, support two decimal places.
affiliate_list	object[]	True		The list of affiliates associated with the current campaign.
affiliate_id	int64	True	11301234567	The unique key for affiliate.

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		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		Successful elements will not be returned. If error and message are not empty, it means that all settings have failed. If error and message are empty, but fail_xx_list has content, it means that the element in the fail_xx_list setting failed and the rest were successful. If error, message, fail_xx_list are all empty, it means that all settings are successful.
campaign_id	int64	101	The unique key for campaign.
fail_item_list	object[]		Failed Item List.
item_id	int64	101	Item ID.
fail_error	string	test_error	Fail error.
fail_message	string	test_message	Fail message.
fail_affiliate_list	object[]		Fail Affiliate List.
affiliate_id	int64	11301234567	Affiliate ID.
fail_error	string	test_error	Fail error.
fail_message	string	test_message	Fail message.