v2.ams.edit_all_products_open_campaign_setting
POST /api/v2/ams/edit_all_products_open_campaign_setting
Update for all products in 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_edit_products_open_campaign_setting by pagination manually, or check the product status by using the GET API after the task progress turn to 100%.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ams/edit_all_products_open_campaign_setting
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ả |
|---|---|---|---|---|
| commission_rate | float | False | 1.1 | Tỷ lệ hoa hồng, 1.1 nghĩa là 1.1%, hỗ trợ hai chữ số thập phân, if miss, will skip and do not update |
| period_start_time | timestamp | False | 1735660800 | Period thời gian bắt đầu, tính bằng giây, if missing, will skip and do not update Only allow to update on UPCOMING status, when in other status, will skip too |
| period_end_time | timestamp | False | 1735660800 | Period thời gian kết thúc, tính bằng giây, if missing, will skip and do not update Can set 32503651199 to make period no limit |
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 | ||
| task_type | string | batch_update_open_campaigns | Loại tác vụ. Các giá trị áp dụng: batch_add_open_campaigns batch_remove_open_campaigns batch_update_open_campaigns Đối với API này, loại tác vụ sẽ là batch_update_open_campaigns |
| task_id | string | abcd-abcd-abcd | ID tác vụ, dùng để truy vấn tiến trình tác vụ khi gọi v2.ams.get_open_campaign_batch_task_result API |
Dữ liệu gửi
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/ams/edit\_all\_products\_open\_campaign\_setting?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
"commission_rate": 1.1,
"period_end_time": 1735660800,
"period_start_time": 1735660800
}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/edit\_all\_products\_open\_campaign\_setting?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=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 --location --request POST 'https://partner.shopeemobile.com/api/v2/ams/edit\_all\_products\_open\_campaign\_setting?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=timestamp'
--header 'Content-Type: application/json'
--data-raw '{
"commission_rate": 1.1,
"period_end_time": 1735660800,
"period_start_time": 1735660800
}'
import requests
import json
url = "https://partner.shopeemobile.com/api/v2/ams/edit\_all\_products\_open\_campaign\_setting?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=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)
}