淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
top_privilege_activity_query_param	TopPrivilegeActivityQueryParam	可选			入参模型
└ need_static Boolean 必须 false 是否需要查询统计信息（发放数量、订单数），true=会返回发放数量、订单数，false=不查询 └ partner_code String 必须 damai 合作商家，每个外部调用方会分配一个固定的 └ spread_id String 必须 dmPrivilege_xxxxxxxxxxxx 传播ID，代表特权活动ID，由大麦业务运营提供

名称	类型	示例值	描述
biz_success	Boolean	是否成功	ture=成功，对应biz_error_code为0
biz_error_code	String	10000002	错误码，为0代表成功
model	TopPrivilegeActivityDTO		特权活动查询返回模型
└ privilege_name String XXX测试特权特权名称 └ start_time String 2023-08-01 00:00:00 开始时间 yyyy-MM-dd HH:mm:ss └ end_time String 2023-08-01 23:59:59 结束时间 yyyy-MM-dd HH:mm:ss └ introduction String 特权详细的说明文案特权描述 └ id_card_privilege Boolean true 是否实名制特权 └ status Number 1 特权活动状态。1=未开始，2=进行中，3=冻结中，4=已结束 └ total_count Number 1000 发放数量 └ order_count Number 100 订单数
biz_error_msg	String	参数错误	错误文案

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiEcPrivilegeQueryRequest req = new AlibabaDamaiEcPrivilegeQueryRequest();
AlibabaDamaiEcPrivilegeQueryRequest.TopPrivilegeActivityQueryParam obj1 = new AlibabaDamaiEcPrivilegeQueryRequest.TopPrivilegeActivityQueryParam();
obj1.setNeedStatic(false);
obj1.setPartnerCode("damai");
obj1.setSpreadId("dmPrivilege_xxxxxxxxxxxx");
req.setTopPrivilegeActivityQueryParam(obj1);
AlibabaDamaiEcPrivilegeQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiEcPrivilegeQueryRequest req = new AlibabaDamaiEcPrivilegeQueryRequest();
AlibabaDamaiEcPrivilegeQueryRequest.TopPrivilegeActivityQueryParamDomain obj1 = new AlibabaDamaiEcPrivilegeQueryRequest.TopPrivilegeActivityQueryParamDomain();
obj1.NeedStatic = false;
obj1.PartnerCode = "damai";
obj1.SpreadId = "dmPrivilege_xxxxxxxxxxxx";
req.TopPrivilegeActivityQueryParam_ = obj1;
AlibabaDamaiEcPrivilegeQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiEcPrivilegeQueryRequest;
$top_privilege_activity_query_param = new TopPrivilegeActivityQueryParam;
$top_privilege_activity_query_param->need_static="false";
$top_privilege_activity_query_param->partner_code="damai";
$top_privilege_activity_query_param->spread_id="dmPrivilege_xxxxxxxxxxxx";
$req->setTopPrivilegeActivityQueryParam(json_encode($top_privilege_activity_query_param));
$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=alibaba.damai.ec.privilege.query' \
-d 'partner_id=apidoc' \
-d 'sign=90137A633B04B6DBA3AC111FAAAA7066' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-14+07%3A04%3A06' \
-d 'v=2.0' \
-d 'top_privilege_activity_query_param=null'

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

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

req.top_privilege_activity_query_param="数据结构示例JSON格式"
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,"alibaba.damai.ec.privilege.query");
add_param(pRequest,"top_privilege_activity_query_param","数据结构JSON示例");
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('alibaba.damai.ec.privilege.query', {
	'top_privilege_activity_query_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_ec_privilege_query_response>
    <biz_success>是否成功</biz_success>
    <biz_error_code>10000002</biz_error_code>
    <model>
        <privilege_name>XXX测试特权</privilege_name>
        <start_time>2023-08-01 00:00:00</start_time>
        <end_time>2023-08-01 23:59:59</end_time>
        <introduction>特权详细的说明文案</introduction>
        <id_card_privilege>true</id_card_privilege>
        <status>1</status>
        <total_count>1000</total_count>
        <order_count>100</order_count>
    </model>
    <biz_error_msg>参数错误</biz_error_msg>
</alibaba_damai_ec_privilege_query_response>

{
    "alibaba_damai_ec_privilege_query_response":{
        "biz_success":是否成功,
        "biz_error_code":"10000002",
        "model":{
            "privilege_name":"XXX测试特权",
            "start_time":"2023-08-01 00:00:00",
            "end_time":"2023-08-01 23:59:59",
            "introduction":"特权详细的说明文案",
            "id_card_privilege":true,
            "status":1,
            "total_count":1000,
            "order_count":100
        },
        "biz_error_msg":"参数错误"
    }
}

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.damai.ec.privilege.query (大麦特权活动查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ