v2.ads.edit_gms_item_product_campaign
POST /api/v2/ads/edit_gms_item_product_campaign
Add/remove items to/from the GMS Campaign
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/edit_gms_item_product_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 |
|---|---|---|---|---|
| campaign_id | int64 | False | 325325235 | The GMS Campaign ID. Provide if available. |
| edit_action | string | True | add | The following is the list of possible actions: add remove |
| item_id_list | int64[] | True | [124312,123412,124124] | Item IDs to add / remove. Minimum 1 Item ID. Maximum 30 Item IDs. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate warning details if hit warning. Empty if no warning happened. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | ||
| campaign_id | int64 | GMS Campaign ID |