v2.ams.get_targeted_campaign_addable_product_list
GET /api/v2/ams/get_targeted_campaign_addable_product_list
Returns a list of products that can be added to a targeted campaign
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list
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 |
|---|---|---|---|---|
| page_size | int32 | True | 20 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100. |
| cursor | string | False | abcd | 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 | -sales | Use this field to specify which field to use to sort the returned item list. Available values: -sales: Sort by sales in descending order (default value) sales: Sort by sales in ascending order -stock: Sort by inventory in descending order stock: Sort by inventory in ascending order -price: Sort by price in descending order price: Sort by price in ascending order |
| search_type | string | False | ITEM_ID | Search type: ITEM_NAME or ITEM_ID, used with search_content. |
| search_content | string | False | 101,102 | Search by item name or item ID, item_id should be split by comma and at most 50 items. Please specify search_type for it to be effective, otherwise search_content will be ignored. |
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 | Detail informations you are querying. | |
| item_list | object[] | Item list. | |
| item_id | int64 | 101 | The unique key for item. |
| item_name | string | item a | The name of the current item. |
| sales | int64 | 1554 | The sold of the current item. |
| display_price | string | 95250 | The display_price of the current item. |
| stock | int64 | 20 | The stock of the current item. |
| is_in_blacklist | boolean | false | Is the current item in the blacklist. |
| total_count | int32 | 20 | The total count of items that meet the query criteria. |
| cursor | string | abcd | Pass the content in the next request as cursor to get the next page data. |