v2.ams.create_new_targeted_campaign

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

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"campaign_name": "CAMPAIGN_NAME",
	"period_start_time": 1735660800,
	"period_end_time": 32503651199,
	"is_set_budget": true,
	"budget": 500000,
	"seller_message": "Hello, pleasant cooperation.",
	"item_list": [
		{
			"item_id": 101,
			"rate": 1.1
		}
	],
	"affiliate_list": [
		{
			"affiliate_id": 11301234567
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/ams/create_new_targeted_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"affiliate_list\": [
      {
         \"affiliate_id\": 11301234567
      }
   ],
   \"budget\": 500000,
   \"campaign_name\": \"CAMPAIGN_NAME\",
   \"is_set_budget\": true,
   \"item_list\": [
      {
         \"item_id\": 101,
         \"rate\": 1.1
      }
   ],
   \"period_end_time\": 32503651199,
   \"period_start_time\": 1735660800,
   \"seller_message\": \"Hello, pleasant cooperation.\"
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/create_new_targeted_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "affiliate_list": [
        {
            "affiliate_id": 11301234567
        }
    ],
    "budget": 500000,
    "campaign_name": "CAMPAIGN_NAME",
    "is_set_budget": true,
    "item_list": [
        {
            "item_id": 101,
            "rate": 1.1
        }
    ],
    "period_end_time": 32503651199,
    "period_start_time": 1735660800,
    "seller_message": "Hello, pleasant cooperation."
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/ams/create_new_targeted_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "affiliate_list": [
      {
         "affiliate_id": 11301234567
      }
   ],
   "budget": 500000,
   "campaign_name": "CAMPAIGN_NAME",
   "is_set_budget": true,
   "item_list": [
      {
         "item_id": 101,
         "rate": 1.1
      }
   ],
   "period_end_time": 32503651199,
   "period_start_time": 1735660800,
   "seller_message": "Hello, pleasant cooperation."
}'

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/ams/create_new_targeted_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "affiliate_list": [
    {
      "affiliate_id": 11301234567
    }
  ],
  "budget": 500000,
  "campaign_name": "CAMPAIGN_NAME",
  "is_set_budget": True,
  "item_list": [
    {
      "item_id": 101,
      "rate": 1.1
    }
  ],
  "period_end_time": 32503651199,
  "period_start_time": 1735660800,
  "seller_message": "Hello, pleasant cooperation."
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"error": "",
	"message": "",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"campaign_id": 101,
		"fail_item_list": [],
		"fail_affiliate_list": []
	}
}

Error example

JSON

{
	"error": "",
	"message": "",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"campaign_id": 101,
		"fail_item_list": [
			{
				"item_id": 101,
				"fail_error": "test_error",
				"fail_message": "test_message"
			}
		],
		"fail_affiliate_list": [
			{
				"affiliate_id": 11301234567,
				"fail_error": "test_error",
				"fail_message": "test_message"
			}
		]
	}
}

Errors

Common errors

Update log