淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
jump_type	Number	可选	1	默认值：1	跳转类型，当向前或者向后翻页必须提供,-1: 向前翻页,1：向后翻页
page_size	Number	可选	20	默认值：20	页大小，默认20
query_type	Number	可选	1	默认值：1	查询时间类型，1：按照订单淘客创建时间查询，2:按照订单淘客付款时间查询，3:按照订单淘客结算时间查询，4:按照订单更新时间；
page_no	Number	可选	1	默认值：1	第几页，默认1
start_time	String	必须	2020-04-01 00:00:01		订单查询开始时间
position_index	String	可选	1123213_123213		位点，除第一页之外，都需要传递；前端原样返回
end_time	String	必须	2020-04-01 01:00:01		订单查询结束时间，订单开始时间至订单结束时间，中间时间段日常要求不超过3个小时，但如618、双11、年货节等大促期间预估时间段不可超过20分钟，超过会提示错误，调用时请务必注意时间段的选择，以保证亲能正常调用！
tk_status	Number	可选	12		淘客订单状态，12-付款，13-关闭，14-确认收货，3-结算成功;不传，表示所有状态

名称	类型	示例值	描述
data	OrderPage	Data	返回数据
results CpPublisherOrderDTO [] CpPublisherOrderDTO CpPublisherOrderDTO └ tk_paid_time String 2020-03-25 23:49:31 订单付款的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单创建时间 └ tk_deposit_time String 2020-03-25 23:22:50 定金付款时间。预售时期，用户对预售商品支付定金的付款时间，可能略晚于在淘宝付定金时间 └ tk_service_rate String 30.00 服务费率 └ click_time String 2020-03-25 23:22:50 点击时间。通过推广链接达到商品、店铺详情页的点击时间 └ tb_paid_time String 2020-03-25 23:49:21 订单在淘宝拍下付款的时间 └ item_id String 534660795472 商品ID └ alipay_total_price String 9.00 付款金额。买家拍下付款的金额（不包含运费金额） └ tk_status Number 3 订单状态。12：已付款（订单付款），指订单已付款，但还未确认收货；14：已收货（订单成功），指订单已确认收货，但商家佣金未支付；3：已结算（订单结算），指订单已确认收货，且商家佣金已支付成功；13：已失效（订单失效），指订单关闭/订单佣金小于0.01元，订单关闭主要有：1）买家超时未付款； 2）买家付款前，买家/卖家取消了订单；3）订单付款后发起售中退款成功； └ pre_service_fee String 0.42 预估付款服务费 └ tk_create_time String 2020-03-25 23:49:27 创建时间。订单创建的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单创建时间 └ item_title String 吉得利香辣65g新奥尔良腌料中辣烧烤调料烤翅烤肉料低价肯德基商品标题 └ tk_earning_time String 2020-04-05 10:49:46 结算时间。买家确认收货且阿里妈妈完成商家佣金扣款的时间 └ trade_parent_id String 909934018941578718 父订单编号。买家在淘宝后台显示的订单编号 └ item_num Number 1 商品数量 └ pay_price String 7.00 结算金额。商品单价买家确认收货的付款金额（不包含运费金额） └ deposit_price String 1.00 定金付款金额。预售时期，用户对预售商品支付的定金金额 └ seller_nick String 天猫超市店铺名称 └ seller_shop_title String 天猫超市店铺名称 └ tb_deposit_time String -- 定金淘宝付款时间。预售时期，用户对预售商品支付定金的付款时间 └ service_fee String 0.42 预估结算服务费 └ item_price String 7.2 商品单价 └ cp_channel_name String 我的渠道招商渠道名称，团长合作流量渠道自定义名称 └ cp_channel_id Number 1234567 招商渠道ID，团长流量合作渠道标识 └ event_id Number 386946725 活动ID └ pub_nick_name String 我的推广者推广者昵称。私域招商订单透出字段 └ pub_id Number 1234567 推广者ID。私域招商订单透出字段 └ modified_time String 2021-01-01 00:00:00 订单更新时间 └ marketing_type String 超级红包会场活动营销类型 └ evid_name String 合作渠道20211212 合作推广名称，团长在活动中为渠道合作创建的自定义名称 └ flow_source String 品牌精选推广产品类型 └ trade_id String 909934018941578718 子订单编号 └ contact_emp_id Number 123 员工id └ contact_emp_name String 员工姓名员工姓名 └ page_no Number 1 页码 └ page_size Number 10 页大小 └ has_next Boolean false 是否还有下一页 └ position_index String 1585147709_15brZz9GJR399\|1585151367_15dvsG2sw7I99 位点字段，由调用方原样传递 └ has_pre Boolean false 是否还有上一页

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkCpOrderDetailsGetRequest req = new TbkCpOrderDetailsGetRequest();
req.setJumpType(1L);
req.setPageSize(20L);
req.setQueryType(1L);
req.setPageNo(1L);
req.setStartTime("2020-04-01 00:00:01");
req.setPositionIndex("1123213_123213");
req.setEndTime("2020-04-01 01:00:01");
req.setTkStatus(12L);
TbkCpOrderDetailsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkCpOrderDetailsGetRequest req = new TbkCpOrderDetailsGetRequest();
req.JumpType = 1L;
req.PageSize = 20L;
req.QueryType = 1L;
req.PageNo = 1L;
req.StartTime = "2020-04-01 00:00:01";
req.PositionIndex = "1123213_123213";
req.EndTime = "2020-04-01 01:00:01";
req.TkStatus = 12L;
TbkCpOrderDetailsGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkCpOrderDetailsGetRequest;
$req->setJumpType("1");
$req->setPageSize("20");
$req->setQueryType("1");
$req->setPageNo("1");
$req->setStartTime("2020-04-01 00:00:01");
$req->setPositionIndex("1123213_123213");
$req->setEndTime("2020-04-01 01:00:01");
$req->setTkStatus("12");
$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=taobao.tbk.cp.order.details.get' \
-d 'partner_id=apidoc' \
-d 'sign=735A54C4EF02D2EDF38035E213AE2FD2' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+22%3A38%3A51' \
-d 'v=2.0' \
-d 'end_time=2020-04-01+01%3A00%3A01' \
-d 'jump_type=1' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'position_index=1123213_123213' \
-d 'query_type=1' \
-d 'start_time=2020-04-01+00%3A00%3A01' \
-d 'tk_status=12'

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

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

req.jump_type=1
req.page_size=20
req.query_type=1
req.page_no=1
req.start_time="2020-04-01 00:00:01"
req.position_index="1123213_123213"
req.end_time="2020-04-01 01:00:01"
req.tk_status=12
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,"taobao.tbk.cp.order.details.get");
add_param(pRequest,"jump_type","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"query_type","1");
add_param(pRequest,"page_no","1");
add_param(pRequest,"start_time","2020-04-01 00:00:01");
add_param(pRequest,"position_index","1123213_123213");
add_param(pRequest,"end_time","2020-04-01 01:00:01");
add_param(pRequest,"tk_status","12");
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('taobao.tbk.cp.order.details.get', {
	'jump_type':'1',
	'page_size':'20',
	'query_type':'1',
	'page_no':'1',
	'start_time':'2020-04-01 00:00:01',
	'position_index':'1123213_123213',
	'end_time':'2020-04-01 01:00:01',
	'tk_status':'12'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_cp_order_details_get_response>
    <data>
        <results>
            <cp_publisher_order_d_t_o>
                <tk_paid_time>2020-03-25 23:49:31</tk_paid_time>
                <tk_deposit_time>2020-03-25 23:22:50</tk_deposit_time>
                <tk_service_rate>30.00</tk_service_rate>
                <click_time>2020-03-25 23:22:50</click_time>
                <tb_paid_time>2020-03-25 23:49:21</tb_paid_time>
                <item_id>534660795472</item_id>
                <alipay_total_price>9.00</alipay_total_price>
                <tk_status>3</tk_status>
                <pre_service_fee>0.42</pre_service_fee>
                <tk_create_time>2020-03-25 23:49:27</tk_create_time>
                <item_title>吉得利香辣65g新奥尔良腌料中辣烧烤调料烤翅烤肉料低价肯德基</item_title>
                <tk_earning_time>2020-04-05 10:49:46</tk_earning_time>
                <trade_parent_id>909934018941578718</trade_parent_id>
                <item_num>1</item_num>
                <pay_price>7.00</pay_price>
                <deposit_price>1.00</deposit_price>
                <seller_nick>天猫超市</seller_nick>
                <seller_shop_title>天猫超市</seller_shop_title>
                <tb_deposit_time>--</tb_deposit_time>
                <service_fee>0.42</service_fee>
                <item_price>7.2</item_price>
                <cp_channel_name>我的渠道</cp_channel_name>
                <cp_channel_id>1234567</cp_channel_id>
                <event_id>386946725</event_id>
                <pub_nick_name>我的推广者</pub_nick_name>
                <pub_id>1234567</pub_id>
                <modified_time>2021-01-01 00:00:00</modified_time>
                <marketing_type>超级红包会场活动</marketing_type>
                <evid_name>合作渠道20211212</evid_name>
                <flow_source>品牌精选推广</flow_source>
                <trade_id>909934018941578718</trade_id>
                <contact_emp_id>123</contact_emp_id>
                <contact_emp_name>员工姓名</contact_emp_name>
            </cp_publisher_order_d_t_o>
        </results>
        <page_no>1</page_no>
        <page_size>10</page_size>
        <has_next>false</has_next>
        <position_index>1585147709_15brZz9GJR399|1585151367_15dvsG2sw7I99</position_index>
        <has_pre>false</has_pre>
    </data>
</tbk_cp_order_details_get_response>

{
    "tbk_cp_order_details_get_response":{
        "data":{
            "results":{
                "cp_publisher_order_d_t_o":[
                    {
                        "tk_paid_time":"2020-03-25 23:49:31",
                        "tk_deposit_time":"2020-03-25 23:22:50",
                        "tk_service_rate":"30.00",
                        "click_time":"2020-03-25 23:22:50",
                        "tb_paid_time":"2020-03-25 23:49:21",
                        "item_id":"534660795472",
                        "alipay_total_price":"9.00",
                        "tk_status":3,
                        "pre_service_fee":"0.42",
                        "tk_create_time":"2020-03-25 23:49:27",
                        "item_title":"吉得利香辣65g新奥尔良腌料中辣烧烤调料烤翅烤肉料低价肯德基",
                        "tk_earning_time":"2020-04-05 10:49:46",
                        "trade_parent_id":"909934018941578718",
                        "item_num":1,
                        "pay_price":"7.00",
                        "deposit_price":"1.00",
                        "seller_nick":"天猫超市",
                        "seller_shop_title":"天猫超市",
                        "tb_deposit_time":"--",
                        "service_fee":"0.42",
                        "item_price":"7.2",
                        "cp_channel_name":"我的渠道",
                        "cp_channel_id":1234567,
                        "event_id":386946725,
                        "pub_nick_name":"我的推广者",
                        "pub_id":1234567,
                        "modified_time":"2021-01-01 00:00:00",
                        "marketing_type":"超级红包会场活动",
                        "evid_name":"合作渠道20211212",
                        "flow_source":"品牌精选推广",
                        "trade_id":"909934018941578718",
                        "contact_emp_id":123,
                        "contact_emp_name":"员工姓名"
                    }
                ]
            },
            "page_no":1,
            "page_size":10,
            "has_next":false,
            "position_index":"1585147709_15brZz9GJR399|1585151367_15dvsG2sw7I99",
            "has_pre":false
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
9100	限流	查看限流量级是否正常
2002	查询uc获取权限map为空	查询uc服务是否正常

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.cp.order.details.get (淘宝客-招商团长-服务费订单明细)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ