阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
start_time	String	必须	2019-08-14 00:00:00		开始时间
start_query_index_id	String	可选	11111_2222_222		查询索引开始值：若不传，则只能查第一页
end_time	String	必须	2019-08-15 00:00:00		结束时间
status	String	必须	Payment Completed		订单状态:Payment Completed,Buyer Confirmed Receipt
page_size	Number	可选	50	默认值：50	每页记录数
fields	String	可选	commission_rate,created_time		返回的字段信息
app_signature	String	可选	aaaaa		安全签名

名称	类型	示例值	描述
resp_result	ResponseDto	resp_result	返回结果
└ resp_code Number 200 返回结果状态码 └ resp_msg String success 返回状态描述信息 result TrafficOrderResultDto result 返回结果明细 └ current_record_count Number 50 当前页记录条数 orders Order [] orders 订单列表 └ order_id Number 3333333 订单ID └ sub_order_id Number 222222 子订单ID └ tracking_id String trackingId trackingId └ category_id Number 111111 类目ID └ is_hot_product String N 是否爆品:Y或者N └ effect_detail_status String FullRefund FullRefund:订单全额退款，Antispam: 订单作弊 └ incentive_commission_rate String 1% 激励佣金率 └ estimated_incentive_paid_commission Number 10 激励订单支付时的预计佣金 └ estimated_incentive_finished_commission Number 10 激励订单完成时的预计佣金 └ is_affiliate_product String N 是否为联盟商品:Y或者N └ order_type String global 国家标：global、ru_site、es_site、it_site └ order_status String Payment Completed 订单状态:Payment Completed,Buyer Confirmed Receipt └ created_time String 2019-08-15 00:00:00 订单创建时间 └ commission_rate String 3.5% 佣金率 └ paid_amount Number 1000 订单支付完成金额 └ paid_time String 2019-08-15 00:00:00 订单支付完成时间 └ estimated_paid_commission Number 1111 订单支付时的预计佣金 └ finished_amount Number 1000 订单完成金额 └ finished_time String 2019-08-15 00:00:00 订单完成时间 └ estimated_finished_commission Number 1111 订单完成时的预计佣金 └ is_new_buyer String Y 是否新买家 └ settled_currency String USD 推广者结算币种 └ custom_parameters String {"af":0,"dp":1111} 自定义参数(JSON格式） └ new_buyer_bonus_commission Number 30 新买家奖励佣金 └ product_id Number 22222223333 商品ID └ product_title String Apple iPhone XS Max 商品标题 └ product_detail_url String https://www.aliexpress.com/item/32974866139.html 商品DetailUrl └ product_main_image_url String https://ae01.alicdn.com/kf/HTB1tyl7bELrK1Rjy0Fjq6zYXFXaC/Spring-Autumn-mother-daughter-dress-matching-family-outfits-mother-kids-dress-matching-outfits-flamingo-embroidery-1.jpg 商品主图Url └ product_count Number 1 下单商品数量 └ ship_to_country String RU 物流国家 └ max_query_index_id String 11111_2222_222 当前返回记录的最大游标ID └ min_query_index_id String 11111_2222_111 当前返回记录的最小游标ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliexpressAffiliateOrderListbyindexRequest req = new AliexpressAffiliateOrderListbyindexRequest();
req.setStartTime("2019-08-14 00:00:00");
req.setStartQueryIndexId("11111_2222_222");
req.setEndTime("2019-08-15 00:00:00");
req.setStatus("Payment Completed");
req.setPageSize(50L);
req.setFields("commission_rate,created_time");
req.setAppSignature("aaaaa");
AliexpressAffiliateOrderListbyindexResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliexpressAffiliateOrderListbyindexRequest req = new AliexpressAffiliateOrderListbyindexRequest();
req.StartTime = "2019-08-14 00:00:00";
req.StartQueryIndexId = "11111_2222_222";
req.EndTime = "2019-08-15 00:00:00";
req.Status = "Payment Completed";
req.PageSize = 50L;
req.Fields = "commission_rate,created_time";
req.AppSignature = "aaaaa";
AliexpressAffiliateOrderListbyindexResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliexpressAffiliateOrderListbyindexRequest;
$req->setStartTime("2019-08-14 00:00:00");
$req->setStartQueryIndexId("11111_2222_222");
$req->setEndTime("2019-08-15 00:00:00");
$req->setStatus("Payment Completed");
$req->setPageSize("50");
$req->setFields("commission_rate,created_time");
$req->setAppSignature("aaaaa");
$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.affiliate.order.listbyindex' \
-d 'partner_id=apidoc' \
-d 'sign=4D561EF642237989362184ED02A4983D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+15%3A09%3A06' \
-d 'v=2.0' \
-d 'app_signature=aaaaa' \
-d 'end_time=2019-08-15+00%3A00%3A00' \
-d 'fields=commission_rate%2Ccreated_time' \
-d 'page_size=50' \
-d 'start_query_index_id=11111_2222_222' \
-d 'start_time=2019-08-14+00%3A00%3A00' \
-d 'status=Payment+Completed'

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

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

req.start_time="2019-08-14 00:00:00"
req.start_query_index_id="11111_2222_222"
req.end_time="2019-08-15 00:00:00"
req.status="Payment Completed"
req.page_size=50
req.fields="commission_rate,created_time"
req.app_signature="aaaaa"
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.affiliate.order.listbyindex");
add_param(pRequest,"start_time","2019-08-14 00:00:00");
add_param(pRequest,"start_query_index_id","11111_2222_222");
add_param(pRequest,"end_time","2019-08-15 00:00:00");
add_param(pRequest,"status","Payment Completed");
add_param(pRequest,"page_size","50");
add_param(pRequest,"fields","commission_rate,created_time");
add_param(pRequest,"app_signature","aaaaa");
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.affiliate.order.listbyindex', {
	'start_time':'2019-08-14 00:00:00',
	'start_query_index_id':'11111_2222_222',
	'end_time':'2019-08-15 00:00:00',
	'status':'Payment Completed',
	'page_size':'50',
	'fields':'commission_rate,created_time',
	'app_signature':'aaaaa'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliexpress_affiliate_order_listbyindex_response>
    <resp_result>
        <resp_code>200</resp_code>
        <resp_msg>success</resp_msg>
        <result>
            <current_record_count>50</current_record_count>
            <orders>
                <order>
                    <order_id>3333333</order_id>
                    <sub_order_id>222222</sub_order_id>
                    <tracking_id>trackingId</tracking_id>
                    <category_id>111111</category_id>
                    <is_hot_product>N</is_hot_product>
                    <effect_detail_status>FullRefund</effect_detail_status>
                    <incentive_commission_rate>1%</incentive_commission_rate>
                    <estimated_incentive_paid_commission>10</estimated_incentive_paid_commission>
                    <estimated_incentive_finished_commission>10</estimated_incentive_finished_commission>
                    <is_affiliate_product>N</is_affiliate_product>
                    <order_type>global</order_type>
                    <order_status>Payment Completed</order_status>
                    <created_time>2019-08-15 00:00:00</created_time>
                    <commission_rate>3.5%</commission_rate>
                    <paid_amount>1000</paid_amount>
                    <paid_time>2019-08-15 00:00:00</paid_time>
                    <estimated_paid_commission>1111</estimated_paid_commission>
                    <finished_amount>1000</finished_amount>
                    <finished_time>2019-08-15 00:00:00</finished_time>
                    <estimated_finished_commission>1111</estimated_finished_commission>
                    <is_new_buyer>Y</is_new_buyer>
                    <settled_currency>USD</settled_currency>
                    <custom_parameters>{&quot;af&quot;:0,&quot;dp&quot;:1111}</custom_parameters>
                    <new_buyer_bonus_commission>30</new_buyer_bonus_commission>
                    <product_id>22222223333</product_id>
                    <product_title>Apple iPhone XS Max</product_title>
                    <product_detail_url>https://www.aliexpress.com/item/32974866139.html</product_detail_url>
                    <product_main_image_url>https://ae01.alicdn.com/kf/HTB1tyl7bELrK1Rjy0Fjq6zYXFXaC/Spring-Autumn-mother-daughter-dress-matching-family-outfits-mother-kids-dress-matching-outfits-flamingo-embroidery-1.jpg</product_main_image_url>
                    <product_count>1</product_count>
                    <ship_to_country>RU</ship_to_country>
                </order>
            </orders>
            <max_query_index_id>11111_2222_222</max_query_index_id>
            <min_query_index_id>11111_2222_111</min_query_index_id>
        </result>
    </resp_result>
</aliexpress_affiliate_order_listbyindex_response>

{
    "aliexpress_affiliate_order_listbyindex_response":{
        "resp_result":{
            "resp_code":200,
            "resp_msg":"success",
            "result":{
                "current_record_count":50,
                "orders":{
                    "order":[
                        {
                            "order_id":3333333,
                            "sub_order_id":222222,
                            "tracking_id":"trackingId",
                            "category_id":111111,
                            "is_hot_product":"N",
                            "effect_detail_status":"FullRefund",
                            "incentive_commission_rate":"1%",
                            "estimated_incentive_paid_commission":10,
                            "estimated_incentive_finished_commission":10,
                            "is_affiliate_product":"N",
                            "order_type":"global",
                            "order_status":"Payment Completed",
                            "created_time":"2019-08-15 00:00:00",
                            "commission_rate":"3.5%",
                            "paid_amount":1000,
                            "paid_time":"2019-08-15 00:00:00",
                            "estimated_paid_commission":1111,
                            "finished_amount":1000,
                            "finished_time":"2019-08-15 00:00:00",
                            "estimated_finished_commission":1111,
                            "is_new_buyer":"Y",
                            "settled_currency":"USD",
                            "custom_parameters":"{\"af\":0,\"dp\":1111}",
                            "new_buyer_bonus_commission":30,
                            "product_id":22222223333,
                            "product_title":"Apple iPhone XS Max",
                            "product_detail_url":"https:\/\/www.aliexpress.com\/item\/32974866139.html",
                            "product_main_image_url":"https:\/\/ae01.alicdn.com\/kf\/HTB1tyl7bELrK1Rjy0Fjq6zYXFXaC\/Spring-Autumn-mother-daughter-dress-matching-family-outfits-mother-kids-dress-matching-outfits-flamingo-embroidery-1.jpg",
                            "product_count":1,
                            "ship_to_country":"RU"
                        }
                    ]
                },
                "max_query_index_id":"11111_2222_222",
                "min_query_index_id":"11111_2222_111"
            }
        }
    }
}

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

Affiliate API（已废弃）

aliexpress.affiliate.order.listbyindex (AE联盟推广者订单查询接口-按游标索引查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈