stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.livestream.get_like_item_list
Get the item list of My Likes tab.(For TW, ID, TH, PH, MY, SG, VN)
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Livestream |
| API type | User |
| HTTP method | GET |
| Path | /api/v2/livestream/get_like_item_list |
| Production URL | https://partner.shopeemobile.com/api/v2/livestream/get_like_item_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/livestream/get_like_item_list |
| Permission | Livestream Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| offset | int32 | Yes | 0 | Specifies the starting entry of data to return in the current call. Default is 0, if data is more than one page, the offset can be some entry to start next call. |
| page_size | int32 | Yes | 10 | 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. |
| keyword | string | No | Search items with name matching this keyword. |
§4 Response parameters
Response parameters
| Name | Type | Required | 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. | ||
| request_id | string | ae9e59cf358b59d7f940552176cb9d01 | The identifier for an API request for error tracking. | |
| response | object | Detail informations you are querying. | ||
| response.more | boolean | true | This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of data. | |
| response.next_offset | int32 | If more is true, this value need set to next request offset. | ||
| response.list | object[] | |||
| response.list.item_id | int64 | Shopee's unique identifier for an item. | ||
| response.list.shop_id | int64 | The shop id of this item. | ||
| response.list.name | string | Name of the item in local language. | ||
| response.list.image_url | string | The image url of this item. | ||
| response.list.price_info | object | |||
| response.list.price_info.currency | string | SGD | The three-digit code representing the currency unit used for the item. | |
| response.list.price_info.current_price | float | 90.0 | The current price of the item in the listing currency. If product under an ongoing promotion, current_price will be the promotion price. | |
| response.list.price_info.original_price | float | 100.0 | The original price of the item in the listing currency. | |
| response.list.affiliate_info | object | |||
| response.list.affiliate_info.commission_rate | float | The commission rate that the streamer can get, for example, 0.1 means 10%. | ||
| response.list.affiliate_info.is_campaign | boolean | Whether participate in a campaign project (generally, the commission will be higher). | ||
| response.list.affiliate_info.campaign_mcn_name | string | MCN agency that initiated this campaign. | ||
| response.list.affiliate_info.campaign_start_time | int64 | Campaign start time, it's unix timestamp in seconds. | ||
| response.list.affiliate_info.campaign_end_time | int64 | Campaign end time, it's unix timestamp in seconds. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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. | |
| user_id | int | 1 | Shopee's unique identifier for a user. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
§6 Request samples
Request samples
§7 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/livestream/get_like_item_list?access_token=access_token&keyword=-&offset=0&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/livestream/get_like_item_list?access_token=access_token&keyword=-&offset=0&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id',
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;
§9 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/livestream/get_like_item_list?access_token=access_token&keyword=-&offset=0&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/livestream/get_like_item_list?access_token=access_token&keyword=-&offset=0&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id"
payload={}
headers = {
}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{
"error": "",
"message": "",
"request_id": "ae9e59cf358b59d7f940552176cb9d01",
"response": {
"more": true,
"next_offset": 0,
"list": [
{
"item_id": 0,
"shop_id": 0,
"name": "-",
"image_url": "-",
"price_info": {
"currency": "-",
"current_price": 0.1,
"original_price": 0.1
},
"affiliate_info": {
"commission_rate": 0.1,
"is_campaign": true,
"campaign_mcn_name": "-",
"campaign_start_time": 0,
"campaign_end_time": 0
}
}
]
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "error_param",
"message": "Invalid page_size, page_size must larger than 0 and cannot exceed 100",
"request_id": "2b02779a357abd74e15f4273b61a0f01",
"response": {}
}
§15 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | Invalid page_size, page_size must larger than 0 and cannot exceed {{limit}} | |
| error_data | You are not allowed to view my like items | |
| error_auth | You are not authorized | |
| error_server | The API is not supported for current region | |
| error_param | Parse data error: {{err_msg}} | |
| error_server | Too many requests, please try again later | |
| error_server | Server internal error: {{err_msg}} | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. |
§16 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| error_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| api_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00) | |
| error_rate_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api. | |
| error_api_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| user_no_linked | Partner and user has no linked. | |
| user_banned | This user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| error_param | There is no user_id in query. | |
| error_param | user_id is invalid, should be an integer between 0 and 4294967295. |
§17 Update log
Update log
| Date | Change |
|---|---|
| 2026-01-13 | Update API Description |
| 2025-06-24 | New API |
