v2.ams.add_all_products_to_open_campaign

Add all eligible products into the Open Campaign. We will only return the general error that caused the whole task failure, without returning the specific error for each product in the v2.ams.get_open_campaign_batch_task_result API. If you want to get the result for each products, you can use v2.ams.batch_add_products_to_open_campaign by pagination manually, or check the product status by using the GET API after the task progress turn to 100%.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"commission_rate": 1.1,
	"period_start_time": 1735660800,
	"period_end_time": 1735660800
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/ams/add_all_products_to_open_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"commission_rate\": 1.1,
   \"period_end_time\": 1735660800,
   \"period_start_time\": 1735660800
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/add_all_products_to_open_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 => '{
    "commission_rate": 1.1,
    "period_end_time": 1735660800,
    "period_start_time": 1735660800
}',
  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/add_all_products_to_open_campaign?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "commission_rate": 1.1,
   "period_end_time": 1735660800,
   "period_start_time": 1735660800
}'

Python

import requests
import json

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

payload=json.dumps({
  "commission_rate": 1.1,
  "period_end_time": 1735660800,
  "period_start_time": 1735660800
})
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": {
		"task_type": "batch_add_open_campaigns",
		"task_id": "abcd-abcd-abcd"
	}
}

Error example

JSON

{
	"error": "error_business",
	"message": "Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}

Errors

Common errors

Update log