淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
benefit_read_top_query	BenefitReadTopQuery	必须			查询参数
└ statuses String [] 可选 online 状态,online,offline,invalid └ page_size Number 可选 20 每页记录数 └ source String 必须 test 业务来源 └ current_page Number 可选 1 当前页 └ start_time_begin Date 可选 2017-12-12 12:12:12 权益发放开始时间大于该值 └ start_time_end Date 可选 2017-12-15 12:12:12 权益发放开始时间小于该值 └ end_time_end Date 可选 2017-12-12 12:12:12 权益发放结束时间小于该值 └ end_time_begin Date 可选 2017-12-15 12:12:12 权益发放结束时间大于该值 └ benefit_type String 可选 interactCoupon 权益类型

名称	类型	示例值	描述
result	Result	{}	接口返回model
data Page {} 返回查询结果 └ current_page Number 1 当前页 └ page_size Number 20 每页记录数 └ total_count Number 100 总记录数 data_list BenefitDto [] {} 返回查询数据 └ code String xxxxxx 权益code └ type String interactCoupon 权益类型 └ name String 测试权益权益名称 └ description String 测试权益权益描述 └ status String online 状态,online,offline,invalid └ benefit_pool_id Number 111111 关联的权益池id └ start_date Date 2017-12-12 12:12:12 权益发放开始时间 └ end_date Date 2017-12-13 12:12:12 权益发放结束时间 └ total Number 100 权益库存总数，当sendMode是fixedAmount时表示总库存个数，当sendMode为dynamicAmount时表示库存总面额，单位为分 └ bestow Number 2 发放量，当sendMode是fixedAmount时表示已发放个数，当sendMode为dynamicAmount时表示已发放面额，单位为分 └ total_num Number 100 总个数，当sendMode为dynamicAmount时表示已发放面额，单位为分 └ send_mode String fixedAmount 发放模式,fixedAmount,dynamicAmount └ creator_user_name String 测试帐号创建者昵称 └ modifier_user_name String 测试帐号修改者昵称 └ gmt_create Date 2017-12-12 12:12:12 创建时间 └ gmt_modified Date 2017-12-12 12:12:12 修改时间 └ id Number 11111 权益id └ feature String {} 扩展字段 └ msg String 参数错误错误信息 └ code String MOU-BENEFIT-ACTIVITY-06 错误码 └ success Boolean false 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLafiteSellerBenefitListRequest req = new AlibabaLafiteSellerBenefitListRequest();
AlibabaLafiteSellerBenefitListRequest.BenefitReadTopQuery obj1 = new AlibabaLafiteSellerBenefitListRequest.BenefitReadTopQuery();
obj1.setStatuses("online");
obj1.setPageSize(20L);
obj1.setSource("test");
obj1.setCurrentPage(1L);
obj1.setStartTimeBegin(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setStartTimeEnd(StringUtils.parseDateTime("2017-12-15 12:12:12"));
obj1.setEndTimeEnd(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setEndTimeBegin(StringUtils.parseDateTime("2017-12-15 12:12:12"));
obj1.setBenefitType("interactCoupon");
req.setBenefitReadTopQuery(obj1);
AlibabaLafiteSellerBenefitListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaLafiteSellerBenefitListRequest req = new AlibabaLafiteSellerBenefitListRequest();
AlibabaLafiteSellerBenefitListRequest.BenefitReadTopQueryDomain obj1 = new AlibabaLafiteSellerBenefitListRequest.BenefitReadTopQueryDomain();
obj1.Statuses = "online";
obj1.PageSize = 20L;
obj1.Source = "test";
obj1.CurrentPage = 1L;
obj1.StartTimeBegin = DateTime.Parse(2017-12-12 12:12:12");
obj1.StartTimeEnd = DateTime.Parse(2017-12-15 12:12:12");
obj1.EndTimeEnd = DateTime.Parse(2017-12-12 12:12:12");
obj1.EndTimeBegin = DateTime.Parse(2017-12-15 12:12:12");
obj1.BenefitType = "interactCoupon";
req.BenefitReadTopQuery_ = obj1;
AlibabaLafiteSellerBenefitListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaLafiteSellerBenefitListRequest;
$benefit_read_top_query = new BenefitReadTopQuery;
$benefit_read_top_query->statuses="online";
$benefit_read_top_query->page_size="20";
$benefit_read_top_query->source="test";
$benefit_read_top_query->current_page="1";
$benefit_read_top_query->start_time_begin="2017-12-12 12:12:12";
$benefit_read_top_query->start_time_end="2017-12-15 12:12:12";
$benefit_read_top_query->end_time_end="2017-12-12 12:12:12";
$benefit_read_top_query->end_time_begin="2017-12-15 12:12:12";
$benefit_read_top_query->benefit_type="interactCoupon";
$req->setBenefitReadTopQuery(json_encode($benefit_read_top_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.benefit.list' \
-d 'partner_id=apidoc' \
-d 'session=32f0f260-575f-48e2-8a30-a3d871a5412e' \
-d 'sign=96CDD7143F36DF1D9A2A89726DAAB048' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-24+16%3A04%3A16' \
-d 'v=2.0' \
-d 'benefit_read_top_query=null'

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

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

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

XML示例
JSON示例

<alibaba_lafite_seller_benefit_list_response>
    <result>
        <data>
            <current_page>1</current_page>
            <page_size>20</page_size>
            <total_count>100</total_count>
            <data_list>
                <benefit_dto>
                    <code>xxxxxx</code>
                    <type>interactCoupon</type>
                    <name>测试权益</name>
                    <description>测试权益</description>
                    <status>online</status>
                    <benefit_pool_id>111111</benefit_pool_id>
                    <start_date>2017-12-12 12:12:12</start_date>
                    <end_date>2017-12-13 12:12:12</end_date>
                    <total>100</total>
                    <bestow>2</bestow>
                    <total_num>100</total_num>
                    <send_mode>fixedAmount</send_mode>
                    <creator_user_name>测试帐号</creator_user_name>
                    <modifier_user_name>测试帐号</modifier_user_name>
                    <gmt_create>2017-12-12 12:12:12</gmt_create>
                    <gmt_modified>2017-12-12 12:12:12</gmt_modified>
                    <id>11111</id>
                    <feature>{}</feature>
                </benefit_dto>
            </data_list>
        </data>
        <msg>参数错误</msg>
        <code>MOU-BENEFIT-ACTIVITY-06</code>
        <success>false</success>
    </result>
</alibaba_lafite_seller_benefit_list_response>

{
    "alibaba_lafite_seller_benefit_list_response":{
        "result":{
            "data":{
                "current_page":1,
                "page_size":20,
                "total_count":100,
                "data_list":{
                    "benefit_dto":[
                        {
                            "code":"xxxxxx",
                            "type":"interactCoupon",
                            "name":"测试权益",
                            "description":"测试权益",
                            "status":"online",
                            "benefit_pool_id":111111,
                            "start_date":"2017-12-12 12:12:12",
                            "end_date":"2017-12-13 12:12:12",
                            "total":100,
                            "bestow":2,
                            "total_num":100,
                            "send_mode":"fixedAmount",
                            "creator_user_name":"测试帐号",
                            "modifier_user_name":"测试帐号",
                            "gmt_create":"2017-12-12 12:12:12",
                            "gmt_modified":"2017-12-12 12:12:12",
                            "id":11111,
                            "feature":"{}"
                        }
                    ]
                }
            },
            "msg":"参数错误",
            "code":"MOU-BENEFIT-ACTIVITY-06",
            "success":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"
	}
}

错误码	错误描述	解决方案

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

营销API

alibaba.lafite.seller.benefit.list (商家自运营权益列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ