v2.ams.batch_edit_products_open_campaign_setting
POST /api/v2/ams/batch_edit_products_open_campaign_setting
Batch update open campaign settings for a given list of product IDs
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/batch_edit_products_open_campaign_setting
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| campaign_ids | int64[] | True | [123] | The list of campaign_id, max limit: 50 |
| commission_rate | float | False | 1.1 | Commission Rate, 1.1 means 1.1%, support two decimal places |
| period_start_time | timestamp | False | 1735660800 | Period start time, in seconds, 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 end time, in seconds, if missing, will skip and do not update Can set 32503651199 to make period no limit |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_business | Indicate error type if hit error. Empty if no error happened. |
| message | string | Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API. | Indicate error details if hit error. Empty if no error happened. |
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | The identifier for an API request for error tracking. |
| response | object | ||
| failed_list | object[] | ||
| campaign_id | int64 | 123 | Campaign ID |
| fail_error | string | invalid_param | Fail error |
| fail_message | string | The commission rate is invalid, please check again. | Fail message |
| success_list | int64[] | [123] | Success Campaign ID List |