淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
sub_order_id	Number	可选	123	要查询的退款对应的分销子订单号
query_seller_refund	Boolean	可选	true	是否查询下游消费者订单对应退款信息
refund_id	Number	可选	456	退款单id（分销子订单号和退款单id，两者至少必填一个，都填的情况下，以退款单id为准）

名称	类型	示例值	描述
refund_detail	TopDpRefundDetailDO	111	退款详情
└ sub_order_id Number 123 分销子订单号，如果是by子单发起退款，就会在退款主单上记录分销子订单号 └ is_return_goods Boolean true 是否退货,如果是已发货退货退款/售后退货退款，就是true └ refund_create_time Date 2000-01-01 00:00:00 退款创建时间 └ refund_status Number 5 退款状态1：分销商已经申请退款，等待供应商确认2：供应商已经同意退货，等待分销商退货3：分销商已经退货，等待供应商确认收货4：退款关闭5：退款成功 6：供应商拒绝退款12：供应商同意退款，待系统打款 9：没有申请退款 10：供应商拒绝确认收货,待分销商重新修改 └ refund_fee String 100 退款的金额(元) └ pay_sup_fee String 20 支付给供应商的金额(元)，分销订单子单实付金额-退款金额 └ refund_reason String 协商一致退款退款原因 └ refund_desc String 111 退款说明 └ distributor_nick String 张三分销商nick └ supplier_nick String 张三供应商nick └ modified Date 2000-01-01 00:00:00 退款修改时间。格式:yyyy-MM-dd HH:mm:ss └ purchase_order_id Number 952795279527 分销主订单号 └ refund_flow_type Number 1 退款流程类型：4：未发货退款；1：已发货仅退款；2：已发货退货退款；3：售后仅退款；5：物流拒收；6：售后退货退款 └ timeout Date 2000-01-01 00:00:00 超时时间 └ to_type Number 1 超时类型： 1：供应商同意退款/同意退货超时； 2：供应商确认收货超时 buyer_refund BuyerRefund 前台消费者订单对应的退款详情 └ sub_order_id Number 123 分销子订单号 └ refund_id Number 123 消费者订单对应的退款单号 └ biz_order_id Number 123 消费者订单退款涉及的消费者正向子订单号 └ refund_create_time Date 2000-01-01 00:00:00 消费者订单退款创建时间 └ refund_status Number 9 消费者订单退款状态 1、消费者已经申请退款，等待分销商确认 2、分销商已经同意退货，等待消费者退货 3、消费者已经退货，等待分销商确认收货 4、退款关闭 5、退款成功 6、分销商拒绝退款,待消费者重新修改 7、等待消费者确认重新邮寄的货物 └ goods_status_desc String 买家未收到货货物的状态：买家已收到货买家已退货买家未收到货 └ need_return_goods Boolean true 买家是否退货 └ return_fee Number 120 退还给消费者的金额(分) └ to_seller_fee Number 120 确认收货后会打款给分销商的金额(分),分摊到子单的实付金额-退款给消费者的金额 └ refund_reason String 协商一致消费者退款原因 └ refund_desc String 协商一致退款消费者退款说明 └ buyer_nick String 张三消费者nick └ modified Date 2000-01-01 00:00:00 消费者退款修改时间。格式:yyyy-MM-dd HH:mm:ss └ open_buyer_id String AAAYH-4X4545dX2323 消费者淘宝id的加密key └ return_goods_quantity Number 222 消费者退货数量 └ refund_id Number 456 分销退款单号 return_logistics RefundLogistics [] 退货的物流信息 └ company_code String SF 退货物流公司编码，如顺丰、韵达等 └ company_name String 顺丰退货物流公司名称，如顺丰 └ mail_no String 12233 退货物流运单号 refund_items RefundItem [] 退款明细项，记录退款涉及的订单 └ refund_item_id Number 111111 退款明细ID，针对一笔退款每一个品就映射为一个明细，每一个明细有一个全局唯一的ID └ sub_order_id Number 23232323 分销子订单号 └ refund_quantity Number 2 退货数量

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FenxiaoRefundGetRequest req = new FenxiaoRefundGetRequest();
req.setSubOrderId(123L);
req.setQuerySellerRefund(true);
req.setRefundId(456L);
FenxiaoRefundGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FenxiaoRefundGetRequest req = new FenxiaoRefundGetRequest();
req.SubOrderId = 123L;
req.QuerySellerRefund = true;
req.RefundId = 456L;
FenxiaoRefundGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FenxiaoRefundGetRequest;
$req->setSubOrderId("123");
$req->setQuerySellerRefund("true");
$req->setRefundId("456");
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.fenxiao.refund.get' \
-d 'partner_id=apidoc' \
-d 'session=2c6b5d23-3c21-4b32-a89c-3d9ddcbc23c9' \
-d 'sign=2F018BC05412366E9D86560D49BC74C6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A45%3A45' \
-d 'v=2.0' \
-d 'query_seller_refund=true' \
-d 'refund_id=456' \
-d 'sub_order_id=123'

# -*- coding: utf-8 -*-
import top.api

req=top.api.FenxiaoRefundGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.sub_order_id=123
req.query_seller_refund=true
req.refund_id=456
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.fenxiao.refund.get");
add_param(pRequest,"sub_order_id","123");
add_param(pRequest,"query_seller_refund","true");
add_param(pRequest,"refund_id","456");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.fenxiao.refund.get', {
	'sub_order_id':'123',
	'query_seller_refund':'true',
	'refund_id':'456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<fenxiao_refund_get_response>
    <refund_detail>
        <sub_order_id>123</sub_order_id>
        <is_return_goods>true</is_return_goods>
        <refund_create_time>2000-01-01 00:00:00</refund_create_time>
        <refund_status>5</refund_status>
        <refund_fee>100</refund_fee>
        <pay_sup_fee>20</pay_sup_fee>
        <refund_reason>协商一致退款</refund_reason>
        <refund_desc>111</refund_desc>
        <distributor_nick>张三</distributor_nick>
        <supplier_nick>张三</supplier_nick>
        <modified>2000-01-01 00:00:00</modified>
        <purchase_order_id>952795279527</purchase_order_id>
        <refund_flow_type>1</refund_flow_type>
        <timeout>2000-01-01 00:00:00</timeout>
        <to_type>1</to_type>
        <buyer_refund>
            <sub_order_id>123</sub_order_id>
            <refund_id>123</refund_id>
            <biz_order_id>123</biz_order_id>
            <refund_create_time>2000-01-01 00:00:00</refund_create_time>
            <refund_status>9</refund_status>
            <goods_status_desc>买家未收到货</goods_status_desc>
            <need_return_goods>true</need_return_goods>
            <return_fee>120</return_fee>
            <to_seller_fee>120</to_seller_fee>
            <refund_reason>协商一致</refund_reason>
            <refund_desc>协商一致退款</refund_desc>
            <buyer_nick>张三</buyer_nick>
            <modified>2000-01-01 00:00:00</modified>
            <open_buyer_id>AAAYH-4X4545dX2323</open_buyer_id>
            <return_goods_quantity>222</return_goods_quantity>
        </buyer_refund>
        <refund_id>456</refund_id>
        <return_logistics>
            <refund_logistics>
                <company_code>SF</company_code>
                <company_name>顺丰</company_name>
                <mail_no>12233</mail_no>
            </refund_logistics>
        </return_logistics>
        <refund_items>
            <refund_item>
                <refund_item_id>111111</refund_item_id>
                <sub_order_id>23232323</sub_order_id>
                <refund_quantity>2</refund_quantity>
            </refund_item>
        </refund_items>
    </refund_detail>
</fenxiao_refund_get_response>

{
    "fenxiao_refund_get_response":{
        "refund_detail":{
            "sub_order_id":123,
            "is_return_goods":true,
            "refund_create_time":"2000-01-01 00:00:00",
            "refund_status":5,
            "refund_fee":"100",
            "pay_sup_fee":"20",
            "refund_reason":"协商一致退款",
            "refund_desc":"111",
            "distributor_nick":"张三",
            "supplier_nick":"张三",
            "modified":"2000-01-01 00:00:00",
            "purchase_order_id":952795279527,
            "refund_flow_type":1,
            "timeout":"2000-01-01 00:00:00",
            "to_type":1,
            "buyer_refund":{
                "sub_order_id":123,
                "refund_id":123,
                "biz_order_id":123,
                "refund_create_time":"2000-01-01 00:00:00",
                "refund_status":9,
                "goods_status_desc":"买家未收到货",
                "need_return_goods":true,
                "return_fee":120,
                "to_seller_fee":120,
                "refund_reason":"协商一致",
                "refund_desc":"协商一致退款",
                "buyer_nick":"张三",
                "modified":"2000-01-01 00:00:00",
                "open_buyer_id":"AAAYH-4X4545dX2323",
                "return_goods_quantity":222
            },
            "refund_id":456,
            "return_logistics":{
                "refund_logistics":[
                    {
                        "company_code":"SF",
                        "company_name":"顺丰",
                        "mail_no":"12233"
                    }
                ]
            },
            "refund_items":{
                "refund_item":[
                    {
                        "refund_item_id":111111,
                        "sub_order_id":23232323,
                        "refund_quantity":2
                    }
                ]
            }
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

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

开放平台

分销

taobao.fenxiao.refund.get (查询采购单退款信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ