淘宝开放平台

请求地址：

环境	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	可选	20	默认值：20	页大小，默认20，1~100
page_no	Number	可选	1	默认值：1	页码，默认1
adzone_id	Number	可选	123		mm_xxx_xxx_xxx的第三位
start_time	Date	可选	2018-01-24 00:34:05		开始时间，当活动为淘宝活动，表示最早注册时间；当活动为支付宝活动，表示最早绑定时间；当活动为天猫活动，表示最早领取红包时间
end_time	Date	可选	2018-01-24 00:34:05		结束时间，当活动为淘宝活动，表示最晚结束时间；当活动为支付宝活动，表示最晚绑定时间；当活动为天猫活动，表示最晚领取红包的时间
activity_id	String	必须	119013_2		活动id，活动名称与活动ID列表（该字段已废弃）

名称	类型	示例值	描述
results	Results	data	data
data Data data results MapData [] resultList └ register_time Date 2018-01-24 00:34:05 新注册时间，仅淘宝拉新适用 └ bind_time Date 2018-01-24 00:34:05 当前活动为淘宝拉新活动时，bind_time为新激活时间；当前活动为支付宝拉新活动时，bind_time为绑定时间。 └ buy_time Date 2018-01-24 00:34:05 首购时间，仅淘宝，天猫拉新适用 └ status Number 2 新人状态，当前活动为淘宝拉新活动时，1: 新注册，2:激活，3:首购，4:确认收货；当前活动为支付宝实名活动时，1：已绑定，2：拉新成功，3：无效用户；当前活动为支付宝新登活动时，3：手淘首购，4：手淘确认收货；当前活动为天猫拉新活动时，2:已领取，3:已首购，4:已收货 └ mobile String 137****9999 新人手机号 └ order_tk_type Number 1 订单淘客类型:1.淘客订单；2.非淘客订单，仅淘宝，天猫拉新适用 └ union_id String 222222 分享用户(unionid)，仅淘宝，天猫拉新适用 └ member_id Number 11 来源媒体ID(pid中mm_1_2_3)中第1位 └ member_nick String 联盟官方账号来源媒体名称 └ site_id Number 11 来源站点ID(pid中mm_1_2_3)中第2位 └ site_name String 联盟官方站点来源站点名称 └ adzone_id Number 3434 来源广告位ID(pid中mm_1_2_3)中第3位 └ adzone_name String 联盟官方推广位来源广告位名称 └ tb_trade_parent_id Number 1112333 淘宝订单id，仅淘宝，天猫拉新适用 └ accept_time Date 2018-01-24 00:34:05 确认收货时间，仅天猫拉新适用 └ receive_time Date 2018-01-24 00:34:05 领取红包时间，仅天猫拉新适用 └ success_time Date 2018-01-24 00:34:05 拉新成功时间，仅支付宝拉新适用 └ activity_type String taobao 活动类型，taobao-淘宝 alipay-支付宝 tmall-天猫 └ activity_id String 119013_2 活动id └ biz_date String 20180202 日期，格式为"20180202" orders OrderData [] 复购订单，仅适用于手淘拉新 └ commission String 9.15 预估佣金 └ confirm_receive_time String 20180204 收货时间 └ pay_time String 20180203 支付时间 └ order_no String 1589541350997963 订单号 └ bind_card_time Date 2018-01-24 00:34:05 绑卡日期，仅适用于手淘拉新 └ login_time Date 2018-01-24 00:34:05 loginTime └ is_card_save Number 1 银行卡是否是绑定状态：1-绑定，0-未绑定 └ use_rights_time Date 2018-01-24 00:34:05 使用权益时间 └ get_rights_time Date 2018-01-24 00:34:05 领取权益时间 └ relation_id String 232342 渠道关系id └ page_no Number 1 页码 └ page_size Number 20 每页大小 └ has_next Boolean true 是否有下一页

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgNewuserOrderGetRequest req = new TbkDgNewuserOrderGetRequest();
req.setPageSize(20L);
req.setPageNo(1L);
req.setAdzoneId(123L);
req.setStartTime(StringUtils.parseDateTime("2018-01-24 00:34:05"));
req.setEndTime(StringUtils.parseDateTime("2018-01-24 00:34:05"));
req.setActivityId("119013_2");
TbkDgNewuserOrderGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgNewuserOrderGetRequest req = new TbkDgNewuserOrderGetRequest();
req.PageSize = 20L;
req.PageNo = 1L;
req.AdzoneId = 123L;
req.StartTime = DateTime.Parse("2018-01-24 00:34:05");
req.EndTime = DateTime.Parse("2018-01-24 00:34:05");
req.ActivityId = "119013_2";
TbkDgNewuserOrderGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgNewuserOrderGetRequest;
$req->setPageSize("20");
$req->setPageNo("1");
$req->setAdzoneId("123");
$req->setStartTime("2018-01-24 00:34:05");
$req->setEndTime("2018-01-24 00:34:05");
$req->setActivityId("119013_2");
$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.dg.newuser.order.get' \
-d 'partner_id=apidoc' \
-d 'sign=D975366F7597C20AA2A09132FEA55F49' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+23%3A54%3A23' \
-d 'v=2.0' \
-d 'activity_id=119013_2' \
-d 'adzone_id=123' \
-d 'end_time=2018-01-24+00%3A34%3A05' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'start_time=2018-01-24+00%3A34%3A05'

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

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

req.page_size=20
req.page_no=1
req.adzone_id=123
req.start_time="2018-01-24 00:34:05"
req.end_time="2018-01-24 00:34:05"
req.activity_id="119013_2"
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.dg.newuser.order.get");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page_no","1");
add_param(pRequest,"adzone_id","123");
add_param(pRequest,"start_time","2018-01-24 00:34:05");
add_param(pRequest,"end_time","2018-01-24 00:34:05");
add_param(pRequest,"activity_id","119013_2");
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.dg.newuser.order.get', {
	'page_size':'20',
	'page_no':'1',
	'adzone_id':'123',
	'start_time':'2018-01-24 00:34:05',
	'end_time':'2018-01-24 00:34:05',
	'activity_id':'119013_2'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_newuser_order_get_response>
    <results>
        <data>
            <results>
                <map_data>
                    <register_time>2018-01-24 00:34:05</register_time>
                    <bind_time>2018-01-24 00:34:05</bind_time>
                    <buy_time>2018-01-24 00:34:05</buy_time>
                    <status>2</status>
                    <mobile>137****9999</mobile>
                    <order_tk_type>1</order_tk_type>
                    <union_id>222222</union_id>
                    <member_id>11</member_id>
                    <member_nick>联盟官方账号</member_nick>
                    <site_id>11</site_id>
                    <site_name>联盟官方站点</site_name>
                    <adzone_id>3434</adzone_id>
                    <adzone_name>联盟官方推广位</adzone_name>
                    <tb_trade_parent_id>1112333</tb_trade_parent_id>
                    <accept_time>2018-01-24 00:34:05</accept_time>
                    <receive_time>2018-01-24 00:34:05</receive_time>
                    <success_time>2018-01-24 00:34:05</success_time>
                    <activity_type>taobao</activity_type>
                    <activity_id>119013_2</activity_id>
                    <biz_date>20180202</biz_date>
                    <orders>
                        <order_data>
                            <commission>9.15</commission>
                            <confirm_receive_time>20180204</confirm_receive_time>
                            <pay_time>20180203</pay_time>
                            <order_no>1589541350997963</order_no>
                        </order_data>
                    </orders>
                    <bind_card_time>2018-01-24 00:34:05</bind_card_time>
                    <login_time>2018-01-24 00:34:05</login_time>
                    <is_card_save>1</is_card_save>
                    <use_rights_time>2018-01-24 00:34:05</use_rights_time>
                    <get_rights_time>2018-01-24 00:34:05</get_rights_time>
                    <relation_id>232342</relation_id>
                </map_data>
            </results>
            <page_no>1</page_no>
            <page_size>20</page_size>
            <has_next>true</has_next>
        </data>
    </results>
</tbk_dg_newuser_order_get_response>

{
    "tbk_dg_newuser_order_get_response":{
        "results":{
            "data":{
                "results":{
                    "map_data":[
                        {
                            "register_time":"2018-01-24 00:34:05",
                            "bind_time":"2018-01-24 00:34:05",
                            "buy_time":"2018-01-24 00:34:05",
                            "status":2,
                            "mobile":"137****9999",
                            "order_tk_type":1,
                            "union_id":"222222",
                            "member_id":11,
                            "member_nick":"联盟官方账号",
                            "site_id":11,
                            "site_name":"联盟官方站点",
                            "adzone_id":3434,
                            "adzone_name":"联盟官方推广位",
                            "tb_trade_parent_id":1112333,
                            "accept_time":"2018-01-24 00:34:05",
                            "receive_time":"2018-01-24 00:34:05",
                            "success_time":"2018-01-24 00:34:05",
                            "activity_type":"taobao",
                            "activity_id":"119013_2",
                            "biz_date":"20180202",
                            "orders":{
                                "order_data":[
                                    {
                                        "commission":"9.15",
                                        "confirm_receive_time":"20180204",
                                        "pay_time":"20180203",
                                        "order_no":"1589541350997963"
                                    }
                                ]
                            },
                            "bind_card_time":"2018-01-24 00:34:05",
                            "login_time":"2018-01-24 00:34:05",
                            "is_card_save":1,
                            "use_rights_time":"2018-01-24 00:34:05",
                            "get_rights_time":"2018-01-24 00:34:05",
                            "relation_id":"232342"
                        }
                    ]
                },
                "page_no":1,
                "page_size":20,
                "has_next":true
            }
        }
    }
}

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

错误码	错误描述	解决方案
isp.tbkapi-service-unavailable	淘宝客API服务不可用	请稍后重试
isv.invalid-parameter:start_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_tk_rate	参数填写不正确	参数填写不正确
4	查询不到对应的adzoneId	请检查adzoneId是否正确
2	pid不正确	请检查是否输入了正确的adzoneId和siteId

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

淘宝客API

taobao.tbk.dg.newuser.order.get (淘宝客-推广者-新用户订单明细查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ