> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/v-4/user/product/product_list.md).

# 分页查询商品

### 接口描述

```
1、分页查询标签
2、接口支持https协议
```

### 接口URL

```
https://api.polyv.net/v4/user/product/list
```

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名         | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ----------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId       | true  | String  | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp   | true  | Long    | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign        | true  | String  | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| pageNumber  | true  | Integer | 当前页码                                                                                                                                                                                                      |
| pageSize    | true  | Integer | 分页大小                                                                                                                                                                                                      |
| keyword     | false | String  | 关键字搜索                                                                                                                                                                                                     |
| productType | false | String  | 商品类型（normal:普通商品,finance:金融商品）                                                                                                                                                                            |

### 示例

```requestUrl
https://api.polyv.net/live/v4/user/product/list?appId=frlr1zazn3&timestamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&pageNumber=1&pageSize=10
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 响应状态码，200为成功返回，非200为失败                   |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 响应结果，由业务决定，成功返回true，失败返回false            |
| data      | Object  | 标签分页数据【详见[data字段说明](#data参数描述)】          |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段说明](#error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

#### data参数描述

| 参数名        | 类型      | 说明   |
| ---------- | ------- | ---- |
| pageNumber | String  | 分页页码 |
| pageSize   | Integer | 分页大小 |
| totalPages | String  | 总页数  |
| totalItems | String  | 总记录数 |
| contents   | Array   | 商品数组 |

**contents参数描述**

| 参数名                     | 必选    | 类型      | 说明                                                     |
| ----------------------- | ----- | ------- | ------------------------------------------------------ |
| productId               | true  | String  | 商品id                                                   |
| name                    | true  | String  | 商品名称                                                   |
| cover                   | false | String  | 封面图, normal类型商品值不为空                                    |
| linkType                | true  | Integer | 商品链接类型, 10:通用链接,11:多平台链接 ,12:调用原生方法                    |
| link                    | true  | String  | 商品链接不能为空                                               |
| productType             | false | String  | 商品类型(默认normal), normal:普通商品 finance:金融商品 position:职位商品 |
| price                   | false | Float   | 价格                                                     |
| realPrice               | false | Float   | 原价                                                     |
| pcLink                  | false | String  | pc端链接                                                  |
| mobileLink              | false | String  | 移动端链接                                                  |
| wxMiniprogramOriginalId | false | String  | 微信小程序原始ID                                              |
| wxMiniprogramLink       | false | String  | 微信小程序链接                                                |
| mobileAppLink           | false | String  | 手机APP链接                                                |
| iosLink                 | false | String  | ios链接                                                  |
| androidLink             | false | String  | android链接                                              |
| otherLink               | false | String  | 其他端链接                                                  |
| features                | false | String  | 商品特色,卖点标签，可以多个,json数组                                  |
| btnShow                 | false | String  | 按钮显示文案                                                 |
| productDesc             | false | String  | 商品描述                                                   |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "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": "[\"\", \"\"]",
                "productDesc": "",
                "yield": null
            }
        ]
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://polyv.gitbook.io/document/docs/live/api/v-4/user/product/product_list.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.