文档中心 > API文档

taobao.refunds.receive.get (查询卖家收到的退款列表)

查询卖家收到的退款列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String [] 必须 refund_id, tid, title,buyer_nick, seller_nick, total_fee, status, created, refund_fee,refund_phase,dispute_type
  • 最大列表长度:100
  • 需要返回的字段。目前支持有:refund_id, tid, title, buyer_nick, seller_nick, total_fee, status, created, refund_fee, oid, good_status, company_name, sid, payment, reason, desc, has_good_return, modified, order_status,refund_phase,dispute_type,end_time
    status String 可选 WAIT_SELLER_AGREE 退款状态,默认查询所有退款状态的数据,除了默认值外每次只能查询一种状态。WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功)WAIT_BUYER_CONFIRM_EXCHANGE_SELLER_SEND_GOODS(等待买家确认换货卖家发货商品)EXCHANGE_TRANSFORM_TO_REFUND(换货关闭转退款)WAIT_SELLER_CONSIGN_GOODS(商家确认收货等待商家发货)
    type String 可选 fixed 交易类型列表,一次查询多种类型可用半角逗号分隔,默认同时查询guarantee_trade, auto_delivery这两种类型的数据,查看可选值
    start_modified Date 可选 2000-01-01 00:00:00 查询修改时间开始。格式: yyyy-MM-dd HH:mm:ss
    end_modified Date 可选 2000-01-01 00:00:00 查询修改时间结束。格式: yyyy-MM-dd HH:mm:ss
    page_no Number 可选 1
  • 默认值:1
  • 最小值:1
  • 页码。取值范围:大于零的整数; 默认值:1
    page_size Number 可选 40
  • 默认值:40
  • 最小值:1
  • 最大值:100
  • 每页条数。取值范围:大于零的整数; 默认值:40;最大值:100
    use_has_next Boolean 可选 true
  • 默认值:false
  • 是否启用has_next的分页方式,如果指定true,则返回的结果中不包含总记录数,但是会新增一个是否存在下一页的的字段,通过此种方式获取增量退款,接口调用成功率在原有的基础上有所提升。
    ouid String 可选 iuwerkjhffd 系统自动生成
    buyer_open_uid String 可选 AXADSASDSDSDSSS 买家OpenId
    buyer_nick String 可选 hz0799 买家昵称

    响应参数

    名称 类型 示例值 描述
    total_results Number 100 搜索到的退款信息总数
    has_next Boolean true 是否存在下一页
    refunds Refund [] 搜索到的退款信息列表
    • └ refund_id
    • String
    • 83477
    • 退款单号
    • └ tid
    • Number
    • 2231884277
    • 淘宝交易单号
    • └ oid
    • Number
    • 2231884277
    • 子订单号。如果是单笔交易oid会等于tid
    • └ total_fee
    • String
    • 10.00
    • 交易总金额。精确到2位小数;单位:元。如:200.07,表示:200元7分
    • └ seller_nick
    • String
    • tbtest869
    • 卖家昵称
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 退款申请时间。格式:yyyy-MM-dd HH:mm:ss
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 更新时间。格式:yyyy-MM-dd HH:mm:ss
    • └ order_status
    • String
    • BUYER_RECEIVED
    • 退款对应的订单交易状态。可选值TRADE_NO_CREATE_PAY(没有创建支付宝交易) WAIT_BUYER_PAY(等待买家付款) WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) TRADE_BUYER_SIGNED(买家已签收,货到付款专用) TRADE_FINISHED(交易成功) TRADE_CLOSED(交易关闭) TRADE_CLOSED_BY_TAOBAO(交易被淘宝关闭) ALL_WAIT_PAY(包含:WAIT_BUYER_PAY、TRADE_NO_CREATE_PAY) ALL_CLOSED(包含:TRADE_CLOSED、TRADE_CLOSED_BY_TAOBAO) 取自"http://open.taobao.com/dev/index.php/%E4%BA%A4%E6%98%93%E7%8A%B6%E6%80%81"
    • └ status
    • String
    • SUCCESS
    • 退款状态。可选值WAIT_SELLER_AGREE(买家已经申请退款,等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款,等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货,等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功)
    • └ good_status
    • String
    • BUYER_RECEIVED
    • 货物状态。可选值BUYER_NOT_RECEIVED (买家未收到货) BUYER_RECEIVED (买家已收到货) BUYER_RETURNED_GOODS (买家已退货)
    • └ has_good_return
    • Boolean
    • true
    • 买家是否需要退货。可选值:true(是),false(否)
    • └ refund_fee
    • String
    • 10.00
    • 退还金额(退还给买家的金额)。精确到2位小数;单位:元。如:200.07,表示:200元7分
    • └ payment
    • String
    • 200.07
    • 支付给卖家的金额(交易总金额-退还给买家的金额)。精确到2位小数;单位:元。如:200.07,表示:200元7分
    • └ reason
    • String
    • 退还邮费
    • 退款原因
    • └ desc
    • String
    • hello world
    • 退款说明
    • └ title
    • String
    • 天堂伞龙井茶
    • 商品标题
    • └ num
    • Number
    • 1
    • 商品购买数量
    • └ company_name
    • String
    • 申通快递
    • 物流公司名称
    • └ sid
    • String
    • 123456789
    • 退货运单号
    • └ refund_phase
    • String
    • onsale
    • 退款阶段,可选值:onsale/aftersale
    • └ refund_version
    • Number
    • 1411375308927
    • 退款版本号(时间戳)
    • └ sku
    • String
    • 30004447689|颜色分类:军绿色;尺码:XS
    • 商品SKU信息
    • └ attribute
    • String
    • {"key1":"value1", "key2":"value2"}
    • 退款扩展属性
    • └ outer_id
    • String
    • ISBN-001
    • 商品外部商家编码
    • └ operation_contraint
    • String
    • refund_onweb
    • 退款约束,可选值:cannot_refuse(不允许操作),refund_onweb(需要到网页版操作)
    • └ ouid
    • String
    • iuwekjhffd
    • ouid
    • └ buyer_open_uid
    • String
    • 324324324
    • 买家账号的OpenUID
    • └ buyer_nick
    • String
    • tbtest561
    • 买家昵称
    • └ dispute_type
    • String
    • REFUND
    • 退款类型
    • └ end_time
    • Date
    • 2000-01-01 00:00:00
    • 完结时间。格式:yyyy-MM-dd HH:mm:ss

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    RefundsReceiveGetRequest req = new RefundsReceiveGetRequest();
    req.setFields("refund_id, tid, title,buyer_nick, seller_nick, total_fee, status, created, refund_fee,refund_phase,dispute_type");
    req.setStatus("WAIT_SELLER_AGREE");
    req.setType("fixed");
    req.setStartModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setPageNo(1L);
    req.setPageSize(40L);
    req.setUseHasNext(true);
    req.setOuid("iuwerkjhffd");
    req.setBuyerOpenUid("AXADSASDSDSDSSS");
    req.setBuyerNick("hz0799");
    RefundsReceiveGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <refunds_receive_get_response>
        <total_results>100</total_results>
        <has_next>true</has_next>
        <refunds>
            <refund>
                <refund_id>83477</refund_id>
                <tid>2231884277</tid>
                <oid>2231884277</oid>
                <total_fee>10.00</total_fee>
                <seller_nick>tbtest869</seller_nick>
                <created>2000-01-01 00:00:00</created>
                <modified>2000-01-01 00:00:00</modified>
                <order_status>BUYER_RECEIVED</order_status>
                <status>SUCCESS</status>
                <good_status>BUYER_RECEIVED</good_status>
                <has_good_return>true</has_good_return>
                <refund_fee>10.00</refund_fee>
                <payment>200.07</payment>
                <reason>退还邮费</reason>
                <desc>hello world</desc>
                <title>天堂伞龙井茶</title>
                <num>1</num>
                <company_name>申通快递</company_name>
                <sid>123456789</sid>
                <refund_phase>onsale</refund_phase>
                <refund_version>1411375308927</refund_version>
                <sku>30004447689|颜色分类:军绿色;尺码:XS</sku>
                <attribute>{&quot;key1&quot;:&quot;value1&quot;, &quot;key2&quot;:&quot;value2&quot;}</attribute>
                <outer_id>ISBN-001</outer_id>
                <operation_contraint>refund_onweb</operation_contraint>
                <ouid>iuwekjhffd</ouid>
                <buyer_open_uid>324324324</buyer_open_uid>
                <buyer_nick>tbtest561</buyer_nick>
                <dispute_type>REFUND</dispute_type>
                <end_time>2000-01-01 00:00:00</end_time>
            </refund>
        </refunds>
    </refunds_receive_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.user-not-exist
    isp.call-limited
    isv.seller-flow-controll

    API工具

    如何获得此API

    FAQ

    返回
    顶部