淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
page_no	Number	必须	1		当前页
page_size	Number	必须	500		每页数量

名称	类型	示例值	描述
result	DataServiceResponse	结果	结果
ext_map Extmap {"xx":"q23"} 扩展map └ empty Boolean empty empty result Page result 结果 └ total Number 10 总数 └ page_size Number 10 每页查询数量 └ page_no Number 1 当前页 datas Data [] result 结果 └ pos_key Number 110111 poskey └ name String 大杯拿铁名称 detail_list Detaillist [] detail 兑换详情列表 └ unit_point String 9 需要消耗星星数 └ unit_price Number 300 价格分 └ num Number 1 数量 └ ext_map String {"xx":"q23"} 扩展字段 └ result_code String 500 错误码 └ result_msg String 系统异常错误描述 └ success Boolean true 调用结果 └ trace_id String 6343434xx 鹰眼id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAsrDataservicePromotionruleQueryRequest req = new AlibabaAsrDataservicePromotionruleQueryRequest();
req.setPageNo(1L);
req.setPageSize(500L);
AlibabaAsrDataservicePromotionruleQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAsrDataservicePromotionruleQueryRequest req = new AlibabaAsrDataservicePromotionruleQueryRequest();
req.PageNo = 1L;
req.PageSize = 500L;
AlibabaAsrDataservicePromotionruleQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAsrDataservicePromotionruleQueryRequest;
$req->setPageNo("1");
$req->setPageSize("500");
$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.asr.dataservice.promotionrule.query' \
-d 'partner_id=apidoc' \
-d 'session=392580a5-d8fd-49fc-9a3c-9425d4d44542' \
-d 'sign=6953BAD2E5D3AE7A8B79AF915802E043' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A18%3A54' \
-d 'v=2.0' \
-d 'page_no=1' \
-d 'page_size=500'

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

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

req.page_no=1
req.page_size=500
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.asr.dataservice.promotionrule.query");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","500");
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.asr.dataservice.promotionrule.query', {
	'page_no':'1',
	'page_size':'500'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_asr_dataservice_promotionrule_query_response>
    <result>
        <ext_map>
            <empty>empty</empty>
        </ext_map>
        <result>
            <total>10</total>
            <page_size>10</page_size>
            <page_no>1</page_no>
            <datas>
                <data>
                    <pos_key>110111</pos_key>
                    <name>大杯拿铁</name>
                    <detail_list>
                        <detaillist>
                            <unit_point>9</unit_point>
                            <unit_price>300</unit_price>
                            <num>1</num>
                            <ext_map>{&quot;xx&quot;:&quot;q23&quot;}</ext_map>
                        </detaillist>
                    </detail_list>
                </data>
            </datas>
        </result>
        <result_code>500</result_code>
        <result_msg>系统异常</result_msg>
        <success>true</success>
        <trace_id>6343434xx</trace_id>
    </result>
</alibaba_asr_dataservice_promotionrule_query_response>

{
    "alibaba_asr_dataservice_promotionrule_query_response":{
        "result":{
            "ext_map":{
                "empty":empty
            },
            "result":{
                "total":10,
                "page_size":10,
                "page_no":1,
                "datas":{
                    "data":[
                        {
                            "pos_key":110111,
                            "name":"大杯拿铁",
                            "detail_list":{
                                "detaillist":[
                                    {
                                        "unit_point":"9",
                                        "unit_price":300,
                                        "num":1,
                                        "ext_map":"{\"xx\":\"q23\"}"
                                    }
                                ]
                            }
                        }
                    ]
                }
            },
            "result_code":"500",
            "result_msg":"系统异常",
            "success":true,
            "trace_id":"6343434xx"
        }
    }
}

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.asr.dataservice.promotionrule.query (星巴克优惠规则查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ