淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
supplier_refund_query_request	SupplierRefundQueryRequest	可选			查询参数
└ store_id String 可选 123 经营店id └ source_merchant_code String 可选 xbk 实际售卖商家code └ end_time Date 可选 2018-08-07 00:00:00 结束时间 └ start_time Date 可选 2018-08-06 00:00:00 开始时间 └ page_size Number 可选 200 分页大小 └ page_index Number 可选 0 页码，从0开始 └ order_client String 可选 app 下单终端：APP/POS └ order_from Number 可选 4 订单渠道 └ dispute_type Number 可选 2 1:售中退款 2:售后退款 └ shop_id String 可选 1234 渠道店id

名称	类型	示例值	描述
result	OrderSyncRefundListResult		result
└ total_number Number 341 结果总数量 orders OrderSyncRefundDto [] orders └ open_uid String 1fadfsd1wq 买家id对应的open_uid，加密过 └ sku_code String 121 skuCode └ refund_attributes String {"key":"value"} 扩展属性字段 └ tb_biz_parent_id Number 21323 淘宝主订单号 └ sale_unit String g 售卖单位 └ stock_unit String kg 库存单位 └ refund_post_fee Number 0 退款运费 └ actual_refund_quantity String 1 终审退款数量 └ actual_pick_quantity String 1 退货入站数量 └ order_client String app app,pos └ batch_time Date 2017-08-18 00:00:00 批次时间 └ tb_biz_order_id Number 1212 淘宝订单号 └ store_id String 12121 经营店id └ refund_type Number 1 退款类型 └ refund_time Date 2017-08-18 00:00:00 退款时间 └ refund_quantity String 1 退款数量 └ refund_order_id Number 12121 退款单id └ refund_amount Number 10 实际退款金额 └ pick_amount_stock String 2121 拣货库存单位数量 └ origin_parent_id Number 1212 盒马主订单号 └ origin_order_id Number 121 盒马子订单号 └ operator_name String 21 收银员 └ operator_id String 1212 收银员id └ buy_amount_stock String 1 购买库存单位数量 └ out_order_id String 12121 外部订单号 └ shop_id String e34 渠道店id └ order_from Number 4 渠道来源 └ source_merchant_code String HM 售卖商场code └ merchant_code String xingbake 供应商code └ out_sku_code String 232fwf 外部skucode refund_channel_list OrderSyncRefundChannel [] refundChannelList └ refund_order_id Number 123 refundOrderId └ refund_channel Number 4 refundChannel └ refund_amount Number 10 refundAmount └ dispute_type Number 2 1:售中退款 2:售后退款 └ return_msg String 成功 returnMsg └ return_code String HM02008888888001 returnCode └ next_index Number 2 下一页页码 └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkSupplierRefundListRequest req = new AlibabaWdkSupplierRefundListRequest();
AlibabaWdkSupplierRefundListRequest.SupplierRefundQueryRequest obj1 = new AlibabaWdkSupplierRefundListRequest.SupplierRefundQueryRequest();
obj1.setStoreId("123");
obj1.setSourceMerchantCode("xbk");
obj1.setEndTime(StringUtils.parseDateTime("2018-08-07 00:00:00"));
obj1.setStartTime(StringUtils.parseDateTime("2018-08-06 00:00:00"));
obj1.setPageSize(200L);
obj1.setPageIndex(0L);
obj1.setOrderClient("app");
obj1.setOrderFrom(4L);
obj1.setDisputeType(2L);
obj1.setShopId("1234");
req.setSupplierRefundQueryRequest(obj1);
AlibabaWdkSupplierRefundListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkSupplierRefundListRequest req = new AlibabaWdkSupplierRefundListRequest();
AlibabaWdkSupplierRefundListRequest.SupplierRefundQueryRequestDomain obj1 = new AlibabaWdkSupplierRefundListRequest.SupplierRefundQueryRequestDomain();
obj1.StoreId = "123";
obj1.SourceMerchantCode = "xbk";
obj1.EndTime = DateTime.Parse(2018-08-07 00:00:00");
obj1.StartTime = DateTime.Parse(2018-08-06 00:00:00");
obj1.PageSize = 200L;
obj1.PageIndex = 0L;
obj1.OrderClient = "app";
obj1.OrderFrom = 4L;
obj1.DisputeType = 2L;
obj1.ShopId = "1234";
req.SupplierRefundQueryRequest_ = obj1;
AlibabaWdkSupplierRefundListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkSupplierRefundListRequest;
$supplier_refund_query_request = new SupplierRefundQueryRequest;
$supplier_refund_query_request->store_id="123";
$supplier_refund_query_request->source_merchant_code="xbk";
$supplier_refund_query_request->end_time="2018-08-07 00:00:00";
$supplier_refund_query_request->start_time="2018-08-06 00:00:00";
$supplier_refund_query_request->page_size="200";
$supplier_refund_query_request->page_index="0";
$supplier_refund_query_request->order_client="app";
$supplier_refund_query_request->order_from="4";
$supplier_refund_query_request->dispute_type="2";
$supplier_refund_query_request->shop_id="1234";
$req->setSupplierRefundQueryRequest(json_encode($supplier_refund_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.supplier.refund.list' \
-d 'partner_id=apidoc' \
-d 'session=90020efa-510b-434f-b9de-788cb3e065f4' \
-d 'sign=ACDCD93636F7DE6676614F1549A5744E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A37%3A14' \
-d 'v=2.0' \
-d 'supplier_refund_query_request=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_supplier_refund_list_response>
    <result>
        <total_number>341</total_number>
        <orders>
            <order_sync_refund_dto>
                <open_uid>1fadfsd1wq</open_uid>
                <sku_code>121</sku_code>
                <refund_attributes>{&quot;key&quot;:&quot;value&quot;}</refund_attributes>
                <tb_biz_parent_id>21323</tb_biz_parent_id>
                <sale_unit>g</sale_unit>
                <stock_unit>kg</stock_unit>
                <refund_post_fee>0</refund_post_fee>
                <actual_refund_quantity>1</actual_refund_quantity>
                <actual_pick_quantity>1</actual_pick_quantity>
                <order_client>app</order_client>
                <batch_time>2017-08-18 00:00:00</batch_time>
                <tb_biz_order_id>1212</tb_biz_order_id>
                <store_id>12121</store_id>
                <refund_type>1</refund_type>
                <refund_time>2017-08-18 00:00:00</refund_time>
                <refund_quantity>1</refund_quantity>
                <refund_order_id>12121</refund_order_id>
                <refund_amount>10</refund_amount>
                <pick_amount_stock>2121</pick_amount_stock>
                <origin_parent_id>1212</origin_parent_id>
                <origin_order_id>121</origin_order_id>
                <operator_name>21</operator_name>
                <operator_id>1212</operator_id>
                <buy_amount_stock>1</buy_amount_stock>
                <out_order_id>12121</out_order_id>
                <shop_id>e34</shop_id>
                <order_from>4</order_from>
                <source_merchant_code>HM</source_merchant_code>
                <merchant_code>xingbake</merchant_code>
                <out_sku_code>232fwf</out_sku_code>
                <refund_channel_list>
                    <order_sync_refund_channel>
                        <refund_order_id>123</refund_order_id>
                        <refund_channel>4</refund_channel>
                        <refund_amount>10</refund_amount>
                    </order_sync_refund_channel>
                </refund_channel_list>
                <dispute_type>2</dispute_type>
            </order_sync_refund_dto>
        </orders>
        <return_msg>成功</return_msg>
        <return_code>HM02008888888001</return_code>
        <next_index>2</next_index>
        <success>true</success>
    </result>
</alibaba_wdk_supplier_refund_list_response>

{
    "alibaba_wdk_supplier_refund_list_response":{
        "result":{
            "total_number":341,
            "orders":{
                "order_sync_refund_dto":[
                    {
                        "open_uid":"1fadfsd1wq",
                        "sku_code":"121",
                        "refund_attributes":"{\"key\":\"value\"}",
                        "tb_biz_parent_id":21323,
                        "sale_unit":"g",
                        "stock_unit":"kg",
                        "refund_post_fee":0,
                        "actual_refund_quantity":"1",
                        "actual_pick_quantity":"1",
                        "order_client":"app",
                        "batch_time":"2017-08-18 00:00:00",
                        "tb_biz_order_id":1212,
                        "store_id":"12121",
                        "refund_type":1,
                        "refund_time":"2017-08-18 00:00:00",
                        "refund_quantity":"1",
                        "refund_order_id":12121,
                        "refund_amount":10,
                        "pick_amount_stock":"2121",
                        "origin_parent_id":1212,
                        "origin_order_id":121,
                        "operator_name":"21",
                        "operator_id":"1212",
                        "buy_amount_stock":"1",
                        "out_order_id":"12121",
                        "shop_id":"e34",
                        "order_from":4,
                        "source_merchant_code":"HM",
                        "merchant_code":"xingbake",
                        "out_sku_code":"232fwf",
                        "refund_channel_list":{
                            "order_sync_refund_channel":[
                                {
                                    "refund_order_id":123,
                                    "refund_channel":4,
                                    "refund_amount":10
                                }
                            ]
                        },
                        "dispute_type":2
                    }
                ]
            },
            "return_msg":"成功",
            "return_code":"HM02008888888001",
            "next_index":2,
            "success":true
        }
    }
}

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.supplier.refund.list (五道口按供应商拉取退款单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ