v2.ams.get_targeted_campaign_addable_product_list
GET /api/v2/ams/get_targeted_campaign_addable_product_list
Returns a danh sách products that can be added to a chiến dịch mục tiêu
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| 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 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| page_size | int32 | True | 20 | Each result set is returned as a page of entries. Use the "page_size" filters to control the tối đa number of entries to retrieve per page (i.e., per call). This integer value is used to specify the tối đa 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 tên sản phẩm 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. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | error_business | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| message | string | Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API. | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| 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 | Tên của 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 | Tổng số items that meet the query criteria. |
| cursor | string | abcd | Pass the content in the next request as cursor to get the next page data. |
Unirest.setTimeouts(0, 0); HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_addable\_product\_list?access\_token=access\_token&cursor=abcd&page\_size=20&partner\_id=partner\_id&search\_content=101%2C102&search\_type=ITEM\_ID&shop\_id=shop\_id&sign=sign&sort\_by=-sales×tamp=timestamp") .asString();<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_addable\_product\_list?access\_token=access\_token&cursor=abcd&page\_size=20&partner\_id=partner\_id&search\_content=101%2C102&search\_type=ITEM\_ID&shop\_id=shop\_id&sign=sign&sort\_by=-sales×tamp=timestamp', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; curl --location --request GET 'https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_addable\_product\_list?access\_token=access\_token&cursor=abcd&page\_size=20&partner\_id=partner\_id&search\_content=101%2C102&search\_type=ITEM\_ID&shop\_id=shop\_id&sign=sign&sort\_by=-sales×tamp=timestamp' import requests url = "https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_addable\_product\_list?access\_token=access\_token&cursor=abcd&page\_size=20&partner\_id=partner\_id&search\_content=101%2C102&search\_type=ITEM\_ID&shop\_id=shop\_id&sign=sign&sort\_by=-sales×tamp=timestamp" payload={} headers = { } response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False) print(response.text)
], "total_count": 20, "cursor": "abcd" } }