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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
cps_order_request	CpsOrderRequest	必须			入参
└ start_time Date 必须 2022-03-01 00:00:00 订单更新开始时间 └ end_time Date 必须 2022-03-01 23:59:00 订单更新结束时间 └ page_index Number 必须 1 页序号，从0开始 └ page_size Number 必须 100 单页大小，不超过200

名称	类型	示例值	描述
api_result	ApiResult		出参
└ success Boolean true 调用接口成功失败 └ err_msg String 调用接口返回错误信息 └ err_code String 调用接口返回错误编码 model CpsOrderResponse [] 调用接口返回对象 └ create_time Date 2022-03-14 00:00:00 订单创建时间 └ pay_time Date 2022-03-14 01:00:00 支付成功时间 └ biz_order_id String 12321312 业务订单ID └ order_status String PAID 订单状态： INIT(0, "初始化"),CREATED(1, "已创建"),PAID_DONE(2, "已付款"),ACCEPT_ORDER(3, "已接单"),PICK_ORDER(4, "已拣货"),SHIPPED(5, "已发货"),TRADE_SUCCESS(6, "交易成功"),TRADE_CLOSE(-1, "交易关闭"), └ pay_price Number 120 主订单付款金额（不含运费、优惠、券） └ outer_id String 125000304_108400334_28176750484_12345 外部用户ID：由pid+siteid+adzoneid+custom四部分拼成，其中前3个参数对应拼链中淘宝联盟mm=1_2_3，第4个参数对应拼链中 custom_parameters； eg：125000304_108400334_28176750484_12345 └ share_amount Number 100 预估总分佣金额（仅是预估金额，实际结算仍然通过xls线下doublecheck为准） └ modified_time Date 2022-03-15 00:00:00 最后更新时间 cps_sub_order CpsSubOrderBO [] 子单列表 └ biz_sub_order_id String 1213131 业务子订单ID └ item_title String 测试品商品名称 └ quantity Number 1 购买数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkorderSharestockCpsorderListRequest req = new AlibabaWdkorderSharestockCpsorderListRequest();
AlibabaWdkorderSharestockCpsorderListRequest.CpsOrderRequest obj1 = new AlibabaWdkorderSharestockCpsorderListRequest.CpsOrderRequest();
obj1.setStartTime(StringUtils.parseDateTime("2022-03-01 00:00:00"));
obj1.setEndTime(StringUtils.parseDateTime("2022-03-01 23:59:00"));
obj1.setPageIndex(1L);
obj1.setPageSize(100L);
req.setCpsOrderRequest(obj1);
AlibabaWdkorderSharestockCpsorderListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkorderSharestockCpsorderListRequest req = new AlibabaWdkorderSharestockCpsorderListRequest();
AlibabaWdkorderSharestockCpsorderListRequest.CpsOrderRequestDomain obj1 = new AlibabaWdkorderSharestockCpsorderListRequest.CpsOrderRequestDomain();
obj1.StartTime = DateTime.Parse(2022-03-01 00:00:00");
obj1.EndTime = DateTime.Parse(2022-03-01 23:59:00");
obj1.PageIndex = 1L;
obj1.PageSize = 100L;
req.CpsOrderRequest_ = obj1;
AlibabaWdkorderSharestockCpsorderListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkorderSharestockCpsorderListRequest;
$cps_order_request = new CpsOrderRequest;
$cps_order_request->start_time="2022-03-01 00:00:00";
$cps_order_request->end_time="2022-03-01 23:59:00";
$cps_order_request->page_index="1";
$cps_order_request->page_size="100";
$req->setCpsOrderRequest(json_encode($cps_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.wdkorder.sharestock.cpsorder.list' \
-d 'partner_id=apidoc' \
-d 'session=3321ebb8-7e32-427f-9dca-70f61a46a234' \
-d 'sign=53622DF4E6C59C2FE1B5D96FA59321FE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A55%3A28' \
-d 'v=2.0' \
-d 'cps_order_request=null'

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

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

req.cps_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.wdkorder.sharestock.cpsorder.list");
add_param(pRequest,"cps_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.wdkorder.sharestock.cpsorder.list', {
	'cps_order_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdkorder_sharestock_cpsorder_list_response>
    <api_result>
        <success>true</success>
        <err_msg></err_msg>
        <err_code></err_code>
        <model>
            <cps_order_response>
                <create_time>2022-03-14 00:00:00</create_time>
                <pay_time>2022-03-14 01:00:00</pay_time>
                <biz_order_id>12321312</biz_order_id>
                <order_status>PAID</order_status>
                <pay_price>120</pay_price>
                <outer_id>125000304_108400334_28176750484_12345</outer_id>
                <share_amount>100</share_amount>
                <modified_time>2022-03-15 00:00:00</modified_time>
                <cps_sub_order>
                    <cps_sub_order_b_o>
                        <biz_sub_order_id>1213131</biz_sub_order_id>
                        <item_title>测试品</item_title>
                        <quantity>1</quantity>
                    </cps_sub_order_b_o>
                </cps_sub_order>
            </cps_order_response>
        </model>
    </api_result>
</alibaba_wdkorder_sharestock_cpsorder_list_response>

{
    "alibaba_wdkorder_sharestock_cpsorder_list_response":{
        "api_result":{
            "success":true,
            "err_msg":" ",
            "err_code":" ",
            "model":{
                "cps_order_response":[
                    {
                        "create_time":"2022-03-14 00:00:00",
                        "pay_time":"2022-03-14 01:00:00",
                        "biz_order_id":"12321312",
                        "order_status":"PAID",
                        "pay_price":120,
                        "outer_id":"125000304_108400334_28176750484_12345",
                        "share_amount":100,
                        "modified_time":"2022-03-15 00:00:00",
                        "cps_sub_order":{
                            "cps_sub_order_b_o":[
                                {
                                    "biz_sub_order_id":"1213131",
                                    "item_title":"测试品",
                                    "quantity":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.wdkorder.sharestock.cpsorder.list (cps正向分销订单批量回流)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈