qimen.alibaba.uni.trade.query (全域收单交易查询接口)

全域收单订单查询接口,用于查询订单状态和详情

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
storeId String 必须 100004 门店ID
tradeNo String 可选 20180111000001595051 零售核心订单号,和外部订单号不能同时为空
outTradeNo String 可选 OT39472389645 业务方自有订单号,和零售核心订单号不能同时为空
refundNo String 可选 2343342454 零售核心退款单号,如需查询退款信息则和外部业务方退款单号不能同时为空
outRefundNo String 可选 RF43654676 外部业务方退款单号,如需查询退款信息则和零售核心退款单号不能同时为空
queryDetail Boolean 必须 false
  • 默认值:false
  • 是否要查询订单详情,默认false,仅返回订单的状态。如仅关心订单状态请设置为false
    storeIdType String 必须 RPLUS 门店Id类型,RPLUS:零售+门店ID; PLACE:商户中心门店ID; CUSTOM:自有门店ID,须在商户中心有映射关系

    响应参数

    名称 类型 示例值 描述
    success Boolean true 业务成功标识 true|false
    errCode String 601 错误码
    errMsg String 无效参数 错误描述
    data RcTradeQueryDTO 业务数据
    • └ tradeStatus
    • String
    • success
    • 交易状态。订单状态.WAIT_BUYER_PAY:等待用户付款, TRADE_SUCCESS:已付款,交易成功, TRADE_ACCEPT:已接单,需要配货的情况, TRADE_FINISHED:交易完成, TRADE_CLOSED:交易关闭;
    • └ refundStatus
    • String
    • success
    • 退款状态。退款状态。REFUND_FAILED:退款失败; REFUND_SUCCESS:退款成功,针对指定退款号; REFUND_PARTLY:部分退款,针对整单交易; REFUND_FINISHED:退款完成,针对整单交易;
    • └ totalAmount
    • String
    • 15000
    • 交易金额,单位:分(人民币)
    • └ actualPayAmount
    • String
    • 10000
    • 实付金额,单位:分(人民币)
    • └ gmtPay
    • String
    • 2018-01-12 12:34:23
    • 支付时间
    • └ gmtRefund
    • String
    • 2018-01-13 12:34:23
    • 对应退款单号的退款时间,如果没有传递退款单号且有退款,那么该字段是最近一次退款的时间
    • └ gmtCreate
    • String
    • 2018-01-12 12:34:23
    • 订单创建时间
    • └ tradeNo
    • String
    • 4326546457
    • 零售核心订单号
    • └ outTradeNo
    • String
    • OT5324543
    • 外部订单号
    • goodsList
    • RcGoodsParam []
    • 订单关联商品
    • └ goodsId
    • String
    • GB54377673
    • 商品标识
    • └ idType
    • String
    • CUSTOM
    • 商品ID类型
    • └ quantity
    • String
    • 2.0
    • 商品数量,唯一码形式quantity固定为1
    • └ price
    • String
    • 1000
    • 商品售价,会对价格做校验
    • └ guider
    • String
    • GD001
    • 导购员
    • └ outSubTradeNo
    • String
    • OT5437345
    • 商品所属外部子单号
    • customFundBillList
    • RcCustomFundBill []
    • 支付资金列表
    • └ fundBillId
    • String
    • 3242345
    • 资金渠道ID,比如支付宝单号,微信单号,代金券编号,优惠券编号
    • └ fundBillName
    • String
    • 满百减十
    • 资金渠道名称,比如支付宝钱包,微信支付,xxx代金券,xxx优惠券
    • └ amount
    • String
    • 1000
    • 对应资金渠道金额 单位分
    • refundDetailList
    • RefundDetail []
    • 退款详情
    • └ refundNo
    • String
    • 326457856
    • 零售核心退款单号
    • └ outRefundNo
    • String
    • OT357435
    • 外部退款号
    • └ refundAmount
    • String
    • 1000
    • 本次退款金额
    • └ gmtRefund
    • String
    • 2017-01-01 12:00:00
    • 本次退款时间

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
    AlibabaUniTradeQueryRequest req = new AlibabaUniTradeQueryRequest();
    req.setStoreId("100004");
    req.setTradeNo("20180111000001595051");
    req.setOutTradeNo("OT39472389645");
    req.setRefundNo("2343342454");
    req.setOutRefundNo("RF43654676");
    req.setQueryDetail(false);
    req.setStoreIdType("RPLUS");
    AlibabaUniTradeQueryResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <success>true</success>
    <errCode>601</errCode>
    <errMsg>无效参数</errMsg>
    <data>
        <tradeStatus>success</tradeStatus>
        <refundStatus>success</refundStatus>
        <totalAmount>15000</totalAmount>
        <actualPayAmount>10000</actualPayAmount>
        <gmtPay>2018-01-12 12:34:23</gmtPay>
        <gmtRefund>2018-01-13 12:34:23</gmtRefund>
        <gmtCreate>2018-01-12 12:34:23</gmtCreate>
        <tradeNo>4326546457</tradeNo>
        <outTradeNo>OT5324543</outTradeNo>
        <goodsList>
            <rc_goods_param>
                <goodsId>GB54377673</goodsId>
                <idType>CUSTOM</idType>
                <quantity>2.0</quantity>
                <price>1000</price>
                <guider>GD001</guider>
                <outSubTradeNo>OT5437345</outSubTradeNo>
            </rc_goods_param>
        </goodsList>
        <customFundBillList>
            <rc_custom_fund_bill>
                <fundBillId>3242345</fundBillId>
                <fundBillName>满百减十</fundBillName>
                <amount>1000</amount>
            </rc_custom_fund_bill>
        </customFundBillList>
        <refundDetailList>
            <refund_detail>
                <refundNo>326457856</refundNo>
                <outRefundNo>OT357435</outRefundNo>
                <refundAmount>1000</refundAmount>
                <gmtRefund>2017-01-01 12:00:00</gmtRefund>
            </refund_detail>
        </refundDetailList>
    </data>
    

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部