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

请求地址：

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

名称	类型	是否必须	示例值	描述
shopId	String	必须	1234	门店Id
outSeasonId	String	必须	DRF123	外部档期号
pageNo	Number	必须	1	页码
pageSize	Number	必须	200	每页大小

名称	类型	示例值	描述
success	Boolean	true	是否成功
totalSize	Number	123	总数
pageSize	Number	10	每页大小
pageNo	Number	1	页码
shopId	String	12	门店Id
errCode	String	param invalid	错误码
errMessage	String	参数错误	错误描述
promotionSku	PromotionSku []	PromotionSku	优惠商品信息
└ activityId Number 81237 活动Id └ skucode String 123123 商品编码

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaWdkMarketingPromotionDataQueryRequest req = new AlibabaWdkMarketingPromotionDataQueryRequest();
req.setShopId("1234");
req.setOutSeasonId("DRF123");
req.setPageNo(1L);
req.setPageSize(200L);
AlibabaWdkMarketingPromotionDataQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkMarketingPromotionDataQueryRequest req = new AlibabaWdkMarketingPromotionDataQueryRequest();
req.ShopId = "1234";
req.OutSeasonId = "DRF123";
req.PageNo = 1L;
req.PageSize = 200L;
AlibabaWdkMarketingPromotionDataQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkMarketingPromotionDataQueryRequest;
$req->setShopId("1234");
$req->setOutSeasonId("DRF123");
$req->setPageNo("1");
$req->setPageSize("200");
$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=qimen.alibaba.wdk.marketing.promotion.data.query' \
-d 'partner_id=apidoc' \
-d 'sign=2CCF45781EC3E3E4D5A550FC9D32035E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+21%3A19%3A15' \
-d 'v=2.0' \
-d 'outSeasonId=DRF123' \
-d 'pageNo=1' \
-d 'pageSize=200' \
-d 'shopId=1234'

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

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

req.shopId="1234"
req.outSeasonId="DRF123"
req.pageNo=1
req.pageSize=200
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,"qimen.alibaba.wdk.marketing.promotion.data.query");
add_param(pRequest,"shopId","1234");
add_param(pRequest,"outSeasonId","DRF123");
add_param(pRequest,"pageNo","1");
add_param(pRequest,"pageSize","200");
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('qimen.alibaba.wdk.marketing.promotion.data.query', {
	'shopId':'1234',
	'outSeasonId':'DRF123',
	'pageNo':'1',
	'pageSize':'200'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<success>true</success>
<totalSize>123</totalSize>
<pageSize>10</pageSize>
<pageNo>1</pageNo>
<shopId>12</shopId>
<errCode>param invalid</errCode>
<errMessage>参数错误</errMessage>
<promotionSku>
    <promotion_sku>
        <activityId>81237</activityId>
        <skucode>123123</skucode>
    </promotion_sku>
</promotionSku>

{
    "success":true,
    "totalSize":123,
    "pageSize":10,
    "pageNo":1,
    "shopId":"12",
    "errCode":"param invalid",
    "errMessage":"参数错误",
    "promotionSku":{
        "promotion_sku":[
            {
                "activityId":81237,
                "skucode":"123123"
            }
        ]
    }
}

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

qimen.alibaba.wdk.marketing.promotion.data.query (优惠数据获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈