淘宝开放平台 - 文档中心

请求地址：

环境	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	ActivityReadTopQuery	可选			请求入参
└ start_time_end Date 可选 2017-12-12 12:12:12 发放开始时间右值 └ page_size Number 可选 10 每页记录数 └ source String 必须 test 业务来源 └ start_time_begin Date 可选 2017-12-12 12:12:12 发放开始时间左值 └ end_time_begin Date 可选 2017-12-12 12:12:12 发放结束时间左值 └ end_time_end Date 可选 2017-12-12 12:12:12 发放结束时间右值 └ status_list String [] 可选 EFFECTIVE 筛选状态列表，EFFECTIVE为生效，OFFLINE为下线 └ current_page Number 可选 1 当前页

名称	类型	示例值	描述
result	Result	{}	接口返回结果
└ msg String 查询活动列表失败错误描述 └ code String MOU-BENEFIT-ACTIVITY-06 错误码 page_data Page {} 接口返回结果 activity_list ActivityDto [] [{}] 返回的活动列表 └ name String 测试活动活动名称 └ start_time Date 2017-12-12 12:12:12 活动开始时间 └ end_time Date 2017-12-13 12:12:12 活动结束时间 └ source String test 业务来源 └ strategy_code String xxxx 投放计划code └ status String EFFECTIVE 活动状态，EFFECTIVE为生效，OFFLINE为下线 └ channel_code String test_channel 渠道code └ feature String {} 扩展字段 benefit_list BenefitDto [] [{}] 权益列表 └ code String xxxxx 权益code └ type String interactCoupon 权益类型 └ name String 测试权益权益名称 └ description String 测试权益权益描述 └ status String online 权益状态，online为上线，offline为下线，invalid为失效 └ start_date Date 2017-12-12 12:12:12 权益发放开始时间 └ end_date Date 2017-12-13 12:12:12 权益发放结束时间 └ total Number 10 总库存 └ bestow Number 1 发放量 └ feature String {} 扩展字段 └ current_page Number 1 当前页 └ page_size Number 20 每页的记录数 └ total_count Number 5 总记录数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLafiteSellerActivityListRequest req = new AlibabaLafiteSellerActivityListRequest();
AlibabaLafiteSellerActivityListRequest.ActivityReadTopQuery obj1 = new AlibabaLafiteSellerActivityListRequest.ActivityReadTopQuery();
obj1.setStartTimeEnd(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setPageSize(10L);
obj1.setSource("test");
obj1.setStartTimeBegin(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setEndTimeBegin(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setEndTimeEnd(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setStatusList("EFFECTIVE");
obj1.setCurrentPage(1L);
req.setQuery(obj1);
AlibabaLafiteSellerActivityListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaLafiteSellerActivityListRequest req = new AlibabaLafiteSellerActivityListRequest();
AlibabaLafiteSellerActivityListRequest.ActivityReadTopQueryDomain obj1 = new AlibabaLafiteSellerActivityListRequest.ActivityReadTopQueryDomain();
obj1.StartTimeEnd = DateTime.Parse(2017-12-12 12:12:12");
obj1.PageSize = 10L;
obj1.Source = "test";
obj1.StartTimeBegin = DateTime.Parse(2017-12-12 12:12:12");
obj1.EndTimeBegin = DateTime.Parse(2017-12-12 12:12:12");
obj1.EndTimeEnd = DateTime.Parse(2017-12-12 12:12:12");
obj1.StatusList = "EFFECTIVE";
obj1.CurrentPage = 1L;
req.Query_ = obj1;
AlibabaLafiteSellerActivityListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaLafiteSellerActivityListRequest;
$query = new ActivityReadTopQuery;
$query->start_time_end="2017-12-12 12:12:12";
$query->page_size="10";
$query->source="test";
$query->start_time_begin="2017-12-12 12:12:12";
$query->end_time_begin="2017-12-12 12:12:12";
$query->end_time_end="2017-12-12 12:12:12";
$query->status_list="EFFECTIVE";
$query->current_page="1";
$req->setQuery(json_encode($query));
$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.lafite.seller.activity.list' \
-d 'partner_id=apidoc' \
-d 'session=b43e8f99-a475-4e2e-a9cb-34e5a4b47855' \
-d 'sign=2CCA253289DE004C5D3560DA4A490716' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A25%3A38' \
-d 'v=2.0' \
-d 'query=null'

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

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

req.query=""
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.lafite.seller.activity.list");
add_param(pRequest,"query","数据结构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.lafite.seller.activity.list', {
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_lafite_seller_activity_list_response>
    <result>
        <msg>查询活动列表失败</msg>
        <code>MOU-BENEFIT-ACTIVITY-06</code>
        <page_data>
            <activity_list>
                <activity_dto>
                    <name>测试活动</name>
                    <start_time>2017-12-12 12:12:12</start_time>
                    <end_time>2017-12-13 12:12:12</end_time>
                    <source>test</source>
                    <strategy_code>xxxx</strategy_code>
                    <status>EFFECTIVE</status>
                    <channel_code>test_channel</channel_code>
                    <feature>{}</feature>
                    <benefit_list>
                        <benefit_dto>
                            <code>xxxxx</code>
                            <type>interactCoupon</type>
                            <name>测试权益</name>
                            <description>测试权益</description>
                            <status>online</status>
                            <start_date>2017-12-12 12:12:12</start_date>
                            <end_date>2017-12-13 12:12:12</end_date>
                            <total>10</total>
                            <bestow>1</bestow>
                            <feature>{}</feature>
                        </benefit_dto>
                    </benefit_list>
                </activity_dto>
            </activity_list>
            <current_page>1</current_page>
            <page_size>20</page_size>
            <total_count>5</total_count>
        </page_data>
    </result>
</alibaba_lafite_seller_activity_list_response>

{
    "alibaba_lafite_seller_activity_list_response":{
        "result":{
            "msg":"查询活动列表失败",
            "code":"MOU-BENEFIT-ACTIVITY-06",
            "page_data":{
                "activity_list":{
                    "activity_dto":[
                        {
                            "name":"测试活动",
                            "start_time":"2017-12-12 12:12:12",
                            "end_time":"2017-12-13 12:12:12",
                            "source":"test",
                            "strategy_code":"xxxx",
                            "status":"EFFECTIVE",
                            "channel_code":"test_channel",
                            "feature":"{}",
                            "benefit_list":{
                                "benefit_dto":[
                                    {
                                        "code":"xxxxx",
                                        "type":"interactCoupon",
                                        "name":"测试权益",
                                        "description":"测试权益",
                                        "status":"online",
                                        "start_date":"2017-12-12 12:12:12",
                                        "end_date":"2017-12-13 12:12:12",
                                        "total":10,
                                        "bestow":1,
                                        "feature":"{}"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "current_page":1,
                "page_size":20,
                "total_count":5
            }
        }
    }
}

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.lafite.seller.activity.list (商家自运营活动列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ