v2.ams.get_open_campaign_added_product

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

Overview

Request parameters

Response parameters

Common parameters

Request samples

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_added_product?access_token=access_token&cursor=1234%2C5678&page_size=20&partner_id=partner_id&search_content=test&search_type=ITEM_NAME&shop_id=shop_id&sign=sign&sort_by=commission_rate&timestamp=timestamp")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_added_product?access_token=access_token&cursor=1234%2C5678&page_size=20&partner_id=partner_id&search_content=test&search_type=ITEM_NAME&shop_id=shop_id&sign=sign&sort_by=commission_rate&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 => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_added_product?access_token=access_token&cursor=1234%2C5678&page_size=20&partner_id=partner_id&search_content=test&search_type=ITEM_NAME&shop_id=shop_id&sign=sign&sort_by=commission_rate&timestamp=timestamp' 

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_added_product?access_token=access_token&cursor=1234%2C5678&page_size=20&partner_id=partner_id&search_content=test&search_type=ITEM_NAME&shop_id=shop_id&sign=sign&sort_by=commission_rate&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"error": "",
	"message": "",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"item_list": [
			{
				"item_id": 123,
				"item_name": "test",
				"campaign_id": 123,
				"campaign_status": "Ongoing",
				"commission_rate": 1.11,
				"period_start_time": 1735660800,
				"period_end_time": 1735660800,
				"pending_terminated_time": 1735660800,
				"commission_protection_list": [
					{
						"commission_rate": 1.21,
						"protection_period_end_time": 1735660800
					}
				],
				"max_commission_rate_current_day": 1.21
			}
		],
		"total_count": 1000,
		"cursor": "1234,5678",
		"has_more": true
	}
}

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