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

请求地址：

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

名称	类型	是否必须	示例值	描述
biz_type	String	必须	suning	业务类型
buyer_id	String	可选	123456	buyer_id、buyer_nick至少填一个，都填写以id为准
buyer_nick	String	可选	我是测试	buyer_id、buyer_nick至少填一个，都填写以id为准
extra	Json	可选	{"seller_id":111111}	扩展字段

名称	类型	示例值	描述
result	Result		result
data_list Data [] data └ discount String discount └ start_fee String startFee └ coupon_name String couponName └ end_time Date endTime └ start_time Date startTime └ supplier_id String supplierId └ coupon_template_id String couponTemplateId └ id String id └ error_msg String errorMsg └ result_code String resultCode

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallPromotionCouponQueryRequest req = new TmallPromotionCouponQueryRequest();
req.setBizType("suning");
req.setBuyerId("123456");
req.setBuyerNick("我是测试");
req.setExtraString("{\"seller_id\":111111}");
TmallPromotionCouponQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallPromotionCouponQueryRequest req = new TmallPromotionCouponQueryRequest();
req.BizType = "suning";
req.BuyerId = "123456";
req.BuyerNick = "我是测试";
req.Extra = "{\"seller_id\":111111}";
TmallPromotionCouponQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallPromotionCouponQueryRequest;
$req->setBizType("suning");
$req->setBuyerId("123456");
$req->setBuyerNick("我是测试");
$req->setExtra("{\"seller_id\":111111}");
$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=tmall.promotion.coupon.query' \
-d 'partner_id=apidoc' \
-d 'sign=BA72D3DE77BBF0A010FDE17AC0B39FE0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A35%3A31' \
-d 'v=2.0' \
-d 'biz_type=suning' \
-d 'buyer_id=123456' \
-d 'buyer_nick=%E6%88%91%E6%98%AF%E6%B5%8B%E8%AF%95' \
-d 'extra=%7B%5C%22seller_id%5C%22%3A111111%7D'

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

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

req.biz_type="suning"
req.buyer_id="123456"
req.buyer_nick="我是测试"
req.extra="{\"seller_id\":111111}"
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,"tmall.promotion.coupon.query");
add_param(pRequest,"biz_type","suning");
add_param(pRequest,"buyer_id","123456");
add_param(pRequest,"buyer_nick","我是测试");
add_param(pRequest,"extra","{\"seller_id\":111111}");
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('tmall.promotion.coupon.query', {
	'biz_type':'suning',
	'buyer_id':'123456',
	'buyer_nick':'我是测试',
	'extra':'{\"seller_id\":111111}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_promotion_coupon_query_response>
    <result>
        <data_list>
            <data>
                <discount></discount>
                <start_fee></start_fee>
                <coupon_name></coupon_name>
                <end_time></end_time>
                <start_time></start_time>
                <supplier_id></supplier_id>
                <coupon_template_id></coupon_template_id>
                <id></id>
            </data>
        </data_list>
        <error_msg></error_msg>
        <result_code></result_code>
    </result>
</tmall_promotion_coupon_query_response>

{
    "tmall_promotion_coupon_query_response":{
        "result":{
            "data_list":{
                "data":[
                    {
                        "discount":"",
                        "start_fee":"",
                        "coupon_name":"",
                        "end_time":"",
                        "start_time":"",
                        "supplier_id":"",
                        "coupon_template_id":"",
                        "id":""
                    }
                ]
            },
            "error_msg":"",
            "result_code":""
        }
    }
}

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

tmall.promotion.coupon.query (查询可用优惠券列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈