保利威文档中心

幫助中心

查詢商品訂單詳情

更新時間:2026-07-13 11:28:48

介面描述

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看 2、若參數不正確則會回應400異常

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
orderNo true String 訂單ID

範例

http://api.polyv.net/live/v4/user/product/order/get?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 回應詳細資訊【詳見ProductOrder欄位說明

Error回應描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與error.code對應

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 testGetProductOrder() 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/get";
    String orderNo = "";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("orderNo",orderNo);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询商品订单:{}",response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "ffec4cf4227c42d09f780ed0d9aa19e7.71.17210379136070035",
    "data": {
        "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
}
联系客服,在线咨询