淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
refund_id	Number	必须	237463287		分销退款单id，此参数必填
query_b2c_refund	Boolean	可选	true	默认值：false	是否查询前台消费者退款

名称	类型	示例值	描述
refund_detail	RefundDetail	null	退款单查询详情
└ refund_fee Number 0 退款金额，单位：分 └ gmt_modified Date 2000-01-01 00:00:00 退款单最后修改时间，格式 yyyy-MM-dd HH:mm:ss └ refund_status Number 50 退款单状态，10-已撤回；20-等待卖家同意；30-卖家拒绝退款，等待买家修改；40-等待买家退货；50-买家退货，等待卖家确认收货；60-卖家拒绝收货；90-等待系统打款；100-退款成功；200-退款关闭 └ refund_desc String 收单系统自动创建退款说明 └ return_goods Boolean true 是否退货 └ refund_fee_yuan String 0.00 退款金额，单位：元 └ sub_order_id Number 46164769328149 发生退款的分销子采购单id └ pay_sup_fee_yuan String 0.00 支付给供应商的金额，单位：元 └ supplier_nick String null 供应商昵称 └ refund_create_time Date 2000-01-01 00:00:00 退款创建时间 └ refund_reason String 7天无理由退款退款原因 └ distributor_nick String null 分销商昵称 buyer_refund BuyerRefund null 消费者退款单信息 └ gmt_modified Date 2000-01-01 00:00:00 消费者退款状态最后修改时间，格式 yyyy-MM-dd HH:mm:ss └ buyer_nick String 嘿再见s 消费者昵称,未来不会透出，请用open_buyer_id └ refund_reason String 7天无理由退换货退款原因 └ goods_status_desc String 买家已退货货物状态描述 └ need_return_goods Boolean true 是否需要退货 └ refund_desc String 正确单号4313979942069 退款说明 └ sub_order_id Number 46164769328149 分销子采购单id └ biz_order_id Number 1282263636531844900 前台消费者子订单id └ return_fee Number 7120 退还给消费者的金额(分) └ to_seller_fee Number 0 确认收货后会打款给分销商的金额(分),分摊到子单的实付金额-退款给消费者的金额 └ refund_create_time Date 2000-01-01 00:00:00 退款创建时间 └ refund_id Number 82881481048849340 退款id └ return_goods_quantity Number 222 消费者退货数量 └ open_buyer_id String AHHJ-454545DHJ 消费者买家id加密key └ purchase_order_id Number 46164769328149 分销采购单id └ pay_sup_fee Number 0 支付给供应商的金额，单位：分 └ refund_type Number 20 退款单类型，10-未发货退款；20-已发货退货；30-已发货仅退款；40-拒收 └ refund_status_code String RF_STATUS_WAIT_SELLER_CONFIRM_GOODS 退款单状态code，RF_STATUS_NO_REFUND-已撤回；RF_STATUS_WAIT_SELLER_AGREE-等待卖家同意；RF_STATUS_SELLER_REFUSE-卖家拒绝退款,等待买家修改；RF_STATUS_WAIT_BUYER_RETURN_GOODS-等待买家退货；RF_STATUS_WAIT_SELLER_CONFIRM_GOODS-买家退货,等待卖家确认收货；RF_STATUS_SELLER_REFUSE_RETURN_GOODS-卖家拒绝收货；RF_STATUS_WAIT_SYSTEM_TRANSFER-等待系统打款；RF_STATUS_SUCCESS-退款成功；RF_STATUS_CLOSED-退款关闭 └ refund_id Number 123423456722342 退款单id return_logistics RefundLogistics [] 退货的物流信息 └ company_code String SF 退货物流公司编码，如顺丰、韵达等 └ company_name String 顺丰退货物流公司名称，如顺丰 └ mail_no String 12233 退货物流运单号 refund_items RefundItem [] 退款明细项，记录退款涉及的订单 └ refund_item_id Number 222 退款明细ID，针对一笔退款每一个品就映射为一个明细，每一个明细有一个全局唯一的ID └ sub_order_id Number 22222 分销子订单号 └ refund_quantity Number 232323 退货数量
result_code	String	SYSTEM_EXCEPTION	返回值错误码
remark	String	系统错误	返回值错误信息
opt_time	Date	2000-01-01 00:00:00	操作时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FenxiaoYphRefundGetRequest req = new FenxiaoYphRefundGetRequest();
req.setRefundId(237463287L);
req.setQueryB2cRefund(true);
FenxiaoYphRefundGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FenxiaoYphRefundGetRequest req = new FenxiaoYphRefundGetRequest();
req.RefundId = 237463287L;
req.QueryB2cRefund = true;
FenxiaoYphRefundGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FenxiaoYphRefundGetRequest;
$req->setRefundId("237463287");
$req->setQueryB2cRefund("true");
$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.yph.refund.get' \
-d 'partner_id=apidoc' \
-d 'session=42c9190e-c7ee-4932-b26f-3b4b51edf736' \
-d 'sign=2A2FABD2A6B500010D6A8D6E76AF0E44' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A57%3A04' \
-d 'v=2.0' \
-d 'query_b2c_refund=true' \
-d 'refund_id=237463287'

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

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

req.refund_id=237463287
req.query_b2c_refund=true
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.yph.refund.get");
add_param(pRequest,"refund_id","237463287");
add_param(pRequest,"query_b2c_refund","true");
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.yph.refund.get', {
	'refund_id':'237463287',
	'query_b2c_refund':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<fenxiao_yph_refund_get_response>
    <refund_detail>
        <refund_fee>0</refund_fee>
        <gmt_modified>2000-01-01 00:00:00</gmt_modified>
        <refund_status>50</refund_status>
        <refund_desc>收单系统自动创建</refund_desc>
        <return_goods>true</return_goods>
        <refund_fee_yuan>0.00</refund_fee_yuan>
        <sub_order_id>46164769328149</sub_order_id>
        <pay_sup_fee_yuan>0.00</pay_sup_fee_yuan>
        <supplier_nick>null</supplier_nick>
        <refund_create_time>2000-01-01 00:00:00</refund_create_time>
        <refund_reason>7天无理由退款</refund_reason>
        <distributor_nick>null</distributor_nick>
        <buyer_refund>
            <gmt_modified>2000-01-01 00:00:00</gmt_modified>
            <buyer_nick>嘿再见s</buyer_nick>
            <refund_reason>7天无理由退换货</refund_reason>
            <goods_status_desc>买家已退货</goods_status_desc>
            <need_return_goods>true</need_return_goods>
            <refund_desc>正确单号4313979942069</refund_desc>
            <sub_order_id>46164769328149</sub_order_id>
            <biz_order_id>1282263636531844900</biz_order_id>
            <return_fee>7120</return_fee>
            <to_seller_fee>0</to_seller_fee>
            <refund_create_time>2000-01-01 00:00:00</refund_create_time>
            <refund_id>82881481048849340</refund_id>
            <return_goods_quantity>222</return_goods_quantity>
            <open_buyer_id>AHHJ-454545DHJ</open_buyer_id>
        </buyer_refund>
        <purchase_order_id>46164769328149</purchase_order_id>
        <pay_sup_fee>0</pay_sup_fee>
        <refund_type>20</refund_type>
        <refund_status_code>RF_STATUS_WAIT_SELLER_CONFIRM_GOODS</refund_status_code>
        <refund_id>123423456722342</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>222</refund_item_id>
                <sub_order_id>22222</sub_order_id>
                <refund_quantity>232323</refund_quantity>
            </refund_item>
        </refund_items>
    </refund_detail>
    <result_code>SYSTEM_EXCEPTION</result_code>
    <remark>系统错误</remark>
    <opt_time>2000-01-01 00:00:00</opt_time>
</fenxiao_yph_refund_get_response>

{
    "fenxiao_yph_refund_get_response":{
        "refund_detail":{
            "refund_fee":0,
            "gmt_modified":"2000-01-01 00:00:00",
            "refund_status":50,
            "refund_desc":"收单系统自动创建",
            "return_goods":true,
            "refund_fee_yuan":"0.00",
            "sub_order_id":46164769328149,
            "pay_sup_fee_yuan":"0.00",
            "supplier_nick":"null",
            "refund_create_time":"2000-01-01 00:00:00",
            "refund_reason":"7天无理由退款",
            "distributor_nick":"null",
            "buyer_refund":{
                "gmt_modified":"2000-01-01 00:00:00",
                "buyer_nick":"嘿再见s",
                "refund_reason":"7天无理由退换货",
                "goods_status_desc":"买家已退货",
                "need_return_goods":true,
                "refund_desc":"正确单号4313979942069",
                "sub_order_id":46164769328149,
                "biz_order_id":1282263636531844900,
                "return_fee":7120,
                "to_seller_fee":0,
                "refund_create_time":"2000-01-01 00:00:00",
                "refund_id":82881481048849340,
                "return_goods_quantity":222,
                "open_buyer_id":"AHHJ-454545DHJ"
            },
            "purchase_order_id":46164769328149,
            "pay_sup_fee":0,
            "refund_type":20,
            "refund_status_code":"RF_STATUS_WAIT_SELLER_CONFIRM_GOODS",
            "refund_id":123423456722342,
            "return_logistics":{
                "refund_logistics":[
                    {
                        "company_code":"SF",
                        "company_name":"顺丰",
                        "mail_no":"12233"
                    }
                ]
            },
            "refund_items":{
                "refund_item":[
                    {
                        "refund_item_id":222,
                        "sub_order_id":22222,
                        "refund_quantity":232323
                    }
                ]
            }
        },
        "result_code":"SYSTEM_EXCEPTION",
        "remark":"系统错误",
        "opt_time":"2000-01-01 00:00:00"
    }
}

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下载

开放平台

分销API

taobao.fenxiao.yph.refund.get (一盘货商家单个查询退款单信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ