淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
out_activity_ids	Number []	可选	123,456	最大列表长度：20	活动ID列表
create_time_from	Date	可选	2014-11-26 19:29:35		活动创建时间：起始点
create_time_to	Date	可选	2014-11-26 19:29:35		活动创建时间：超始点
end_time_from	Date	可选	2014-11-26 19:29:35		活动结束时间：起始点
end_time_to	Date	可选	2014-11-26 19:29:35		活动结束时间：截止点
page	Number	必须	1		当前页，从1开始
page_size	Number	必须	10		单次返回记录数
start_time_from	Date	可选	2014-11-26 19:29:35		活动开始时间：起始点
start_time_to	Date	可选	2014-11-26 19:29:35		活动开始时间：截止点
status	Number []	可选	0,-2	最大列表长度：20	状态，0-有效状态，-1-创建失败，-2-卖家中止, -3-系统中止, -4-到期终止
tb_activity_ids	Number []	可选	123,456	最大列表长度：20	淘宝活动ID

名称	类型	示例值	描述
trace_id	String	aabb	跟踪ID，用于故障排查。
query_result	ActivityQueryList		查询活动列表
└ total_count Number 123 总记录数 list ThirdActivity [] 活动列表 └ start_time Date 2014-11-26 18:57:35 活动开始时间 └ end_time Date 2014-11-26 18:57:35 活动结束时间 └ activity_title String 周末抽奖活动标题 └ status Number 0 状态，0-有效状态，-1-创建失败，-2-卖家中止, -3-系统中止, -4-到期终止 └ out_activity_id Number 123 外部活动ID └ budget_amount Number 123 为活动冻结的金币数余额 └ tb_activity_id Number 123 淘金币活动ID └ activity_url String http://appserver/activity.htm?id=123 参与活动入口URL └ feature Json {bizId:123} 外部扩展属性 └ current_page Number 123 当前页码 └ total_page Number 123 总页数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CoinActivitiesQueryRequest req = new CoinActivitiesQueryRequest();
req.setOutActivityIds("123,456");
req.setCreateTimeFrom(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setCreateTimeTo(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setEndTimeFrom(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setEndTimeTo(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setPage(1L);
req.setPageSize(10L);
req.setStartTimeFrom(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setStartTimeTo(StringUtils.parseDateTime("2014-11-26 19:29:35"));
req.setStatus("0,-2");
req.setTbActivityIds("123,456");
CoinActivitiesQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CoinActivitiesQueryRequest req = new CoinActivitiesQueryRequest();
req.OutActivityIds = "123,456";
req.CreateTimeFrom = DateTime.Parse("2014-11-26 19:29:35");
req.CreateTimeTo = DateTime.Parse("2014-11-26 19:29:35");
req.EndTimeFrom = DateTime.Parse("2014-11-26 19:29:35");
req.EndTimeTo = DateTime.Parse("2014-11-26 19:29:35");
req.Page = 1L;
req.PageSize = 10L;
req.StartTimeFrom = DateTime.Parse("2014-11-26 19:29:35");
req.StartTimeTo = DateTime.Parse("2014-11-26 19:29:35");
req.Status = "0,-2";
req.TbActivityIds = "123,456";
CoinActivitiesQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CoinActivitiesQueryRequest;
$req->setOutActivityIds("123,456");
$req->setCreateTimeFrom("2014-11-26 19:29:35");
$req->setCreateTimeTo("2014-11-26 19:29:35");
$req->setEndTimeFrom("2014-11-26 19:29:35");
$req->setEndTimeTo("2014-11-26 19:29:35");
$req->setPage("1");
$req->setPageSize("10");
$req->setStartTimeFrom("2014-11-26 19:29:35");
$req->setStartTimeTo("2014-11-26 19:29:35");
$req->setStatus("0,-2");
$req->setTbActivityIds("123,456");
$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=taobao.coin.activities.query' \
-d 'partner_id=apidoc' \
-d 'session=8bd45304-b69c-450e-b21d-c38d1334284c' \
-d 'sign=D6534FB166872DACB9CAFF3A2E707961' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-16+17%3A57%3A22' \
-d 'v=2.0' \
-d 'create_time_from=2014-11-26+19%3A29%3A35' \
-d 'create_time_to=2014-11-26+19%3A29%3A35' \
-d 'end_time_from=2014-11-26+19%3A29%3A35' \
-d 'end_time_to=2014-11-26+19%3A29%3A35' \
-d 'out_activity_ids=123%2C456' \
-d 'page=1' \
-d 'page_size=10' \
-d 'start_time_from=2014-11-26+19%3A29%3A35' \
-d 'start_time_to=2014-11-26+19%3A29%3A35' \
-d 'status=0%2C-2' \
-d 'tb_activity_ids=123%2C456'

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

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

req.out_activity_ids="123,456"
req.create_time_from="2014-11-26 19:29:35"
req.create_time_to="2014-11-26 19:29:35"
req.end_time_from="2014-11-26 19:29:35"
req.end_time_to="2014-11-26 19:29:35"
req.page=1
req.page_size=10
req.start_time_from="2014-11-26 19:29:35"
req.start_time_to="2014-11-26 19:29:35"
req.status="0,-2"
req.tb_activity_ids="123,456"
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,"taobao.coin.activities.query");
add_param(pRequest,"out_activity_ids","123,456");
add_param(pRequest,"create_time_from","2014-11-26 19:29:35");
add_param(pRequest,"create_time_to","2014-11-26 19:29:35");
add_param(pRequest,"end_time_from","2014-11-26 19:29:35");
add_param(pRequest,"end_time_to","2014-11-26 19:29:35");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"start_time_from","2014-11-26 19:29:35");
add_param(pRequest,"start_time_to","2014-11-26 19:29:35");
add_param(pRequest,"status","0,-2");
add_param(pRequest,"tb_activity_ids","123,456");
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('taobao.coin.activities.query', {
	'out_activity_ids':'123,456',
	'create_time_from':'2014-11-26 19:29:35',
	'create_time_to':'2014-11-26 19:29:35',
	'end_time_from':'2014-11-26 19:29:35',
	'end_time_to':'2014-11-26 19:29:35',
	'page':'1',
	'page_size':'10',
	'start_time_from':'2014-11-26 19:29:35',
	'start_time_to':'2014-11-26 19:29:35',
	'status':'0,-2',
	'tb_activity_ids':'123,456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<coin_activities_query_response>
    <trace_id>aabb</trace_id>
    <query_result>
        <total_count>123</total_count>
        <list>
            <third_activity>
                <start_time>2014-11-26 18:57:35</start_time>
                <end_time>2014-11-26 18:57:35</end_time>
                <activity_title>周末抽奖</activity_title>
                <status>0</status>
                <out_activity_id>123</out_activity_id>
                <budget_amount>123</budget_amount>
                <tb_activity_id>123</tb_activity_id>
                <activity_url>http://appserver/activity.htm?id=123</activity_url>
                <feature>{bizId:123}</feature>
            </third_activity>
        </list>
        <current_page>123</current_page>
        <total_page>123</total_page>
    </query_result>
</coin_activities_query_response>

{
    "coin_activities_query_response":{
        "trace_id":"aabb",
        "query_result":{
            "total_count":123,
            "list":{
                "third_activity":[
                    {
                        "start_time":"2014-11-26 18:57:35",
                        "end_time":"2014-11-26 18:57:35",
                        "activity_title":"周末抽奖",
                        "status":0,
                        "out_activity_id":123,
                        "budget_amount":123,
                        "tb_activity_id":123,
                        "activity_url":"http:\/\/appserver\/activity.htm?id=123",
                        "feature":"{bizId:123}"
                    }
                ]
            },
            "current_page":123,
            "total_page":123
        }
    }
}

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.systerm-error:*	服务查询错误	根据详细的错误信息调整入参

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

开放平台

淘金币API

taobao.coin.activities.query (查询卖家淘金币活动信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ