v2.ams.get_open_campaign_not_added_product
GET /api/v2/ams/get_open_campaign_not_added_product
Retrieve eligible products not yet added to the Open Campaign
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_not_added_product
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 | 1234,5678 | 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_NAME | Search type: ITEM_ID or ITEM_NAME |
| search_content | string | False | test | Search for item name or item id. item id should be split by comma and at most 50 items. When search_content is passed, search_type is required. |
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 | ||
| item_list | object[] | ||
| item_id | int64 | 123 | Item ID |
| item_name | string | test | Item name |
| sales | int64 | 123 | Item sales |
| display_price | string | 29.12 | Item display price |
| stock | int64 | 19999 | Item stock |
| is_in_blacklist | boolean | false | If item is in blacklist, it cannot set up open campaign |
| with_open_campaign | boolean | true | If item already has open campaign, it cannot set up another open campaign The item list may be delayed, so it is used to further filter items that already have open campaigns |
| total_count | int32 | 100 | Total number of items that match the condition |
| cursor | string | 1234,5678 | Pass the content in the next request as cursor to get the next page data |
| has_more | boolean | true | This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders. |