淘宝开放平台

请求地址：

环境	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_order_detail_request	RefundOrderDetailRequest	必须			查询参数
└ refund_order_id String 必须 ER262764042425290474 退款单号 └ out_order_id String 必须 sr_haoka_test_001 采购单外部ID

名称	类型	示例值	描述
result	Result		返回对象
└ code String 200 错误编码 data RefundOrderDetailDTO 退款单明细对象 └ refund_create_time Date 2024-02-19 13:05:58 退款单申请时间 └ refund_end_time Date 2024-02-22 13:05:58 退款结束时间 └ out_order_id String 125007_sr_haoka_test_001 采购单ID └ refund_order_id String 262724256404290474 退款单ID └ tb_order_id String 3783289106002297404 淘宝主订单号 └ tb_sub_order_id String 3783289106002297404 淘宝子订单号 └ total_price String 1000 交易总金额 └ biz_claim_type Number 1 退款类型;1,仅退款;3,退货退款 └ refund_status String 1 退款单状态 1:退款单创建;2:卖家同意退款;3:卖家拒绝退款;4:卖家同意退货; 5:买家已寄回;6:退款单完成;7:退款单已取消; refund_item RefundItemDTO 退款商品明细 └ epp_item_id String EA671282901618 epp商品ID └ item_title String IPhone 15Plus 商品名称 └ sku_id Number 5005100554551 SKUId └ sku_title String 颜色分类:天蓝色 sku名称 └ buy_amount Number 2 购买数量 └ refund_amount Number 2 退货数量 └ price String 12.01 epp商品单价(单位:元) └ refund_item_total_price String 12.01 epp退款金额(单位:元) refund_reason RefundItemDTO 退款原因 └ reason_text String 不想要了退款原因 proof_picture_list RefundProofPictureDTO [] 退款凭证图片列表 └ pict_url String http://xxxxxx 图片链接 return_contact RefundReasonDTO 退货联系人信息 └ contact_name String 张三联系人姓名 └ mobile String 13888888888 联系人电话 └ province_name String 浙江省收件地址省名称 └ city_name String 杭州市市名称 └ area_name String 西湖区区名称 └ town_name String 文新街道乡镇名称/街道地址 └ address_detail String 迦南公寓XX幢xxx室街道地址详情 └ complete_address String 浙江省杭州市西湖区文新街道迦南公寓XX幢xxx室详细地址 return_delivery RefundReturnContactDTO 退款单物流信息 └ mail_no String 611412845207816 退货运单号 └ cp_name String 圆通快递物流公司名称 └ apply_time Date 2024-02-22 13:05:58 退货提交时间 └ seller_refuse_reason String 有购买凭证卖家拒绝退款原因 └ buyer_refund_desc String 是假货，跟商品描述不一致买家退款留言 └ success Boolean true 调用是否成功 └ message String 成功调用失败原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
EppRefundGetRequest req = new EppRefundGetRequest();
EppRefundGetRequest.RefundOrderDetailRequest obj1 = new EppRefundGetRequest.RefundOrderDetailRequest();
obj1.setRefundOrderId("ER262764042425290474");
obj1.setOutOrderId("sr_haoka_test_001");
req.setRefundOrderDetailRequest(obj1);
EppRefundGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
EppRefundGetRequest req = new EppRefundGetRequest();
EppRefundGetRequest.RefundOrderDetailRequestDomain obj1 = new EppRefundGetRequest.RefundOrderDetailRequestDomain();
obj1.RefundOrderId = "ER262764042425290474";
obj1.OutOrderId = "sr_haoka_test_001";
req.RefundOrderDetailRequest_ = obj1;
EppRefundGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new EppRefundGetRequest;
$refund_order_detail_request = new RefundOrderDetailRequest;
$refund_order_detail_request->refund_order_id="ER262764042425290474";
$refund_order_detail_request->out_order_id="sr_haoka_test_001";
$req->setRefundOrderDetailRequest(json_encode($refund_order_detail_request));
$resp = $c->execute($req);

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.epp.refund.get' \
-d 'partner_id=apidoc' \
-d 'sign=8EA7F390170BA43F330DC29C1FE9CF17' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+15%3A45%3A10' \
-d 'v=2.0' \
-d 'refund_order_detail_request=null'

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

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

req.refund_order_detail_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	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.epp.refund.get");
add_param(pRequest,"refund_order_detail_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.epp.refund.get', {
	'refund_order_detail_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<epp_refund_get_response>
    <result>
        <code>200</code>
        <data>
            <refund_create_time>2024-02-19 13:05:58</refund_create_time>
            <refund_end_time>2024-02-22 13:05:58</refund_end_time>
            <out_order_id>125007_sr_haoka_test_001</out_order_id>
            <refund_order_id>262724256404290474</refund_order_id>
            <tb_order_id>3783289106002297404</tb_order_id>
            <tb_sub_order_id>3783289106002297404</tb_sub_order_id>
            <total_price>1000</total_price>
            <biz_claim_type>1</biz_claim_type>
            <refund_status>1</refund_status>
            <refund_item>
                <epp_item_id>EA671282901618</epp_item_id>
                <item_title>IPhone 15Plus</item_title>
                <sku_id>5005100554551</sku_id>
                <sku_title>颜色分类:天蓝色</sku_title>
                <buy_amount>2</buy_amount>
                <refund_amount>2</refund_amount>
                <price>12.01</price>
                <refund_item_total_price>12.01</refund_item_total_price>
            </refund_item>
            <refund_reason>
                <reason_text>不想要了</reason_text>
                <proof_picture_list>
                    <refund_proof_picture_d_t_o>
                        <pict_url>http://xxxxxx</pict_url>
                    </refund_proof_picture_d_t_o>
                </proof_picture_list>
            </refund_reason>
            <return_contact>
                <contact_name>张三</contact_name>
                <mobile>13888888888</mobile>
                <province_name>浙江省</province_name>
                <city_name>杭州市</city_name>
                <area_name>西湖区</area_name>
                <town_name>文新街道</town_name>
                <address_detail>迦南公寓XX幢xxx室</address_detail>
                <complete_address>浙江省杭州市西湖区文新街道迦南公寓XX幢xxx室</complete_address>
            </return_contact>
            <return_delivery>
                <mail_no>611412845207816</mail_no>
                <cp_name>圆通快递</cp_name>
                <apply_time>2024-02-22 13:05:58</apply_time>
            </return_delivery>
            <seller_refuse_reason>有购买凭证</seller_refuse_reason>
            <buyer_refund_desc>是假货，跟商品描述不一致</buyer_refund_desc>
        </data>
        <success>true</success>
        <message>成功</message>
    </result>
</epp_refund_get_response>

{
    "epp_refund_get_response":{
        "result":{
            "code":"200",
            "data":{
                "refund_create_time":"2024-02-19 13:05:58",
                "refund_end_time":"2024-02-22 13:05:58",
                "out_order_id":"125007_sr_haoka_test_001",
                "refund_order_id":"262724256404290474",
                "tb_order_id":"3783289106002297404",
                "tb_sub_order_id":"3783289106002297404",
                "total_price":"1000",
                "biz_claim_type":1,
                "refund_status":"1",
                "refund_item":{
                    "epp_item_id":"EA671282901618",
                    "item_title":"IPhone 15Plus",
                    "sku_id":5005100554551,
                    "sku_title":"颜色分类:天蓝色",
                    "buy_amount":2,
                    "refund_amount":2,
                    "price":"12.01",
                    "refund_item_total_price":"12.01"
                },
                "refund_reason":{
                    "reason_text":"不想要了",
                    "proof_picture_list":{
                        "refund_proof_picture_d_t_o":[
                            {
                                "pict_url":"http:\/\/xxxxxx"
                            }
                        ]
                    }
                },
                "return_contact":{
                    "contact_name":"张三",
                    "mobile":"13888888888",
                    "province_name":"浙江省",
                    "city_name":"杭州市",
                    "area_name":"西湖区",
                    "town_name":"文新街道",
                    "address_detail":"迦南公寓XX幢xxx室",
                    "complete_address":"浙江省杭州市西湖区文新街道迦南公寓XX幢xxx室"
                },
                "return_delivery":{
                    "mail_no":"611412845207816",
                    "cp_name":"圆通快递",
                    "apply_time":"2024-02-22 13:05:58"
                },
                "seller_refuse_reason":"有购买凭证",
                "buyer_refund_desc":"是假货，跟商品描述不一致"
            },
            "success":true,
            "message":"成功"
        }
    }
}

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.epp.refund.get (逆向订单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ