查询商品订单列表

接口描述

1、查询商品订单列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/product/order/list

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看 2、若参数不正确则会响应400异常

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
pageNumber	false	Integer	分页页码
pageSize	false	Integer	分页大小
queryChannelId	false	Integer	频道ID
status	false	String	订单状态，待支付:wait_pay、待发货:wait_delivery、待收货:delivering、已完成:finish、已关闭:close
deliveryType	false	String	物流方式，有物流:express、无物流:virtual
startCreateTime	false	String	订单创建开始时间，格式yyyy-MM-dd HH:mm:ss
endCreateTime	false	String	订单创建结束时间，格式yyyy-MM-dd HH:mm:ss
startPayTime	false	String	订单支付开始时间，格式yyyy-MM-dd HH:mm:ss
endPayTime	false	String	订单支付结束时间，格式yyyy-MM-dd HH:mm:ss
startDeliveryTime	false	String	订单发货开始时间，格式yyyy-MM-dd HH:mm:ss
endDeliveryTime	false	String	订单发货结束时间，格式yyyy-MM-dd HH:mm:ss
startFinishTime	false	String	订单完成开始时间，格式yyyy-MM-dd HH:mm:ss
endFinishTime	false	String	订单完成结束时间，格式yyyy-MM-dd HH:mm:ss

示例

http://api.polyv.net/live/v4/user/product/order/list?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&pageNumber=1

响应描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	响应详细信息【详见data字段说明】

Error响应描述

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

data响应描述

参数名	类型	说明
pageNumber	String	分页页码
pageSize	Integer	分页大小
totalPages	String	总页数
totalItems	String	总记录数
contents	Array	抽奖活动列表信息【详见ProductOrder字段说明】

ProductOrder响应描述

参数名	类型	说明
orderNo	String	订单ID
channelId	Integer	频道ID
viewerId	String	下单用户ID
viewerNickName	String	下单用户昵称
transactionId	String	微信订单号,支付成功才有
amount	BigDecimal	订单金额
expressEnabled	String	是否有物流，Y是、N否
status	String	订单状态，待支付:wait_pay、待发货:wait_delivery、待收货:delivering、已完成:finish、已关闭:close
createTime	Long	创建时间,13位毫秒级时间戳
payTime	Long	支付时间,13位毫秒级时间戳
deliveryTime	Long	发货时间,13位毫秒级时间戳
finishTime	Long	完成时间,13位毫秒级时间戳
addressExt	Object	收货地址信息【详见AddressExt字段说明】
products	Array	订单商品信息【详见Products字段说明】

AddressExt响应描述

参数名	类型	说明
mobile	String	手机号
name	String	收货人姓名
area	String	收货地址省市信息
address	String	收货地址详细地址

Products响应描述

参数名	类型	说明
productSnapshotId	Long	商品快照ID
amount	BigDecimal	商品单价
quantity	Integer	商品数量
totalAmount	BigDecimal	商品总金额
productName	String	商品名称
productCover	String	商品封面图片

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ProductOrderTest.class);
/**
 * 查询商品订单列表
 * @throws IOException
 */
@Test
public void testGetProductOrderList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/product/order/list";
    String page = "1";
    String size = "10";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("pageNumber",page);
    requestMap.put("pageSize", size);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询商品订单列表：{}",response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "868a149e6cda4ff19fdcb654ad50f912.68.17210341237000099",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "orderNo": "product202405221129011833ad",
                "channelId": 4872391,
                "viewerId": "c_4nv36e832udqged0g7t565t4zoasuo9y",
                "viewerNickName": "斌",
                "transactionId": "4200002204202405229969120950",
                "amount": 0.01,
                "status": "finish",
                "expireTime": 1716349441000,
                "payTime": 1716348582000,
                "deliveryTime": 1717746827000,
                "finishTime": 1717747300000,
                "createTime": 1716348541000,
                "addressExt": {
                    "mobile": "15812345678",
                    "name": "小明",
                    "area": "广东省/广州市/天河区",
                    "address": "详细地址01"
                },
                "products": [
                    {
                        "productSnapshotId": 1,
                        "amount": 0.01,
                        "quantity": 1,
                        "totalAmount": 0.01,
                        "productCover": "//liveimages.videocc.net/uploaded/images/2024/05/gwc3u3jkh0.jpg",
                        "productName": "键盘",
                        "deliveryType": "express",
                        "customerServiceType": null,
                        "customerServiceContact": null
                    }
                ],
                "expressEnabled": "Y"
            }
        ]
    },
    "success": true
}

异常示例

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