淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	CommonActivityParam	必须			查询优惠券活动入参
└ activity_id Number 必须 124135 五道口优惠券活动id └ out_act_id String 可选 darunfa170907 商家优惠券活动id

名称	类型	示例值	描述
result	MarketResult		查询返回结果
└ message String 请求参数非法错误信息 └ error_code String REQUEST_PARAM_ERROR 错误码 data CouponActivity 返回的优惠券活动信息 limit_info LimitInfo 通用限购信息，-1为不限制，默认为不限制 └ user_limit_cnt Number 10 每人活动期间总限购 └ user_daily_limit_cnt Number 2 每人每日限购 └ daily_limit_cnt Number 30 活动每日总限购 └ total_limit_cnt Number 100 活动期间总限购 └ out_act_id String darunfa123123 商家活动id └ activity_name String 满30建10优惠券优惠券活动名称 └ description String 优惠券活动描述优惠券活动描述，不超过100个中文字符 └ start_time Number 1516441828483 活动开始时间，时间戳[ms单位] └ end_time Number 1516441828483 活动结束时间，时间戳[ms单位] └ terminals Number [] [1,2] 优惠适用场景:APP\|POS\|POS+APP 分别对应的值为1\|2\|1,2 └ shop_ids String [] [123,456] 参加活动的渠道店ids └ details String [] [仅限xx门店使用,本券不兑现] 自定义的优惠券使用详情(支持多条) └ start_fee Number 300 [满减券特有，券类型为满减券时为必传参数]金额门槛，值为-1代表无门槛 [单位为分] └ valid_days Number 5 领取后N日有效；如果设置了该值，则不需要设置优惠券的开始时间和结束时间 [有效期截止至领取日期+N天的23:59:59。例券设置有效期领取后5天有效，2018.1.1领取的券，有效期截止至2018.1.6 23:59:59；例券设置有效期领取后0天有效，2018.1.1领取的券，有效期截止至2018.1.1 23:59:59] └ apply_channels String fullSendCoupon 优惠券领取渠道 └ amount Number 200 券面额 [单位为分] └ applicable_categories Number [] [11,22] 适用类目 └ logo_url String https://www.taobao.com/ 优惠券logo url，设置匿名券时为必传参数 └ send_type String registered 优惠券发放方式 [anonymous:匿名券;registered:记名券] └ range_type String rangeShop 优惠券适用范围 [rangeShop:店铺券;rangeItem:商品;rangeCategory:品类券] └ discount_type String 优惠券优惠类型 [fullReduce:满减券;reduceTo:减至券，即一口价券] └ count Number [减至券特有]优惠件数，限制最多优惠N件，值为-1代表不限制优惠件数 [单位为整数] └ start_count Number [减至券特有]件数门槛，值为-1代表无门槛 [单位为整数] └ success Boolean true 查询商品是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkMarketingCouponQueryactivityRequest req = new AlibabaWdkMarketingCouponQueryactivityRequest();
AlibabaWdkMarketingCouponQueryactivityRequest.CommonActivityParam obj1 = new AlibabaWdkMarketingCouponQueryactivityRequest.CommonActivityParam();
obj1.setActivityId(124135L);
obj1.setOutActId("darunfa170907");
req.setParam0(obj1);
AlibabaWdkMarketingCouponQueryactivityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkMarketingCouponQueryactivityRequest req = new AlibabaWdkMarketingCouponQueryactivityRequest();
AlibabaWdkMarketingCouponQueryactivityRequest.CommonActivityParamDomain obj1 = new AlibabaWdkMarketingCouponQueryactivityRequest.CommonActivityParamDomain();
obj1.ActivityId = 124135L;
obj1.OutActId = "darunfa170907";
req.Param0_ = obj1;
AlibabaWdkMarketingCouponQueryactivityResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkMarketingCouponQueryactivityRequest;
$param0 = new CommonActivityParam;
$param0->activity_id="124135";
$param0->out_act_id="darunfa170907";
$req->setParam0(json_encode($param0));
$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.wdk.marketing.coupon.queryactivity' \
-d 'partner_id=apidoc' \
-d 'session=532852a5-8b28-4ae0-afc0-db3548e00faf' \
-d 'sign=AC3AA032F371BA848DEE9F162BCA7EB3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A56%3A47' \
-d 'v=2.0' \
-d 'param0=null'

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

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

req.param0=""
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.wdk.marketing.coupon.queryactivity");
add_param(pRequest,"param0","数据结构JSON示例");
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.wdk.marketing.coupon.queryactivity', {
	'param0':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_marketing_coupon_queryactivity_response>
    <result>
        <message>请求参数非法</message>
        <error_code>REQUEST_PARAM_ERROR</error_code>
        <data>
            <limit_info>
                <user_limit_cnt>10</user_limit_cnt>
                <user_daily_limit_cnt>2</user_daily_limit_cnt>
                <daily_limit_cnt>30</daily_limit_cnt>
                <total_limit_cnt>100</total_limit_cnt>
            </limit_info>
            <out_act_id>darunfa123123</out_act_id>
            <activity_name>满30建10优惠券</activity_name>
            <description>优惠券活动描述</description>
            <start_time>1516441828483</start_time>
            <end_time>1516441828483</end_time>
            <terminals>
                <number>[1</number>
                <number>2]</number>
            </terminals>
            <shop_ids>
                <string>[123</string>
                <string>456]</string>
            </shop_ids>
            <details>
                <string>[仅限xx门店使用</string>
                <string>本券不兑现]</string>
            </details>
            <start_fee>300</start_fee>
            <valid_days>5</valid_days>
            <apply_channels>fullSendCoupon</apply_channels>
            <amount>200</amount>
            <applicable_categories>
                <number>[11</number>
                <number>22]</number>
            </applicable_categories>
            <logo_url>https://www.taobao.com/</logo_url>
            <send_type>registered</send_type>
            <range_type>rangeShop</range_type>
            <discount_type></discount_type>
            <count></count>
            <start_count></start_count>
        </data>
        <success>true</success>
    </result>
</alibaba_wdk_marketing_coupon_queryactivity_response>

{
    "alibaba_wdk_marketing_coupon_queryactivity_response":{
        "result":{
            "message":"请求参数非法",
            "error_code":"REQUEST_PARAM_ERROR",
            "data":{
                "limit_info":{
                    "user_limit_cnt":10,
                    "user_daily_limit_cnt":2,
                    "daily_limit_cnt":30,
                    "total_limit_cnt":100
                },
                "out_act_id":"darunfa123123",
                "activity_name":"满30建10优惠券",
                "description":"优惠券活动描述",
                "start_time":1516441828483,
                "end_time":1516441828483,
                "terminals":{
                    "number":[
                        [1,
                        2]
                    ]
                },
                "shop_ids":{
                    "string":[
                        "[123",
                        "456]"
                    ]
                },
                "details":{
                    "string":[
                        "[仅限xx门店使用",
                        "本券不兑现]"
                    ]
                },
                "start_fee":300,
                "valid_days":5,
                "apply_channels":"fullSendCoupon",
                "amount":200,
                "applicable_categories":{
                    "number":[
                        [11,
                        22]
                    ]
                },
                "logo_url":"https:\/\/www.taobao.com\/",
                "send_type":"registered",
                "range_type":"rangeShop",
                "discount_type":"",
                "count":,
                "start_count":
            },
            "success":true
        }
    }
}

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下载

开放平台

五道口营销域

alibaba.wdk.marketing.coupon.queryactivity (查询优惠券活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ