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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query_predict_order_request	QueryPredictOrderRequest	必须			订单查询入参
└ tcp_type Number 必须 16 业务类型（一般为16） └ start_time Date 必须 2024-04-01 14:00:00 开始时间 └ end_time Date 必须 2024-04-01 14:00:00 结束时间 └ page_size Number 必须 10 页面展示的订单数量，最大为20 └ page_no Number 必须 1 分页参数 └ item_id Number 可选 1234 商品Id └ date_type Number 可选 1 数据口径(0:支付时间，1:确认收货时间) └ rid Number 可选 123 rid └ order_status Number 可选 2 订单状态: 输入为-1时代表展示全PAID_DONE(2, "订单已支付"), FINISH_SETTLE(3, "订单已确认收货"), REFUND_CLOSE(4, "订单售中退款关闭"), CANCEL(5, "订单有退款"), └ biz_order_id Number 可选 12234556653 订单id └ ad_user_nick String 可选 xxxx 达人昵称

名称	类型	示例值	描述
result	Result		结果
model Page 页面参数 └ total_count Number 100 数据总数 └ page_size Number 10 页面展示的订单数量，最大为20 └ page_no Number 1 页面参数 elements TcpPredictOrderVO [] 结果列表 └ biz_order_id String "1234" 子订单id └ item_id Number 1234 商品id └ item_title String "六神花露水" 商品名称 └ order_status String "已结束" 订单状态 └ order_paid_time Date 2024-04-01 14:00:00 订单支付时间 └ order_amount String "100" 订单金额 └ order_commission_amount String "10" 订单计佣金额 └ predict_amount String "10" 预估实际佣金收入 └ remark String "" 备注 └ refund_amount String "10" 退款金额 └ predict_total_amount String "10" 预估收入总金额 └ out_ad_user_fee String "10" 直播间外部引流，外部服务商分佣金额 └ out_ad_user_type String "1" 直播间外部引流，服务商类型 └ rid String "123456" 外部推广者ID └ parent_order_id String "123" 父订单id └ out_ad_user_ratio String - 不展示，请忽略 └ seller_commission_ratio String - 不展示，请忽略 └ end_time Date "" 结束时间。当订单状态显示为订单已确认收货和订单有退款时，此字段的含义为订单确收时间。当订单状态为订单售中退款关闭时，此字段的含义是订单售中退款成功时间 └ picture String https://img.alicdn.com/imgextra/i3/3937219703/O1CN01UopdvH2LY1zHJO805_!!3937219703-0-C2M.jpg 商品主图 └ refund_end_time Date "" 当订单状态为订单有退款时才有值，字段含义订单售后退款成功时间 └ partner_predict_amount String 10% 直播客分成比例 └ modify_time Date 2024-04-01 14:00:00 订单最后修改时间 └ extend_info String { "outerPartnerDivRatio": 200, "outerAdUserDivRatio": 1000 } 订单扩展属性，JSON格式字符串。outerAdUserDivRatio-服务商在计划中的分成比例，outerPartnerDivRatio-直播客分成比例 └ ad_user_nick String xxx 达人昵称 └ buy_amount Number 1 商品购买件数 └ success Boolean true 成功 └ msg_code String "参数错误" 错误码 └ msg_info String "System Error" 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMatrixTcpOuterQuerypredictorderlistRequest req = new AlibabaMatrixTcpOuterQuerypredictorderlistRequest();
AlibabaMatrixTcpOuterQuerypredictorderlistRequest.QueryPredictOrderRequest obj1 = new AlibabaMatrixTcpOuterQuerypredictorderlistRequest.QueryPredictOrderRequest();
obj1.setTcpType(16L);
obj1.setStartTime(StringUtils.parseDateTime("2024-04-01 14:00:00"));
obj1.setEndTime(StringUtils.parseDateTime("2024-04-01 14:00:00"));
obj1.setPageSize(10L);
obj1.setPageNo(1L);
obj1.setItemId(1234L);
obj1.setDateType(1L);
obj1.setRid(123L);
obj1.setOrderStatus(2L);
obj1.setBizOrderId(12234556653L);
obj1.setAdUserNick("xxxx");
req.setQueryPredictOrderRequest(obj1);
AlibabaMatrixTcpOuterQuerypredictorderlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMatrixTcpOuterQuerypredictorderlistRequest req = new AlibabaMatrixTcpOuterQuerypredictorderlistRequest();
AlibabaMatrixTcpOuterQuerypredictorderlistRequest.QueryPredictOrderRequestDomain obj1 = new AlibabaMatrixTcpOuterQuerypredictorderlistRequest.QueryPredictOrderRequestDomain();
obj1.TcpType = 16L;
obj1.StartTime = DateTime.Parse(2024-04-01 14:00:00");
obj1.EndTime = DateTime.Parse(2024-04-01 14:00:00");
obj1.PageSize = 10L;
obj1.PageNo = 1L;
obj1.ItemId = 1234L;
obj1.DateType = 1L;
obj1.Rid = 123L;
obj1.OrderStatus = 2L;
obj1.BizOrderId = 12234556653L;
obj1.AdUserNick = "xxxx";
req.QueryPredictOrderRequest_ = obj1;
AlibabaMatrixTcpOuterQuerypredictorderlistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMatrixTcpOuterQuerypredictorderlistRequest;
$query_predict_order_request = new QueryPredictOrderRequest;
$query_predict_order_request->tcp_type="16";
$query_predict_order_request->start_time="2024-04-01 14:00:00";
$query_predict_order_request->end_time="2024-04-01 14:00:00";
$query_predict_order_request->page_size="10";
$query_predict_order_request->page_no="1";
$query_predict_order_request->item_id="1234";
$query_predict_order_request->date_type="1";
$query_predict_order_request->rid="123";
$query_predict_order_request->order_status="2";
$query_predict_order_request->biz_order_id="12234556653";
$query_predict_order_request->ad_user_nick="xxxx";
$req->setQueryPredictOrderRequest(json_encode($query_predict_order_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.matrix.tcp.outer.querypredictorderlist' \
-d 'partner_id=apidoc' \
-d 'session=60fa6cf8-126b-4791-a8d9-8a8f87834be1' \
-d 'sign=2D427E52BD330C23503051B32552A8AA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A48%3A48' \
-d 'v=2.0' \
-d 'query_predict_order_request=null'

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

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

req.query_predict_order_request="数据结构示例JSON格式"
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.matrix.tcp.outer.querypredictorderlist");
add_param(pRequest,"query_predict_order_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.matrix.tcp.outer.querypredictorderlist', {
	'query_predict_order_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_matrix_tcp_outer_querypredictorderlist_response>
    <result>
        <model>
            <total_count>100</total_count>
            <page_size>10</page_size>
            <page_no>1</page_no>
            <elements>
                <tcp_predict_order_v_o>
                    <biz_order_id>&quot;1234&quot;</biz_order_id>
                    <item_id>1234</item_id>
                    <item_title>&quot;六神花露水&quot;</item_title>
                    <order_status>&quot;已结束&quot;</order_status>
                    <order_paid_time>2024-04-01 14:00:00</order_paid_time>
                    <order_amount>&quot;100&quot;</order_amount>
                    <order_commission_amount>&quot;10&quot;</order_commission_amount>
                    <predict_amount>&quot;10&quot;</predict_amount>
                    <remark>&quot;&quot;</remark>
                    <refund_amount>&quot;10&quot;</refund_amount>
                    <predict_total_amount>&quot;10&quot;</predict_total_amount>
                    <out_ad_user_fee>&quot;10&quot;</out_ad_user_fee>
                    <out_ad_user_type>&quot;1&quot;</out_ad_user_type>
                    <rid>&quot;123456&quot;</rid>
                    <parent_order_id>&quot;123&quot;</parent_order_id>
                    <out_ad_user_ratio>-</out_ad_user_ratio>
                    <seller_commission_ratio>-</seller_commission_ratio>
                    <end_time>&quot;&quot;</end_time>
                    <picture>https://img.alicdn.com/imgextra/i3/3937219703/O1CN01UopdvH2LY1zHJO805_!!3937219703-0-C2M.jpg</picture>
                    <refund_end_time>&quot;&quot;</refund_end_time>
                    <partner_predict_amount>10%</partner_predict_amount>
                    <modify_time>2024-04-01 14:00:00</modify_time>
                    <extend_info>{ &quot;outerPartnerDivRatio&quot;: 200, &quot;outerAdUserDivRatio&quot;: 1000 }</extend_info>
                    <ad_user_nick>xxx</ad_user_nick>
                    <buy_amount>1</buy_amount>
                </tcp_predict_order_v_o>
            </elements>
        </model>
        <success>true</success>
        <msg_code>&quot;参数错误&quot;</msg_code>
        <msg_info>&quot;System Error&quot;</msg_info>
    </result>
</alibaba_matrix_tcp_outer_querypredictorderlist_response>

{
    "alibaba_matrix_tcp_outer_querypredictorderlist_response":{
        "result":{
            "model":{
                "total_count":100,
                "page_size":10,
                "page_no":1,
                "elements":{
                    "tcp_predict_order_v_o":[
                        {
                            "biz_order_id":"\"1234\"",
                            "item_id":1234,
                            "item_title":"\"六神花露水\"",
                            "order_status":"\"已结束\"",
                            "order_paid_time":"2024-04-01 14:00:00",
                            "order_amount":"\"100\"",
                            "order_commission_amount":"\"10\"",
                            "predict_amount":"\"10\"",
                            "remark":"\"\"",
                            "refund_amount":"\"10\"",
                            "predict_total_amount":"\"10\"",
                            "out_ad_user_fee":"\"10\"",
                            "out_ad_user_type":"\"1\"",
                            "rid":"\"123456\"",
                            "parent_order_id":"\"123\"",
                            "out_ad_user_ratio":"-",
                            "seller_commission_ratio":"-",
                            "end_time":"\"\"",
                            "picture":"https:\/\/img.alicdn.com\/imgextra\/i3\/3937219703\/O1CN01UopdvH2LY1zHJO805_!!3937219703-0-C2M.jpg",
                            "refund_end_time":"\"\"",
                            "partner_predict_amount":"10%",
                            "modify_time":"2024-04-01 14:00:00",
                            "extend_info":"{ \"outerPartnerDivRatio\": 200, \"outerAdUserDivRatio\": 1000 }",
                            "ad_user_nick":"xxx",
                            "buy_amount":1
                        }
                    ]
                }
            },
            "success":true,
            "msg_code":"\"参数错误\"",
            "msg_info":"\"System Error\""
        }
    }
}

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.matrix.tcp.outer.querypredictorderlist (淘宝直播佣金预估单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈