淘宝开放平台

请求地址：

环境	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_goods_query_request	RefundGoodsQueryRequest	可选			查询请求
└ refund_goods_id String 必须 5838392233 退货单id └ shop_id String 必须 1002 门店id

名称	类型	示例值	描述
refund_goods_query_result	RefundGoodsQueryResult		查询结果
└ success Boolean true 是否成功 └ error_code String REFUND_ORDER_IS_NULL 错误码 └ error_msg String 订单不存在错误信息 └ refund_fetch_type String FETCH_HOME 取货类型（"FETCH_HOME"：上门；"ON_SHOP"：到店；"NONE"：无需取） └ buyer_id String 12220 买家id └ buyer_name String 张某买家姓名 └ buyer_phone String 18989898789 买家电话 └ buyer_address String 杭州市文一路买家地址 └ init_from Number 19 发起退货来源 └ init_operator String 欧尚小二发起人 └ init_memo String 退货原因发起退货备注 refund_goods_sub_order_detail_list RefundGoodsSubOrderDetail [] 退货子订单详情 └ sub_biz_order_id String 19339383 子订单号 └ fulfill_id String 39884332 履约单号 └ refund_goods_id String 2938303 退货单号 └ gmt_create Date 2018-04-09 12:00:00 创建时间 └ gmt_modified Date 2018-04-10 12:00:00 更新时间 └ expect_fulfil_start_time Date 2018-04-10 12:00:00 期望取货开始时间 └ expect_fulfil_end_time Date 2018-04-10 14:00:00 期望取货结束时间 └ expect_refund_amount String 3 期望退货件数 └ actual_refund_amount String 2 实际退货件数 └ fulfil_refund_amount String 2 履约取货件数 └ agree_refund_amount String 3 同意退货件数 └ refund_speed_type Number 2 退货类型(1:"闪退";2: "标准") └ sku_id String 3333 退货商品skuId └ auction_title String 矿泉水商品名称 └ weight_item Number 0 是否称重商品 1：是，0:否 └ item_iu String 瓶商品主计价单位 └ item_bu String 瓶商品销售单位 └ refund_status Number 10 Create(10, "已发起退货"),SellerAgree(20, "卖家已同意"),OperatorAccept(30, "配送员已接单"),OperatorReceive(40, "配送员已取货"),Finish(50, "退货结束"); └ finish_type Number 1 Init(0,"初始状态"),NoTakeGoods(1, "无需取货"),FailTakeGoods(2, "取货失败"),Timeout(3, "超时关闭"),EnterDock(4, "已入站");

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkTradeRefundQueryRequest req = new AlibabaWdkTradeRefundQueryRequest();
AlibabaWdkTradeRefundQueryRequest.RefundGoodsQueryRequest obj1 = new AlibabaWdkTradeRefundQueryRequest.RefundGoodsQueryRequest();
obj1.setRefundGoodsId("5838392233");
obj1.setShopId("1002");
req.setRefundGoodsQueryRequest(obj1);
AlibabaWdkTradeRefundQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTradeRefundQueryRequest req = new AlibabaWdkTradeRefundQueryRequest();
AlibabaWdkTradeRefundQueryRequest.RefundGoodsQueryRequestDomain obj1 = new AlibabaWdkTradeRefundQueryRequest.RefundGoodsQueryRequestDomain();
obj1.RefundGoodsId = "5838392233";
obj1.ShopId = "1002";
req.RefundGoodsQueryRequest_ = obj1;
AlibabaWdkTradeRefundQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTradeRefundQueryRequest;
$refund_goods_query_request = new RefundGoodsQueryRequest;
$refund_goods_query_request->refund_goods_id="5838392233";
$refund_goods_query_request->shop_id="1002";
$req->setRefundGoodsQueryRequest(json_encode($refund_goods_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.trade.refund.query' \
-d 'partner_id=apidoc' \
-d 'session=c0da1761-3b1d-4a36-88c3-43340f46a6b6' \
-d 'sign=7F17DEB65F194A3AF56AC0BE18876473' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+09%3A03%3A44' \
-d 'v=2.0' \
-d 'refund_goods_query_request=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_trade_refund_query_response>
    <refund_goods_query_result>
        <success>true</success>
        <error_code>REFUND_ORDER_IS_NULL</error_code>
        <error_msg>订单不存在</error_msg>
        <refund_fetch_type>FETCH_HOME</refund_fetch_type>
        <buyer_id>12220</buyer_id>
        <buyer_name>张某</buyer_name>
        <buyer_phone>18989898789</buyer_phone>
        <buyer_address>杭州市文一路</buyer_address>
        <init_from>19</init_from>
        <init_operator>欧尚小二</init_operator>
        <init_memo>退货原因</init_memo>
        <refund_goods_sub_order_detail_list>
            <refund_goods_sub_order_detail>
                <sub_biz_order_id>19339383</sub_biz_order_id>
                <fulfill_id>39884332</fulfill_id>
                <refund_goods_id>2938303</refund_goods_id>
                <gmt_create>2018-04-09 12:00:00</gmt_create>
                <gmt_modified>2018-04-10 12:00:00</gmt_modified>
                <expect_fulfil_start_time>2018-04-10 12:00:00</expect_fulfil_start_time>
                <expect_fulfil_end_time>2018-04-10 14:00:00</expect_fulfil_end_time>
                <expect_refund_amount>3</expect_refund_amount>
                <actual_refund_amount>2</actual_refund_amount>
                <fulfil_refund_amount>2</fulfil_refund_amount>
                <agree_refund_amount>3</agree_refund_amount>
                <refund_speed_type>2</refund_speed_type>
                <sku_id>3333</sku_id>
                <auction_title>矿泉水</auction_title>
                <weight_item>0</weight_item>
                <item_iu>瓶</item_iu>
                <item_bu>瓶</item_bu>
                <refund_status>10</refund_status>
                <finish_type>1</finish_type>
            </refund_goods_sub_order_detail>
        </refund_goods_sub_order_detail_list>
    </refund_goods_query_result>
</alibaba_wdk_trade_refund_query_response>

{
    "alibaba_wdk_trade_refund_query_response":{
        "refund_goods_query_result":{
            "success":true,
            "error_code":"REFUND_ORDER_IS_NULL",
            "error_msg":"订单不存在",
            "refund_fetch_type":"FETCH_HOME",
            "buyer_id":"12220",
            "buyer_name":"张某",
            "buyer_phone":"18989898789",
            "buyer_address":"杭州市文一路",
            "init_from":19,
            "init_operator":"欧尚小二",
            "init_memo":"退货原因",
            "refund_goods_sub_order_detail_list":{
                "refund_goods_sub_order_detail":[
                    {
                        "sub_biz_order_id":"19339383",
                        "fulfill_id":"39884332",
                        "refund_goods_id":"2938303",
                        "gmt_create":"2018-04-09 12:00:00",
                        "gmt_modified":"2018-04-10 12:00:00",
                        "expect_fulfil_start_time":"2018-04-10 12:00:00",
                        "expect_fulfil_end_time":"2018-04-10 14:00:00",
                        "expect_refund_amount":"3",
                        "actual_refund_amount":"2",
                        "fulfil_refund_amount":"2",
                        "agree_refund_amount":"3",
                        "refund_speed_type":2,
                        "sku_id":"3333",
                        "auction_title":"矿泉水",
                        "weight_item":0,
                        "item_iu":"瓶",
                        "item_bu":"瓶",
                        "refund_status":10,
                        "finish_type":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.trade.refund.query (外部渠道查询退货订单详情接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ