淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
page_size	Number	可选	50	record count of each page, 1 - 50
start_query_index_id	String	可选	1111-2222-3333	Query index start value: if not passed, You can only check the first page
page_no	Number	可选	1	page number
start_time	String	必须	2019-08-14 00:00:00	Start time, PST time
end_time	String	必须	2019-08-19 00:00:00	End time, PST time
status	String	必须	Payment Completed	Order status: Payment Completed(Buyer paid successfully), Buyer Confirmed Receipt(This status only change when :Buyer confirms receipt and settlement task begins which is manually executed by our operation team)

名称	类型	示例值	描述
result	TrafficOrderResultDTO		result object
└ max_query_index_id String 1565850226000_101555804_1000015421011161 max query index start value: if not passed, You can only check the first page └ current_record_count Number 5 current record count orders TrafficOrderEffectDTO [] orders object list └ commission_rate String 7.00% commission rate └ order_number Number 1000012370151161 order number └ finished_amount String 10000 finished amount of the order, unit cent └ is_affiliate_product String Y is affiliate product └ is_new_buyer String N is new buyer └ item_title String local return item title └ effect_detail_status String FullRefund Additional order status, eg: full refund order, antispam order └ estimated_incentive_finished_commission String null estimated commission for finished incentive order └ estimated_incentive_paid_commission String null estimated commission for paid incentive order └ publisher_id Number 101555804 publisher id └ is_hot_product String N is hot product └ parent_order_number Number 1000012370141161 parent order number └ item_detail_url String https://xxxx.html item detail url └ created_time String 2019-08-14 01:29:03 created time of this order └ publisher_settled_currency String USD publisher settled currency └ ship_to_country String RU product shipping country └ order_id Number 1000012370141161 order id └ item_main_image_url String https://xxxx.html item main image url └ paid_time String 2019-08-14 02:00:48 paid time └ item_count String 100 item count └ item_id Number 32991483812 item id └ effect_status String Payment Completed effect status └ estimated_finished_commission String 11 estimated commission for finished order └ sub_order_id Number 1000012370151161 sub order id └ estimated_paid_commission Number 10 estimated commission for paid order └ finished_time String 2019-08-14 02:00:48 Order finish time └ paid_amount Number 2 payment amount of the order, unit cent └ category_id Number 21 category id └ incentive_commission_rate String 0% incentive commission rate └ min_query_index_id String 1565773248000_101555804_1000012370151161 min query index start value: if not passed, You can only check the first page └ current_page_no Number 5 current page number
rsp_msg	String	System Error	System Error
rsp_code	String	404	error code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliexpressDsCommissionorderListbyindexRequest req = new AliexpressDsCommissionorderListbyindexRequest();
req.setPageSize(50L);
req.setStartQueryIndexId("1111-2222-3333");
req.setPageNo(1L);
req.setStartTime("2019-08-14 00:00:00");
req.setEndTime("2019-08-19 00:00:00");
req.setStatus("Payment Completed");
AliexpressDsCommissionorderListbyindexResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliexpressDsCommissionorderListbyindexRequest req = new AliexpressDsCommissionorderListbyindexRequest();
req.PageSize = 50L;
req.StartQueryIndexId = "1111-2222-3333";
req.PageNo = 1L;
req.StartTime = "2019-08-14 00:00:00";
req.EndTime = "2019-08-19 00:00:00";
req.Status = "Payment Completed";
AliexpressDsCommissionorderListbyindexResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliexpressDsCommissionorderListbyindexRequest;
$req->setPageSize("50");
$req->setStartQueryIndexId("1111-2222-3333");
$req->setPageNo("1");
$req->setStartTime("2019-08-14 00:00:00");
$req->setEndTime("2019-08-19 00:00:00");
$req->setStatus("Payment Completed");
$resp = $c->execute($req);

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=aliexpress.ds.commissionorder.listbyindex' \
-d 'partner_id=apidoc' \
-d 'sign=AF42E26509D7D9216E6609C9D82FC9BF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-03-10+03%3A57%3A56' \
-d 'v=2.0' \
-d 'end_time=2019-08-19+00%3A00%3A00' \
-d 'page_no=1' \
-d 'page_size=50' \
-d 'start_query_index_id=1111-2222-3333' \
-d 'start_time=2019-08-14+00%3A00%3A00' \
-d 'status=Payment+Completed'

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

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

req.page_size=50
req.start_query_index_id="1111-2222-3333"
req.page_no=1
req.start_time="2019-08-14 00:00:00"
req.end_time="2019-08-19 00:00:00"
req.status="Payment Completed"
try:
	resp= req.getResponse()
	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,"aliexpress.ds.commissionorder.listbyindex");
add_param(pRequest,"page_size","50");
add_param(pRequest,"start_query_index_id","1111-2222-3333");
add_param(pRequest,"page_no","1");
add_param(pRequest,"start_time","2019-08-14 00:00:00");
add_param(pRequest,"end_time","2019-08-19 00:00:00");
add_param(pRequest,"status","Payment Completed");
pResponse = top_execute(pClient,pRequest,NULL);
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('aliexpress.ds.commissionorder.listbyindex', {
	'page_size':'50',
	'start_query_index_id':'1111-2222-3333',
	'page_no':'1',
	'start_time':'2019-08-14 00:00:00',
	'end_time':'2019-08-19 00:00:00',
	'status':'Payment Completed'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliexpress_ds_commissionorder_listbyindex_response>
    <result>
        <max_query_index_id>1565850226000_101555804_1000015421011161</max_query_index_id>
        <current_record_count>5</current_record_count>
        <orders>
            <traffic_order_effect_d_t_o>
                <commission_rate>7.00%</commission_rate>
                <order_number>1000012370151161</order_number>
                <finished_amount>10000</finished_amount>
                <is_affiliate_product>Y</is_affiliate_product>
                <is_new_buyer>N</is_new_buyer>
                <item_title>local return</item_title>
                <effect_detail_status>FullRefund</effect_detail_status>
                <estimated_incentive_finished_commission>null</estimated_incentive_finished_commission>
                <estimated_incentive_paid_commission>null</estimated_incentive_paid_commission>
                <publisher_id>101555804</publisher_id>
                <is_hot_product>N</is_hot_product>
                <parent_order_number>1000012370141161</parent_order_number>
                <item_detail_url>https://xxxx.html</item_detail_url>
                <created_time>2019-08-14 01:29:03</created_time>
                <publisher_settled_currency>USD</publisher_settled_currency>
                <ship_to_country>RU</ship_to_country>
                <order_id>1000012370141161</order_id>
                <item_main_image_url>https://xxxx.html</item_main_image_url>
                <paid_time>2019-08-14 02:00:48</paid_time>
                <item_count>100</item_count>
                <item_id>32991483812</item_id>
                <effect_status>Payment Completed</effect_status>
                <estimated_finished_commission>11</estimated_finished_commission>
                <sub_order_id>1000012370151161</sub_order_id>
                <estimated_paid_commission>10</estimated_paid_commission>
                <finished_time>2019-08-14 02:00:48</finished_time>
                <paid_amount>2</paid_amount>
                <category_id>21</category_id>
                <incentive_commission_rate>0%</incentive_commission_rate>
            </traffic_order_effect_d_t_o>
        </orders>
        <min_query_index_id>1565773248000_101555804_1000012370151161</min_query_index_id>
        <current_page_no>5</current_page_no>
    </result>
    <rsp_msg>System Error</rsp_msg>
    <rsp_code>404</rsp_code>
</aliexpress_ds_commissionorder_listbyindex_response>

{
    "aliexpress_ds_commissionorder_listbyindex_response":{
        "result":{
            "max_query_index_id":"1565850226000_101555804_1000015421011161",
            "current_record_count":5,
            "orders":{
                "traffic_order_effect_d_t_o":[
                    {
                        "commission_rate":"7.00%",
                        "order_number":1000012370151161,
                        "finished_amount":"10000",
                        "is_affiliate_product":"Y",
                        "is_new_buyer":"N",
                        "item_title":"local return",
                        "effect_detail_status":"FullRefund",
                        "estimated_incentive_finished_commission":"null",
                        "estimated_incentive_paid_commission":"null",
                        "publisher_id":101555804,
                        "is_hot_product":"N",
                        "parent_order_number":1000012370141161,
                        "item_detail_url":"https:\/\/xxxx.html",
                        "created_time":"2019-08-14 01:29:03",
                        "publisher_settled_currency":"USD",
                        "ship_to_country":"RU",
                        "order_id":1000012370141161,
                        "item_main_image_url":"https:\/\/xxxx.html",
                        "paid_time":"2019-08-14 02:00:48",
                        "item_count":"100",
                        "item_id":32991483812,
                        "effect_status":"Payment Completed",
                        "estimated_finished_commission":"11",
                        "sub_order_id":1000012370151161,
                        "estimated_paid_commission":10,
                        "finished_time":"2019-08-14 02:00:48",
                        "paid_amount":2,
                        "category_id":21,
                        "incentive_commission_rate":"0%"
                    }
                ]
            },
            "min_query_index_id":"1565773248000_101555804_1000012370151161",
            "current_page_no":5
        },
        "rsp_msg":"System Error",
        "rsp_code":"404"
    }
}

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下载

开放平台

Dropshipping（已废弃）

aliexpress.ds.commissionorder.listbyindex (联盟订单分页查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ