阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
coupon_id	Number	可选	184780		优惠券的id，唯一标识这个优惠券
end_time	Date	可选	2010-02-15 23:59:59		优惠券的截止日期
denominations	Number	可选	100		优惠券的面额，必须是3，5，10，20，50,100
page_no	Number	可选	1	默认值：1	查询的页号，结果集是分页返回的，每页20条
page_size	Number	可选	20	默认值：20 最大长度：20	每页条数

名称	类型	示例值	描述
total_results	Number	200	查询的总数量
coupons	Coupon []		优惠券列表
└ coupon_id Number 123456 优惠券ID └ denominations Number 500 优惠券的面值，返回的是“分”，不是“元”，500代表500分相当于5元 └ creat_time Date 2000-01-01 00:00:00 优惠券创建时间 └ end_time Date 2000-01-01 00:00:00 优惠券的截止日期 └ condition Number 501 订单满多少分才能用这个优惠券，501就是满501分能使用。注意：返回的是“分”，不是“元” └ create_channel String 自己创建优惠券的创建渠道，自己创建/他人创建

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PromotionCouponsGetRequest req = new PromotionCouponsGetRequest();
req.setCouponId(184780L);
req.setEndTime(StringUtils.parseDateTime("2010-02-15 23:59:59"));
req.setDenominations(100L);
req.setPageNo(1L);
req.setPageSize(20L);
PromotionCouponsGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PromotionCouponsGetRequest req = new PromotionCouponsGetRequest();
req.CouponId = 184780L;
req.EndTime = DateTime.Parse("2010-02-15 23:59:59");
req.Denominations = 100L;
req.PageNo = 1L;
req.PageSize = 20L;
PromotionCouponsGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PromotionCouponsGetRequest;
$req->setCouponId("184780");
$req->setEndTime("2010-02-15 23:59:59");
$req->setDenominations("100");
$req->setPageNo("1");
$req->setPageSize("20");
$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.promotion.coupons.get' \
-d 'partner_id=apidoc' \
-d 'session=3cf60002-5aa7-4955-ab3b-af7b92260a10' \
-d 'sign=5764B55EFA8C56C577FA679304D0DC44' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A23%3A39' \
-d 'v=2.0' \
-d 'coupon_id=184780' \
-d 'denominations=100' \
-d 'end_time=2010-02-15+23%3A59%3A59' \
-d 'page_no=1' \
-d 'page_size=20'

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

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

req.coupon_id=184780
req.end_time="2010-02-15 23:59:59"
req.denominations=100
req.page_no=1
req.page_size=20
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.promotion.coupons.get");
add_param(pRequest,"coupon_id","184780");
add_param(pRequest,"end_time","2010-02-15 23:59:59");
add_param(pRequest,"denominations","100");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","20");
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.promotion.coupons.get', {
	'coupon_id':'184780',
	'end_time':'2010-02-15 23:59:59',
	'denominations':'100',
	'page_no':'1',
	'page_size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<promotion_coupons_get_response>
    <total_results>200</total_results>
    <coupons>
        <coupon>
            <coupon_id>123456</coupon_id>
            <denominations>500</denominations>
            <creat_time>2000-01-01 00:00:00</creat_time>
            <end_time>2000-01-01 00:00:00</end_time>
            <condition>501</condition>
            <create_channel>自己创建</create_channel>
        </coupon>
    </coupons>
</promotion_coupons_get_response>

{
    "promotion_coupons_get_response":{
        "total_results":200,
        "coupons":{
            "coupon":[
                {
                    "coupon_id":123456,
                    "denominations":500,
                    "creat_time":"2000-01-01 00:00:00",
                    "end_time":"2000-01-01 00:00:00",
                    "condition":501,
                    "create_channel":"自己创建"
                }
            ]
        }
    }
}

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

错误码	错误描述	解决方案
isv.error-inaccurate	传入的日期不正确，必须是yyyy-MM-dd格式	必须是yyyy-MM-dd格式
isv.error-numeric	面额不正确	面额必须是3，5，10，20，50，100
isv.error-unauthorized	卖家没有订购优惠券的服务	卖家没有订购优惠券的服务，必须订购优惠券或者是商城的用户
isp.promotiontop-service-unavailable	系统异常	系统异常，联系淘宝

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

营销API

taobao.promotion.coupons.get (查询卖家优惠券)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈