Paginated Product Query
Updated: 2026-07-13 11:28:48
API Description
1、分页查询标签
2、接口支持https协议
API URL
https://api.polyv.net/live/v4/user/product/list
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid for 3 minutes |
| sign | true | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See signature generation rules |
| pageNumber | true | Integer | Current page number |
| pageSize | true | Integer | Page size |
| keyword | false | String | Keyword search |
| productType | false | String | Product type (normal: normal product, finance: financial product) |
Example
https://api.polyv.net/live/v4/user/product/list?appId=frlr1zazn3×tamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&pageNumber=1&pageSize=10
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic, success returns "success", failure returns "error" |
| success | Boolean | Response result, determined by business logic, success returns true, failure returns false |
| data | Object | Product pagination data See data field description |
| error | Object | Error information when status code is non-200 See Error field description |
| requestId | String | Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, not for business logic |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to identify the specific error |
| desc | String | Error description, corresponds to error.code |
data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageNumber | String | Page number |
| pageSize | Integer | Page size |
| totalPages | String | Total pages |
| totalItems | String | Total records |
| contents | Array | Product array |
contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| productId | String | Product ID |
| name | String | Product name |
| cover | String | Cover image, not empty for normal type products |
| linkType | Integer | Product link type, 10: general link, 11: multi-platform link, 12: call native method |
| link | String | Product link, cannot be empty |
| productType | String | Product type, possible values: normal: normal product finance: financial product position: job product |
| pcLink | String | PC link |
| mobileLink | String | Mobile link |
| wxMiniprogramOriginalId | String | WeChat Mini Program original ID |
| wxMiniprogramLink | String | WeChat Mini Program link |
| mobileAppLink | String | Mobile app link |
| iosLink | String | iOS link |
| androidLink | String | Android link |
| otherLink | String | Other platform link |
| features | String | Product features, selling point tags, can be multiple, JSON array |
| tagIds | Array |
Product tag ID list |
| btnShow | String | Button display text |
| productDesc | String | Product description |
| productDetail | String | Product details, returns a content storage address: e.g., https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json the URL stores the product detail content |
| ext | String | Extended information: JSON object string: {"coverList":["cover image URLs, up to 15"], "videoList":[{"videoSource":"video source", "videoId":"video ID"}]} See EXT details |
| - | - | Parameters specific to normal products (productType=normal) |
| priceType | String | Actual price type, possible values: AMOUNT: amount CUSTOM: custom |
| realPrice | Float | Actual price - amount, maximum precision of 2 decimal places, e.g., 12.34 |
| customPrice | String | Actual price - custom |
| originalPriceType | String | Original price (strikethrough price) type, possible values: AMOUNT: amount CUSTOM: custom |
| price | Float | Original price (strikethrough price) - amount, maximum precision of 2 decimal places, e.g., 12.34 |
| customOrignalPrice | String | Original price (strikethrough price) - custom note: if both price and customOriginalPrice are empty, the original price (strikethrough price) is not enabled |
| - | - | End of parameters specific to normal products (productType=normal) |
EXT
| Parameter | Required | Type | Description |
|---|---|---|---|
| coverList | true | Array | Cover image URL array, up to 15 |
| videoList | false | Array | Video array, up to 1 See ChannelProductExtVideo Requires material library to be enabled |
| jumpWay | false | String | Jump method for external link purchase - general link: POP_UP - popup window, NEW_WINDOW - new window, CURRENT_WINDOW - current window |
ChannelProductExtVideo
| Parameter | Required | Type | Description |
|---|---|---|---|
| videoId | true | String | Video ID |
| videoSource | true | String | Video source: MATERIAL_LIBRARY - material library |
Example of content stored in the productDetail URL
{
"productDetail": "<p>这是商品详情</p>"
}
Java Request Example
For quick integration, please download the relevant dependency source code, click here to download the source code. After downloading, add it to your own project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.
It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.
private final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询组织架构列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getProductPageTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
Integer pageNumber = 1;
Integer pageSize = 10;
//业务参数
String url = "https://api.polyv.net/live/v4/user/product/list";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询商品分页成功:{}", response);
//do somethings
}
Response Example
For global system error descriptions, see Global Error Description
Success Example
{
"code": 200,
"status": "success",
"requestId": "9ccd6f6e-cf35-4d9e-8a0c-0fa9d214c592",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"productId": "1729060628513820672",
"name": "123",
"price": 0,
"cover": "//liveimages.videocc.net/uploaded/images/2023/11/gqzb4tybhf.jpg",
"link": "http://123.456.com",
"rank": 1,
"realPrice": 0,
"type": "demo",
"linkType": 10,
"pcLink": "",
"mobileLink": "",
"androidLink": "",
"iosLink": "",
"otherLink": "",
"wxMiniprogramLink": "",
"wxMiniprogramOriginalId": "",
"mobileAppLink": "",
"params": null,
"productType": "normal",
"btnShow": null,
"features": "[\"\", \"\"]",
"tagIds": [1001, 1002],
"productDesc": "",
"productDetail": "https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json",
"yield": null
}
]
},
"success": true
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
