v2.ams.add_all_products_to_open_campaign
POST /api/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%.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/add_all_products_to_open_campaign
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 |
|---|---|---|---|---|
| commission_rate | float | True | 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 set 10 minutes later |
| period_end_time | timestamp | False | 1735660800 | Period end time, in seconds, if missing, will set 32503651199 (2999-12-31 23:59:59) represent of 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 | ||
| task_type | string | batch_add_open_campaigns | Task type. Applicable values: batch_add_open_campaigns batch_remove_open_campaigns batch_update_open_campaigns For this API, task type will be batch_add_open_campaigns |
| task_id | string | abcd-abcd-abcd | Task id, used to query task progress when calling v2.ams.get_open_campaign_batch_task_result API |