淘宝开放平台

请求地址：

环境	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_aggregate_query_request	RefundAggregateQueryRequest	可选			系统自动生成
└ start_time Date 可选 2018-06-12 00:00:00 起始时间 └ end_time Date 可选 2018-06-12 00:00:00 结束时间 └ store_id String 可选 DRF1001 门店id └ order_client String 可选 APP 下单终端: APP / POS └ operator_id String 可选 123456 收营员id └ page_index Number 可选 0 分页序号 └ page_size Number 可选 20 分页size

名称	类型	示例值	描述
result	RefundAggregateQueryResult		result
└ return_code String HM02008888888001 接口返回码. 如果返回 HM05038888888006 需重试(数据查询失败，请重试，注意限定重试次数) └ return_msg String 成功接口返回码描述 └ refund_id_list Number [] 123 退款单id列表 └ biz_id_list Number [] 1234 淘鲜达子订单id列表 └ tb_biz_id_list Number [] 12345 淘宝子订单id列表 └ total_num Number 20 结果数量 └ next_index Number 1 下一页序号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkRefundAggregateRequest req = new AlibabaWdkRefundAggregateRequest();
AlibabaWdkRefundAggregateRequest.RefundAggregateQueryRequest obj1 = new AlibabaWdkRefundAggregateRequest.RefundAggregateQueryRequest();
obj1.setStartTime(StringUtils.parseDateTime("2018-06-12 00:00:00"));
obj1.setEndTime(StringUtils.parseDateTime("2018-06-12 00:00:00"));
obj1.setStoreId("DRF1001");
obj1.setOrderClient("APP");
obj1.setOperatorId("123456");
obj1.setPageIndex(0L);
obj1.setPageSize(20L);
req.setRefundAggregateQueryRequest(obj1);
AlibabaWdkRefundAggregateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkRefundAggregateRequest req = new AlibabaWdkRefundAggregateRequest();
AlibabaWdkRefundAggregateRequest.RefundAggregateQueryRequestDomain obj1 = new AlibabaWdkRefundAggregateRequest.RefundAggregateQueryRequestDomain();
obj1.StartTime = DateTime.Parse(2018-06-12 00:00:00");
obj1.EndTime = DateTime.Parse(2018-06-12 00:00:00");
obj1.StoreId = "DRF1001";
obj1.OrderClient = "APP";
obj1.OperatorId = "123456";
obj1.PageIndex = 0L;
obj1.PageSize = 20L;
req.RefundAggregateQueryRequest_ = obj1;
AlibabaWdkRefundAggregateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkRefundAggregateRequest;
$refund_aggregate_query_request = new RefundAggregateQueryRequest;
$refund_aggregate_query_request->start_time="2018-06-12 00:00:00";
$refund_aggregate_query_request->end_time="2018-06-12 00:00:00";
$refund_aggregate_query_request->store_id="DRF1001";
$refund_aggregate_query_request->order_client="APP";
$refund_aggregate_query_request->operator_id="123456";
$refund_aggregate_query_request->page_index="0";
$refund_aggregate_query_request->page_size="20";
$req->setRefundAggregateQueryRequest(json_encode($refund_aggregate_query_request));
$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=alibaba.wdk.refund.aggregate' \
-d 'partner_id=apidoc' \
-d 'session=2a28ad86-0809-4c06-b7c3-59a07621ff90' \
-d 'sign=83C85DEEAAF6107D14D8FA13F193D76E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A19%3A37' \
-d 'v=2.0' \
-d 'refund_aggregate_query_request=null'

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

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

req.refund_aggregate_query_request=""
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,"alibaba.wdk.refund.aggregate");
add_param(pRequest,"refund_aggregate_query_request","数据结构JSON示例");
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('alibaba.wdk.refund.aggregate', {
	'refund_aggregate_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_refund_aggregate_response>
    <result>
        <return_code>HM02008888888001</return_code>
        <return_msg>成功</return_msg>
        <refund_id_list>
            <number>123</number>
        </refund_id_list>
        <biz_id_list>
            <number>1234</number>
        </biz_id_list>
        <tb_biz_id_list>
            <number>12345</number>
        </tb_biz_id_list>
        <total_num>20</total_num>
        <next_index>1</next_index>
    </result>
</alibaba_wdk_refund_aggregate_response>

{
    "alibaba_wdk_refund_aggregate_response":{
        "result":{
            "return_code":"HM02008888888001",
            "return_msg":"成功",
            "refund_id_list":{
                "number":[
                    123
                ]
            },
            "biz_id_list":{
                "number":[
                    1234
                ]
            },
            "tb_biz_id_list":{
                "number":[
                    12345
                ]
            },
            "total_num":20,
            "next_index":1
        }
    }
}

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

alibaba.wdk.refund.aggregate (淘鲜达退款单按门店聚合查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ