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 trạng thái chiến dịch, tỷ lệ hoa hồng, and promotion period

Đường dẫn Endpoint

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

Tham số chung

Tên	Kiểu	Mẫu	Mô tả
partner_id	int	1	Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu.
timestamp	timestamp	1610000000	Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ.
shop_id	int	600000	Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API.
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

Tham số Request

Tên	Kiểu	Bắt buộc	Mẫu	Mô tả
page_size	int32	True	20	Each result set is returned as a page of entries. Use the "page_size" filters to control the tối đa number of entries to retrieve per page (i.e., per call). This integer value is used to specify the tối đa 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.

Tham số Response

Tên	Kiểu	Mẫu	Mô tả
error	string	error_business	Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi.
message	string	Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.	Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	Mã định danh của yêu cầu API dùng để theo dõi lỗi.
response	object
item_list	object[]
item_id	int64	123	ID sản phẩm
item_name	string	test	Tên sản phẩm
campaign_id	int64	123	ID chiến dịch
campaign_status	string	Ongoing	Campaign Status: Upcoming Ongoing Terminating
commission_rate	float	1.11	Tỷ lệ hoa hồng, 1.1 nghĩa là 1.1%, hỗ trợ hai chữ số thập phân
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	Tổng số items that match the tình trạng
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.

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 $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 --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' 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)

], "max_commission_rate_current_day": 1.21 } ], "total_count": 1000, "cursor": "1234,5678", "has_more": true } }