淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
batch_query_refund_request	BatchQueryRefundRequest	可选			查询条件
└ end_time Date 必须 2017-08-06 00:00:00 结束时间，必填 └ order_client String 可选 APP 下单终端：APP/POS，非必填 └ page_index Number 必须 0 页码，从0开始，必填 └ page_size Number 可选 20 页大小，必填 └ start_time Date 必须 2017-08-05 00:00:00 开始时间，必填 └ store_ids String [] 可选 122222 店铺ID列表，order_from=4时必填，其他非必填 └ sync_status String 可选 SYNCED 废弃字段 └ order_from Number 可选 4 渠道来源 3：饿了么 4：盒马&淘鲜达 20：商家自有渠道，必填 └ shop_id String 可选 123 渠道店id，order_from=4时非必填，其他必填 └ store_id String 可选 123 经营店id，非必填 └ biz_type String 可选 aelophy aelophy 翱象商家必填

名称	类型	示例值	描述
result	OrderSyncRefundListResult		结果内容
└ next_index Number 1 下一页 orders OrderSyncRefundDto [] 退款单集合 └ buy_amount_stock String 1 库存单位购买数量 └ item_code Number 12123 商品skucode └ ns_quantity String 1 非标品购买数量 └ operator_id String 2323 操作人id └ operator_name String TESTER 操作人name └ origin_order_id Number 123123 盒马子订单号 └ origin_parent_id Number 234555 盒马主订单号 └ pick_amount_stock String 1 库存单位拣货数量 └ quantity Number 1 原购买数量 └ refund_amount Number 1 退款金额 refund_channel_list OrderSyncRefundChannel [] 退款渠道 └ refund_amount Number 1 退款金额 └ refund_channel Number 1 退款渠道，0-付款码支付，1-盒马在线码－普通支付（pos），2-盒马在线码－免密协议支付（pos），3-银联刷卡（旧pos），4-现金（pos），5-支付宝离线码（pos），6-支付宝快捷支付（app），7-支付平台, 8-国际支付宝, 9-支付宝当面付, 10-网商银行信任付, 11-支付宝, 12-支付宝, 13-网商银行融易收, 14-现金, 15-银行卡, 16-支票, 17-三江购物券, 18-三江赊销，19-三江会员卡，20-三江储值卡，21-三江储值卡退卡，22-人人乐钱包, 23-人人乐提货卡 └ refund_order_id String 123123 退款id └ refund_order_id Number 123123 退款id └ refund_quantity String 1 退款数量 └ refund_time Date 2017-08-05 00:00:00 退款时间 └ refund_type Number 1 1:自助退款,2:客户当面拒收,3:补差退款,4:拒单退款,5:代退款,6:无法联系到客户退款,7:无货签收退款 └ sell_unit String 1 非标品单位 └ store_id String 123123 店铺码 └ tb_biz_order_id Number 123123123123 淘系子订单号 └ batch_time Date 2017-08-05 00:00:00 批次时间 └ order_client Number 2 2-APP, 3-POS,1-其他 └ actual_pick_quantity String 1 实际取货数量 └ actual_refund_quantity String 1 实际退款数量 └ promise_status String OUT_OF_STOCK 履约的状态 └ refund_post_fee Number 100 退款的运费，单位分 └ stock_unit String kg 库存单位 └ sale_unit String 份销售单位 └ tb_biz_parent_id Number 12324343 淘系主订单号 └ attributes String {"wdkPointType":"2"} attributes └ trade_attributes String {"refundType":"2"} java.util.Map └ sku_code String 098781 商品skucode └ open_uid String 12443545 open_uid └ order_from Number 3 渠道来源 3：饿了么 4：盒马 └ out_order_id String 123 外部子订单id └ out_mian_order_id String 123 外部主订单id └ shop_id String 123 渠道店id └ out_sku_code String 123 外部skuCode └ dispute_type Number 123 纠纷类型 1：售中 2：售后 └ out_refund_id String 123 外部退款id └ out_shop_id String 123 外部门店id └ refund_status String SUCCESS 退单状态 APPLY：申请，待审核，REFUSE：审核拒绝，AGREE：审核同意（退款中），SUCCESS：退款成功，CANCEL：取消申请，PLATFROM_DEAL：平台仲裁中，FAILED：退款失败 └ refund_sale_quantity Number 3 退款销售数量 └ biz_main_refund_id String 123 退款业务单号 └ out_main_refund_id String 123 外部退款单号 └ return_code String HM02008888888001 接口返回码 └ return_msg String 成功结果信息 └ success Boolean true 是否成功。调用方需要根据该字段判断是否成功，如果失败进行重试 └ total_number Number 100 返回本查询条件下的数据总数。仅在传入page_index=0时返回,在其他情况下返回0

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkOrderRefundListRequest req = new AlibabaWdkOrderRefundListRequest();
AlibabaWdkOrderRefundListRequest.BatchQueryRefundRequest obj1 = new AlibabaWdkOrderRefundListRequest.BatchQueryRefundRequest();
obj1.setEndTime(StringUtils.parseDateTime("2017-08-06 00:00:00"));
obj1.setOrderClient("APP");
obj1.setPageIndex(0L);
obj1.setPageSize(20L);
obj1.setStartTime(StringUtils.parseDateTime("2017-08-05 00:00:00"));
obj1.setStoreIds("122222");
obj1.setSyncStatus("SYNCED");
obj1.setOrderFrom(4L);
obj1.setShopId("123");
obj1.setStoreId("123");
obj1.setBizType("aelophy");
req.setBatchQueryRefundRequest(obj1);
AlibabaWdkOrderRefundListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkOrderRefundListRequest req = new AlibabaWdkOrderRefundListRequest();
AlibabaWdkOrderRefundListRequest.BatchQueryRefundRequestDomain obj1 = new AlibabaWdkOrderRefundListRequest.BatchQueryRefundRequestDomain();
obj1.EndTime = DateTime.Parse(2017-08-06 00:00:00");
obj1.OrderClient = "APP";
obj1.PageIndex = 0L;
obj1.PageSize = 20L;
obj1.StartTime = DateTime.Parse(2017-08-05 00:00:00");
obj1.StoreIds = "122222";
obj1.SyncStatus = "SYNCED";
obj1.OrderFrom = 4L;
obj1.ShopId = "123";
obj1.StoreId = "123";
obj1.BizType = "aelophy";
req.BatchQueryRefundRequest_ = obj1;
AlibabaWdkOrderRefundListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkOrderRefundListRequest;
$batch_query_refund_request = new BatchQueryRefundRequest;
$batch_query_refund_request->end_time="2017-08-06 00:00:00";
$batch_query_refund_request->order_client="APP";
$batch_query_refund_request->page_index="0";
$batch_query_refund_request->page_size="20";
$batch_query_refund_request->start_time="2017-08-05 00:00:00";
$batch_query_refund_request->store_ids="122222";
$batch_query_refund_request->sync_status="SYNCED";
$batch_query_refund_request->order_from="4";
$batch_query_refund_request->shop_id="123";
$batch_query_refund_request->store_id="123";
$batch_query_refund_request->biz_type="aelophy";
$req->setBatchQueryRefundRequest(json_encode($batch_query_refund_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.order.refund.list' \
-d 'partner_id=apidoc' \
-d 'session=464464d2-3002-4155-93fc-45899155509e' \
-d 'sign=E652652B772292739D9C281196FB1BE3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A04%3A24' \
-d 'v=2.0' \
-d 'batch_query_refund_request=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_order_refund_list_response>
    <result>
        <next_index>1</next_index>
        <orders>
            <order_sync_refund_dto>
                <buy_amount_stock>1</buy_amount_stock>
                <item_code>12123</item_code>
                <ns_quantity>1</ns_quantity>
                <operator_id>2323</operator_id>
                <operator_name>TESTER</operator_name>
                <origin_order_id>123123</origin_order_id>
                <origin_parent_id>234555</origin_parent_id>
                <pick_amount_stock>1</pick_amount_stock>
                <quantity>1</quantity>
                <refund_amount>1</refund_amount>
                <refund_channel_list>
                    <order_sync_refund_channel>
                        <refund_amount>1</refund_amount>
                        <refund_channel>1</refund_channel>
                        <refund_order_id>123123</refund_order_id>
                    </order_sync_refund_channel>
                </refund_channel_list>
                <refund_order_id>123123</refund_order_id>
                <refund_quantity>1</refund_quantity>
                <refund_time>2017-08-05 00:00:00</refund_time>
                <refund_type>1</refund_type>
                <sell_unit>1</sell_unit>
                <store_id>123123</store_id>
                <tb_biz_order_id>123123123123</tb_biz_order_id>
                <batch_time>2017-08-05 00:00:00</batch_time>
                <order_client>2</order_client>
                <actual_pick_quantity>1</actual_pick_quantity>
                <actual_refund_quantity>1</actual_refund_quantity>
                <promise_status>OUT_OF_STOCK</promise_status>
                <refund_post_fee>100</refund_post_fee>
                <stock_unit>kg</stock_unit>
                <sale_unit>份</sale_unit>
                <tb_biz_parent_id>12324343</tb_biz_parent_id>
                <attributes>{&quot;wdkPointType&quot;:&quot;2&quot;}</attributes>
                <trade_attributes>{&quot;refundType&quot;:&quot;2&quot;}</trade_attributes>
                <sku_code>098781</sku_code>
                <open_uid>12443545</open_uid>
                <order_from>3</order_from>
                <out_order_id>123</out_order_id>
                <out_mian_order_id>123</out_mian_order_id>
                <shop_id>123</shop_id>
                <out_sku_code>123</out_sku_code>
                <dispute_type>123</dispute_type>
                <out_refund_id>123</out_refund_id>
                <out_shop_id>123</out_shop_id>
                <refund_status>SUCCESS</refund_status>
                <refund_sale_quantity>3</refund_sale_quantity>
                <biz_main_refund_id>123</biz_main_refund_id>
                <out_main_refund_id>123</out_main_refund_id>
            </order_sync_refund_dto>
        </orders>
        <return_code>HM02008888888001</return_code>
        <return_msg>成功</return_msg>
        <success>true</success>
        <total_number>100</total_number>
    </result>
</alibaba_wdk_order_refund_list_response>

{
    "alibaba_wdk_order_refund_list_response":{
        "result":{
            "next_index":1,
            "orders":{
                "order_sync_refund_dto":[
                    {
                        "buy_amount_stock":"1",
                        "item_code":12123,
                        "ns_quantity":"1",
                        "operator_id":"2323",
                        "operator_name":"TESTER",
                        "origin_order_id":123123,
                        "origin_parent_id":234555,
                        "pick_amount_stock":"1",
                        "quantity":1,
                        "refund_amount":1,
                        "refund_channel_list":{
                            "order_sync_refund_channel":[
                                {
                                    "refund_amount":1,
                                    "refund_channel":1,
                                    "refund_order_id":"123123"
                                }
                            ]
                        },
                        "refund_order_id":123123,
                        "refund_quantity":"1",
                        "refund_time":"2017-08-05 00:00:00",
                        "refund_type":1,
                        "sell_unit":"1",
                        "store_id":"123123",
                        "tb_biz_order_id":123123123123,
                        "batch_time":"2017-08-05 00:00:00",
                        "order_client":2,
                        "actual_pick_quantity":"1",
                        "actual_refund_quantity":"1",
                        "promise_status":"OUT_OF_STOCK",
                        "refund_post_fee":100,
                        "stock_unit":"kg",
                        "sale_unit":"份",
                        "tb_biz_parent_id":12324343,
                        "attributes":"{\"wdkPointType\":\"2\"}",
                        "trade_attributes":"{\"refundType\":\"2\"}",
                        "sku_code":"098781",
                        "open_uid":"12443545",
                        "order_from":3,
                        "out_order_id":"123",
                        "out_mian_order_id":"123",
                        "shop_id":"123",
                        "out_sku_code":"123",
                        "dispute_type":123,
                        "out_refund_id":"123",
                        "out_shop_id":"123",
                        "refund_status":"SUCCESS",
                        "refund_sale_quantity":3,
                        "biz_main_refund_id":"123",
                        "out_main_refund_id":"123"
                    }
                ]
            },
            "return_code":"HM02008888888001",
            "return_msg":"成功",
            "success":true,
            "total_number":100
        }
    }
}

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.order.refund.list (五道口交易退款批量查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ