修改频道商品信息
更新时间:2026-03-05 17:30:30
接口描述
1、编辑频道商品库商品信息
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/product/update
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
请求体参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| productId | true | Integer | 商品库商品productId |
| name | true | String | 商品名称,必填,长度范围:1-100 注:接口可支持100字符,直播后台设置仅支持50个字符 |
| status | true | Integer | 商品上下架状态 1:上架状态 2:下架状态 |
| linkType | true | Integer | 商品链接类型 10:通用链接 11:多平台链接 |
| cover | false | String | 商品封面链接,长度范围:1-500 |
| yield | false | String | 金融商品参数,产品收益率/价格,如:87.99% |
| link | false | String | 通用链接(linkType=10) 商品链接,长度1-500,必填 多平台链接(linkType=11),非必填 |
| pcLink | false | String | pc端跳转链接,长度1-500 |
| mobileLink | false | String | 移动web端链接 |
| wxMiniprogramLink | false | String | 小程序端链接 |
| wxMiniprogramOriginalId | false | String | 小程序端Id |
| wxMiniprogramAppId | false | String | 小程序端appId |
| mobileAppLink | false | String | 移动App端链接 |
| productDesc | false | String | 产品描述 |
| androidLink | false | String | 多平台链接,移动APP-安卓系统原生页面链接 |
| iosLink | false | String | 多平台链接,移动APP-苹果系统原生页面链接 |
| btnShow | false | String | 按钮显示文案 |
| params | false | String | 自定义参数,json对象,例如:{"id":21,"color":"blue","level":1} 该参数以String类型接收,请求时需要转义,见下方请求体参数示例 |
| tagIds | false | String | 商品标签ID, json对象 例如: [1,2,3] |
| productDetail | false | String | 商品详情 |
| ext | false | String | 扩展信息:JSON对象字符串:{"coverList":["封面图地址,最多15个"], "videoList":[{"videoSource":"视频来源", "videoId":"视频ID"}]} 【详情见EXT】 |
| features | false | String | 该参数以String类型的json对象接收,请求时需要转义,见下方请求体参数示例 普通商品(productType为normal)时,产品标签,json数组,例如: ["tab1", "tab2"]金融商品(productType为finance)时,产品标签,json数组,例如: ["tab1", "tab2"]职位商品(productType为position)时,职位标签,json数组,例如: ["tab1", "tab2", "tab3"],职位商品标签不足三个时用空字符串代替 |
| - | - | - | 以下为普通商品专用参数 (productType=normal) |
| priceType | false | String | 商品实际价格类型,可选值有: AMOUNT: 金额 CUSTOM: 自定义 不传时默认为 AMOUNT |
| realPrice | false | Float | 商品实际价格-金额,priceType=AMOUNT 时必传,最高精确度为两位小数,如 12.34 |
| customPrice | false | String | 商品实际价格-自定义,priceType=CUSTOM 时必传,最多20个字符 |
| originalPriceType | false | String | 商品原始价格(划线价格)类型,可选值有: AMOUNT: 金额 CUSTOM: 自定义 默认为 AMOUNT |
| price | false | Float | 商品原始价格(划线价格)-金额,originalPriceType=AMOUNT 时生效,最高精确度为两位小数,如 12.34 |
| customOrignalPrice | false | String | 商品原始价格(划线价格)-自定义,originalPriceType=CUSTOM 时生效,最多20个字符 备注:如果 price 和 customOriginalPrice 都为空,则表示不启用原始价格(划线价格) |
| - | - | - | 以上为普通商品专用参数 (productType=normal) |
EXT
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| coverList | true | Array | 封面图地址数组,最多15个 |
| videoList | false | Array | 视频数组,最多1个【详情见ChannelProductExtVideo】需要开通素材库才能用 |
| jumpWay | false | String | 购买方式为外链购买-通用链接的跳转方式: POP_UP-弹出框打开、NEW_WINDOW-新窗口打开、CURRENT_WINDOW-当前窗口打开 |
ChannelProductExtVideo
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| videoId | true | String | 视频ID |
| videoSource | true | String | 视频来源: MATERIAL_LIBRARY-素材库 |
示例
http://api.polyv.net/live/v3/channel/product/update?appId=frlr1zazn3&sign=4C8FCD995644EEB248AB2CE70329F4D2&channelId=1965681×tamp=1621843510009
请求体参数
{
"productId": 27538,
"name": "开心豆",
"price": 0.99,
"cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
"link": "",
"status": 1,
"realPrice": 1.99,
"yield": "87.99%",
"linkType": 11,
"pcLink": "https://www.polyv.net/",
"mobileLink": "",
"wxMiniprogramLink": "",
"wxMiniprogramOriginalId": "",
"mobileAppLink": "",
"params": "{\"color\": \"red\"}",
"productDetail" : "<p>这是商品详情!</p>"
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | String | 响应成功返回SUCCESS,失败返回空 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 修改商品信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testUpdateChannelProduct() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/product/update";
String channelId = "1965681";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
String body = "{\"productId\":27538,\"name\":\"开心豆\",\"price\":0.99,\"cover\":\"//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235\",\"link\":\"\",\"status\":1,\"realPrice\":1.99,\"linkType\":11,\"pcLink\":\"https://www.polyv.net\",\"mobileLink\":\"\",\"wxMiniprogramLink\":\"\",\"wxMiniprogramOriginalId\":\"\",\"mobileAppLink\":\"\",\"params\":\"{\\\"cc\\\": 11}\"}";
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, body, null);
log.info("测试修改商品信息:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": "SUCCESS"
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
