淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
biz_order_ids	Number []	可选	12313123	最大列表长度：20	五道口订单列表（子订单）
refund_ids	Number []	可选	132222	最大列表长度：20	退款订单列表
order_from	Number	可选	3		渠道来源 3：饿了么 4：盒马
shop_id	String	可选	123		渠道店id
store_id	String	可选	123		经营店id

名称	类型	示例值	描述
result	OrderSyncRefundListResult		结果
└ next_index Number 1 下一页 orders OrderSyncRefundDto [] 退款单具体详情 └ buy_amount_stock String 1 库存单位购买数量 └ item_code String tttt 商品skucode └ merchant_code String TESTW 商家编码 └ ns_quantity String 1 非标品购买数量 └ operator_id String 12321S 操作人id └ operator_name String SDFSD1 操作人名称 └ origin_order_id Number 1111111 盒马子订单号 └ origin_parent_id Number 2222222 盒马主订单号 └ pick_amount_stock String 1 库存单位拣货数量 └ quantity Number 1 原购买数量 └ refund_amount Number 1 退款金额 refund_channel_list OrderSyncRefundChannel [] 退款渠道列表 └ refund_amount Number 1 退款金额 └ refund_channel Number 1 退款渠道 └ refund_order_id Number 1111111 退款单id └ refund_order_id Number 1111111 退款单id └ refund_quantity String 1 退货数量 └ refund_time Date 2017-08-08 00:00:00 退款时间 └ refund_type Number 1 退款类型 └ sell_unit String kg 非标品单位 └ store_id String test 店铺码 └ sync_status String INIT 同步状态 └ tb_biz_order_id Number 2222222 淘系子订单号 └ batch_time Date 2017-08-08 00:00:00 跑批时间 └ actual_pick_quantity String 1 实际取货数量 └ actual_refund_quantity String 1 实际退货数量 └ promise_status String OUT_OF_STOCK 履约状态 └ refund_post_fee Number 100 退款运费，单位为分 └ stock_unit String 销售单位 stockUnit └ sale_unit String 库存单位 saleUnit └ tb_biz_parent_id Number 12343545 淘系主订单号 └ attributes String {"wdkPointType":"2"} 附加属性 └ trade_attributes String {"refundType":"2"} 交易属性 └ sku_code String 092141 商品skucode └ open_uid String 123456 open_uid └ order_client Number 2 2:app 3:pos └ order_from Number 3 渠道来源 3：饿了么 4：盒马 └ out_order_id String 123 外部子订单号 └ out_mian_order_id String 123 外部主订单号 └ 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 └ biz_main_refund_id String 123 退款业务单号 └ out_main_refund_id String 123 外部退款单号 └ return_code String success 结果code └ return_msg String success 返回的信息 └ success Boolean true 是否成功 └ total_number Number 100 总数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkOrderRefundGetRequest req = new AlibabaWdkOrderRefundGetRequest();
req.setBizOrderIds("12313123");
req.setRefundIds("132222");
req.setOrderFrom(3L);
req.setShopId("123");
req.setStoreId("123");
AlibabaWdkOrderRefundGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkOrderRefundGetRequest req = new AlibabaWdkOrderRefundGetRequest();
req.BizOrderIds = "12313123";
req.RefundIds = "132222";
req.OrderFrom = 3L;
req.ShopId = "123";
req.StoreId = "123";
AlibabaWdkOrderRefundGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkOrderRefundGetRequest;
$req->setBizOrderIds("12313123");
$req->setRefundIds("132222");
$req->setOrderFrom("3");
$req->setShopId("123");
$req->setStoreId("123");
$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.get' \
-d 'partner_id=apidoc' \
-d 'session=55a35586-4739-4ee7-a18d-c8c43d420a2d' \
-d 'sign=5408322151259EDFDE7C2107F30F5638' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A15%3A01' \
-d 'v=2.0' \
-d 'biz_order_ids=12313123' \
-d 'order_from=3' \
-d 'refund_ids=132222' \
-d 'shop_id=123' \
-d 'store_id=123'

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

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

req.biz_order_ids="12313123"
req.refund_ids="132222"
req.order_from=3
req.shop_id="123"
req.store_id="123"
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.get");
add_param(pRequest,"biz_order_ids","12313123");
add_param(pRequest,"refund_ids","132222");
add_param(pRequest,"order_from","3");
add_param(pRequest,"shop_id","123");
add_param(pRequest,"store_id","123");
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.get', {
	'biz_order_ids':'12313123',
	'refund_ids':'132222',
	'order_from':'3',
	'shop_id':'123',
	'store_id':'123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_order_refund_get_response>
    <result>
        <next_index>1</next_index>
        <orders>
            <order_sync_refund_dto>
                <buy_amount_stock>1</buy_amount_stock>
                <item_code>tttt</item_code>
                <merchant_code>TESTW</merchant_code>
                <ns_quantity>1</ns_quantity>
                <operator_id>12321S</operator_id>
                <operator_name>SDFSD1</operator_name>
                <origin_order_id>1111111</origin_order_id>
                <origin_parent_id>2222222</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>1111111</refund_order_id>
                    </order_sync_refund_channel>
                </refund_channel_list>
                <refund_order_id>1111111</refund_order_id>
                <refund_quantity>1</refund_quantity>
                <refund_time>2017-08-08 00:00:00</refund_time>
                <refund_type>1</refund_type>
                <sell_unit>kg</sell_unit>
                <store_id>test</store_id>
                <sync_status>INIT</sync_status>
                <tb_biz_order_id>2222222</tb_biz_order_id>
                <batch_time>2017-08-08 00:00:00</batch_time>
                <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>销售单位</stock_unit>
                <sale_unit>库存单位</sale_unit>
                <tb_biz_parent_id>12343545</tb_biz_parent_id>
                <attributes>{&quot;wdkPointType&quot;:&quot;2&quot;}</attributes>
                <trade_attributes>{&quot;refundType&quot;:&quot;2&quot;}</trade_attributes>
                <sku_code>092141</sku_code>
                <open_uid>123456</open_uid>
                <order_client>2</order_client>
                <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>
                <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>success</return_code>
        <return_msg>success</return_msg>
        <success>true</success>
        <total_number>100</total_number>
    </result>
</alibaba_wdk_order_refund_get_response>

{
    "alibaba_wdk_order_refund_get_response":{
        "result":{
            "next_index":1,
            "orders":{
                "order_sync_refund_dto":[
                    {
                        "buy_amount_stock":"1",
                        "item_code":"tttt",
                        "merchant_code":"TESTW",
                        "ns_quantity":"1",
                        "operator_id":"12321S",
                        "operator_name":"SDFSD1",
                        "origin_order_id":1111111,
                        "origin_parent_id":2222222,
                        "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":1111111
                                }
                            ]
                        },
                        "refund_order_id":1111111,
                        "refund_quantity":"1",
                        "refund_time":"2017-08-08 00:00:00",
                        "refund_type":1,
                        "sell_unit":"kg",
                        "store_id":"test",
                        "sync_status":"INIT",
                        "tb_biz_order_id":2222222,
                        "batch_time":"2017-08-08 00:00:00",
                        "actual_pick_quantity":"1",
                        "actual_refund_quantity":"1",
                        "promise_status":"OUT_OF_STOCK",
                        "refund_post_fee":100,
                        "stock_unit":"销售单位",
                        "sale_unit":"库存单位",
                        "tb_biz_parent_id":12343545,
                        "attributes":"{\"wdkPointType\":\"2\"}",
                        "trade_attributes":"{\"refundType\":\"2\"}",
                        "sku_code":"092141",
                        "open_uid":"123456",
                        "order_client":2,
                        "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",
                        "biz_main_refund_id":"123",
                        "out_main_refund_id":"123"
                    }
                ]
            },
            "return_code":"success",
            "return_msg":"success",
            "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.get (五道口订单退款按ID查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ