淘宝开放平台

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

taobao.refund.get (获取单笔退款详情)

获取单笔退款详情

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String [] 必须 title,address,good_return_time,created,dispute_type,end_time
  • 最大列表长度：100
    		•  需要返回的字段。目前支持有：refund_id, alipay_no, tid, oid, buyer_nick, seller_nick, total_fee, status, created, refund_fee, good_status, has_good_return, payment, reason, desc, num_iid, title, price, num, good_return_time, company_name, sid, address, shipping_type, refund_remind_timeout, refund_phase, refund_version, operation_contraint, attribute, outer_id,dispute_type,sku,new_sku,end_time
    refund_id Number 必须 123456789 退款单号

    响应参数

    名称 类型 示例值 描述
    refund Refund 退款详情
    • └ address
    • String
    • 杭州市西湖区华星路99号
    • 卖家收货地址
    • └ advance_status
    • Number
    • 1
    • 退款先行垫付默认的未申请状态 0;退款先行垫付申请中 1;退款先行垫付，垫付完成 2;退款先行垫付，卖家拒绝收货 3;退款先行垫付，垫付关闭 4;退款先行垫付，垫付分账成功 5;
    • └ alipay_no
    • String
    • 2009101504179117
    • 支付宝交易号
    • └ attribute
    • String
    • {}
    • attribute
    • └ buyer_nick
    • String
    • tbtest561
    • 买家昵称
    • └ company_name
    • String
    • 申通快递
    • 物流公司名称
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 退款申请时间。格式:yyyy-MM-dd HH:mm:ss
    • └ cs_status
    • Number
    • 1
    • 不需客服介入1;需要客服介入2;客服已经介入3;客服初审完成4;客服主管复审失败5;客服处理完成6;系统撤销(B2B使用)，维权撤销(集市使用) 7;支持买家 8;支持卖家 9;举证中 10;开放申诉 11;
    • └ desc
    • String
    • hello world
    • 退款说明
    • └ good_return_time
    • Date
    • 2000-01-01 00:00:00
    • 退货时间。格式:yyyy-MM-dd HH:mm:ss
    • └ good_status
    • String
    • BUYER_RECEIVED
    • 货物状态。可选值BUYER_NOT_RECEIVED (买家未收到货) BUYER_RECEIVED (买家已收到货) BUYER_RETURNED_GOODS (买家已退货)
    • └ has_good_return
    • Boolean
    • true
    • 买家是否需要退货。可选值:true(是),false(否)
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 更新时间。格式:yyyy-MM-dd HH:mm:ss
    • └ num
    • Number
    • 1
    • 商品数量
    • └ num_iid
    • Number
    • 4345345
    • 申请退款的商品数字编号
    • └ oid
    • Number
    • 2231884277
    • 子订单号。如果是单笔交易oid会等于tid
    • └ operation_contraint
    • String
    • refund_onweb
    • 退款约束，可选值：cannot_refuse（不允许操作），refund_onweb（需要到网页版操作）
    • └ 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"
    • └ outer_id
    • String
    • ISBN-001
    • 商品外部商家编码
    • └ payment
    • String
    • 200.07
    • 支付给卖家的金额(交易总金额-退还给买家的金额)。精确到2位小数;单位:元。如:200.07，表示:200元7分
    • └ price
    • String
    • 200.07
    • 商品价格。精确到2位小数;单位:元。如:200.07，表示:200元7分
    • └ reason
    • String
    • 退还邮费
    • 退款原因
    • └ refund_fee
    • String
    • 10.00
    • 退还金额(退还给买家的金额)。精确到2位小数;单位:元。如:200.07，表示:200元7分
    • └ refund_id
    • String
    • 83477
    • 退款单号
    • └ refund_phase
    • String
    • onsale
    • 退款阶段，可选值：onsale(售中)/aftersale(售后)
    • refund_remind_timeout
    • RefundRemindTimeout
    • 退款超时结构RefundRemindTimeout
    • └ exist_timeout
    • Boolean
    • true
    • 是否存在超时。可选值:true(是),false(否)
    • └ remind_type
    • Number
    • 1
    • 提醒的类型（退款详情中提示信息的类型）
    • └ timeout
    • Date
    • 2000-01-01 00:00:00
    • 超时时间。格式:yyyy-MM-dd HH:mm:ss
    • └ refund_version
    • Number
    • 1411375308927
    • 退款版本号（时间戳）
    • └ seller_nick
    • String
    • tbtest869
    • 卖家昵称
    • └ shipping_type
    • String
    • free
    • 物流方式.可选值:free(卖家包邮),post(平邮),express(快递),ems(EMS).
    • └ sid
    • String
    • 123456789
    • 退货运单号
    • └ sku
    • String
    • 30004447689|颜色分类:军绿色;尺码:XS
    • 商品SKU信息
    • └ split_seller_fee
    • String
    • 1.25
    • 分账给卖家的钱
    • └ split_taobao_fee
    • String
    • 1.25
    • 分账给淘宝的钱
    • └ status
    • String
    • SUCCESS
    • 退款状态。可选值WAIT_SELLER_AGREE(买家已经申请退款，等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款，等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货，等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功)
    • └ tid
    • Number
    • 2231884277
    • 淘宝交易单号
    • └ title
    • String
    • 天堂伞龙井茶
    • 商品标题
    • └ total_fee
    • String
    • 10.00
    • 交易总金额。精确到2位小数;单位:元。如:200.07，表示:200元7分
    • └ buyer_open_uid
    • String
    • 324324324
    • 买家账号的OpenUID
    • └ ouid
    • String
    • iuwerkjhffd
    • crm改造新增ouid返回
    • combine_item_info
    • CombineSubItemDO []
    • 组合品信息
    • └ num_iid
    • String
    • 2342344
    • 商品数字编号
    • └ item_name
    • String
    • 测试商品
    • 商品标题
    • └ quantity
    • Number
    • 123
    • 数量
    • └ sku_id
    • String
    • 123
    • sku_id
    • └ outer_iid
    • String
    • 123
    • 商家外部编码(可与商家外部系统对接)
    • └ outer_sku_id
    • String
    • 123
    • 123
    • └ dispute_type
    • String
    • REFUND
    • 退款类型，可选值REFUND(退款不退货),REFUND_AND_RETURN(退货退款),TMALL_EXCHANGE(天猫换货),TAOBAO_EXCHANGE(淘宝换货),REPAIR(维修),RESHIPPING(补寄),OTHERS(其他)
    • └ end_time
    • Date
    • 2000-01-01 00:00:00
    • 完结时间。格式:yyyy-MM-dd HH:mm:ss
    • └ seller_open_uid
    • String
    • 324324324
    • 卖家账号的OpenUID
    • └ new_sku
    • String
    • 5479148571308|颜色分类:米白+浅肤;尺码:XL
    • 新修改的sku
    • └ real_receiver_open_id
    • String
    • AAEnVKOdAOIduo9TH9hjf-zb
    • 收件人淘宝加密openId
    • └ real_receiver_display_nick
    • String
    • 这是一个昵称
    • 收件人淘宝加密昵称
    • └ ypds_refund_type
    • String
    • 1
    • 退款单类型，"1"代表百亿超级半托管
    • └ ypds_refund_reason
    • String
    • 不想要了
    • 消费者发起退款原因
    • └ ypds_refund_supply_fee
    • String
    • 0.50
    • 退款货款金额，退款比例*货款总额

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    RefundGetRequest req = new RefundGetRequest();
    req.setFields("title,address,good_return_time,created,dispute_type,end_time");
    req.setRefundId(123456789L);
    RefundGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    <refund_get_response>
        <refund>
            <address>杭州市西湖区华星路99号</address>
            <advance_status>1</advance_status>
            <alipay_no>2009101504179117</alipay_no>
            <attribute>{}</attribute>
            <buyer_nick>tbtest561</buyer_nick>
            <company_name>申通快递</company_name>
            <created>2000-01-01 00:00:00</created>
            <cs_status>1</cs_status>
            <desc>hello world</desc>
            <good_return_time>2000-01-01 00:00:00</good_return_time>
            <good_status>BUYER_RECEIVED</good_status>
            <has_good_return>true</has_good_return>
            <modified>2000-01-01 00:00:00</modified>
            <num>1</num>
            <num_iid>4345345</num_iid>
            <oid>2231884277</oid>
            <operation_contraint>refund_onweb</operation_contraint>
            <order_status>BUYER_RECEIVED</order_status>
            <outer_id>ISBN-001</outer_id>
            <payment>200.07</payment>
            <price>200.07</price>
            <reason>退还邮费</reason>
            <refund_fee>10.00</refund_fee>
            <refund_id>83477</refund_id>
            <refund_phase>onsale</refund_phase>
            <refund_remind_timeout>
                <exist_timeout>true</exist_timeout>
                <remind_type>1</remind_type>
                <timeout>2000-01-01 00:00:00</timeout>
            </refund_remind_timeout>
            <refund_version>1411375308927</refund_version>
            <seller_nick>tbtest869</seller_nick>
            <shipping_type>free</shipping_type>
            <sid>123456789</sid>
            <sku>30004447689|颜色分类:军绿色;尺码:XS</sku>
            <split_seller_fee>1.25</split_seller_fee>
            <split_taobao_fee>1.25</split_taobao_fee>
            <status>SUCCESS</status>
            <tid>2231884277</tid>
            <title>天堂伞龙井茶</title>
            <total_fee>10.00</total_fee>
            <buyer_open_uid>324324324</buyer_open_uid>
            <ouid>iuwerkjhffd</ouid>
            <combine_item_info>
                <combine_sub_item_d_o>
                    <num_iid>2342344</num_iid>
                    <item_name>测试商品</item_name>
                    <quantity>123</quantity>
                    <sku_id>123</sku_id>
                    <outer_iid>123</outer_iid>
                    <outer_sku_id>123</outer_sku_id>
                </combine_sub_item_d_o>
            </combine_item_info>
            <dispute_type>REFUND</dispute_type>
            <end_time>2000-01-01 00:00:00</end_time>
            <seller_open_uid>324324324</seller_open_uid>
            <new_sku>5479148571308|颜色分类:米白+浅肤;尺码:XL</new_sku>
            <real_receiver_open_id>AAEnVKOdAOIduo9TH9hjf-zb</real_receiver_open_id>
            <real_receiver_display_nick>这是一个昵称</real_receiver_display_nick>
            <ypds_refund_type>1</ypds_refund_type>
            <ypds_refund_reason>不想要了</ypds_refund_reason>
            <ypds_refund_supply_fee>0.50</ypds_refund_supply_fee>
        </refund>
    </refund_get_response>

    异常示例

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

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-permission 权限不够、非法访问
    isv.trade-not-exist 交易不存在 传入正确的交易ID参数

    API工具

    API测试工具 错误码查询工具 SDK下载

    如何获得此API

    FAQ

    我要提问
    返回
    顶部