文档中心 > API类目 > 淘宝退款API

taobao.refunds.apply.get (查询买家申请的退款列表)

查询买家申请的退款列表,且查询外店的退款列表时需要指定交易类型

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String [] 必须 refund_id, tid, title, buyer_nick, seller_nick, total_fee, status, created, refund_fee
  • 最大列表长度:20
  • 需要返回的字段。目前支持有:refund_id, tid, title, buyer_nick, seller_nick, total_fee, status, created, refund_fee
    seller_nick String 可选 hz0799 卖家昵称
    status String 可选 WAIT_SELLER_CONFIRM_GOODS 退款状态,默认查询所有退款状态的数据,除了默认值外每次只能查询一种状态。 WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功)
    type String 可选 fixed 交易类型列表,一次查询多种类型可用半角逗号分隔,默认同时查询guarantee_trade, auto_delivery的2种类型的数据。 fixed(一口价) auction(拍卖) guarantee_trade(一口价、拍卖) independent_simple_trade(旺店入门版交易) independent_shop_trade(旺店标准版交易) auto_delivery(自动发货) ec(直冲) cod(货到付款) fenxiao(分销) game_equipment(游戏装备) shopex_trade(ShopEX交易) netcn_trade(万网交易) external_trade(统一外部交易)
    page_no Number 可选 1
  • 默认值:1
  • 页码。传入值为 1 代表第一页,传入值为 2 代表第二页,依此类推。默认返回的数据是从第一页开始
    page_size Number 可选 40
  • 默认值:40
  • 每页条数。取值范围:大于零的整数; 默认值:40;最大值:100

    响应参数

    名称 类型 示例值 描述
    total_results Number 100 搜索到的交易信息总数
    refunds Refund [] 搜索到的退款信息列表
    • └ refund_id
    • String
    • 83477
    • 退款单号
    • └ tid
    • Number
    • 2231884277
    • 淘宝交易单号
    • └ seller_nick
    • String
    • tbtest869
    • 卖家昵称
    • └ total_fee
    • String
    • 10.00
    • 交易总金额。精确到2位小数;单位:元。如:200.07,表示:200元7分
    • └ status
    • String
    • SUCCESS
    • 退款状态。可选值WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功)
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 退款申请时间。格式:yyyy-MM-dd HH:mm:ss
    • └ refund_fee
    • String
    • 10.00
    • 退还金额(退还给买家的金额)。精确到2位小数;单位:元。如:200.07,表示:200元7分
    • └ title
    • String
    • 天堂伞龙井茶
    • 商品标题
    • └ buyer_open_uid
    • String
    • SJHKFHKKWHS
    • 买家openUid
    • └ buyer_nick
    • String
    • tbtest561
    • 买家昵称

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    RefundsApplyGetRequest req = new RefundsApplyGetRequest();
    req.setFields("refund_id, tid, title, buyer_nick, seller_nick, total_fee, status, created, refund_fee");
    req.setSellerNick("hz0799");
    req.setStatus("WAIT_SELLER_CONFIRM_GOODS");
    req.setType("fixed");
    req.setPageNo(1L);
    req.setPageSize(40L);
    RefundsApplyGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <refunds_apply_get_response>
        <total_results>100</total_results>
        <refunds>
            <refund>
                <refund_id>83477</refund_id>
                <tid>2231884277</tid>
                <seller_nick>tbtest869</seller_nick>
                <total_fee>10.00</total_fee>
                <status>SUCCESS</status>
                <created>2000-01-01 00:00:00</created>
                <refund_fee>10.00</refund_fee>
                <title>天堂伞龙井茶</title>
                <buyer_open_uid>SJHKFHKKWHS</buyer_open_uid>
                <buyer_nick>tbtest561</buyer_nick>
            </refund>
        </refunds>
    </refunds_apply_get_response>

    异常示例

    • 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

    返回
    顶部