淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	CouponActivity	必须			创建优惠券活动请求入参
└ range_type String 必须 rangeShop 优惠券适用范围 [rangeShop:店铺券;rangeItem:商品;rangeCategory:品类券] limit_info LimitInfo 必须通用限购信息，-1为不限制，默认为不限制[如果同时设置了(每人活动期间总限领)和(每人每日限领)，则只能生效(每人活动期间总限领)] └ daily_limit_cnt Number 可选 30 活动每日总限领 └ user_daily_limit_cnt Number 可选 2 每人每日限领 └ user_limit_cnt Number 可选 10 每人活动期间总限领 └ total_limit_cnt Number 必须 100 必须指定且值为正数，活动期间总限领 └ terminals String [] 必须 [1,2] 优惠适用场景[APP\|POS\|POS+APP分别对应的值为1\|2\|1,2] └ out_act_id String 可选 darunfa170907 商家活动id └ send_type String 必须 registered 优惠券发放方式 [anonymous:匿名券;registered:记名券] └ logo_url String 可选 https://www.taobao.com 优惠券logo url，设置匿名券时为必传参数 └ shop_ids String [] 必须 [123,456] 参加活动的渠道店ids └ end_time Number 可选 1506513600000 活动结束时间，时间戳[ms单位] └ applicable_categories Number [] 可选 [11,22] 适用类目 └ amount Number 必须 200 券面额 [单位为分] └ start_time Number 可选 1503835200000 活动开始时间，时间戳[ms单位] └ apply_channels String [] 必须 fullSendCoupon 优惠券领取渠道 [fullSendCoupon:满额返券;fallingSendCoupon:天降红包;customerService:客服补偿发券;其他渠道请找接口人申请] └ 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] └ description String 必须优惠券活动描述优惠券活动描述，不超过100个中文字符 └ start_fee Number 可选 300 [满减券特有，券类型为满减券时为必传参数]金额门槛，值为-1代表无门槛 [单位为分] └ activity_name String 必须优惠券活动名称优惠券活动名称,不超过10个中文字符 └ details String [] 可选 [仅限xx门店使用,本券不兑现] 自定义的优惠券使用详情(支持多条) └ discount_type String 必须 fullReduce 优惠券优惠类型 [fullReduce:满减券;reduceTo:减至券，即一口价券] └ start_count Number 可选 3 [减至券特有]件数门槛，值为-1代表无门槛 [单位为整数]【已下线】 └ count Number 可选 2 [减至券特有]优惠件数，限制最多优惠N件，值为-1代表不限制优惠件数 [单位为整数]【已下线】

名称	类型	示例值	描述
result	MarketResult		创建优惠券活动返回结果
└ message String 请求参数非法错误信息 └ data Number 124135 创建成功时会返回五道口优惠券活动id └ error_code String REQUEST_PARAM_ERROR 错误码 └ success Boolean true 创建优惠券活动是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHmMarketingCouponCreateactivityRequest req = new AlibabaHmMarketingCouponCreateactivityRequest();
AlibabaHmMarketingCouponCreateactivityRequest.CouponActivity obj1 = new AlibabaHmMarketingCouponCreateactivityRequest.CouponActivity();
obj1.setRangeType("rangeShop");
AlibabaHmMarketingCouponCreateactivityRequest.LimitInfo obj2 = new AlibabaHmMarketingCouponCreateactivityRequest.LimitInfo();
obj2.setDailyLimitCnt(30L);
obj2.setUserDailyLimitCnt(2L);
obj2.setUserLimitCnt(10L);
obj2.setTotalLimitCnt(100L);
obj1.setLimitInfo(obj2);
obj1.setTerminals("1,2");
obj1.setOutActId("darunfa170907");
obj1.setSendType("registered");
obj1.setLogoUrl("https://www.taobao.com");
obj1.setShopIds("123,456");
obj1.setEndTime(1506513600000L);
obj1.setApplicableCategories(new Long[] { 11,22 };
);
obj1.setAmount(200L);
obj1.setStartTime(1503835200000L);
obj1.setApplyChannels("fullSendCoupon");
obj1.setValidDays(5L);
obj1.setDescription("优惠券活动描述");
obj1.setStartFee(300L);
obj1.setActivityName("优惠券活动名称");
obj1.setDetails("仅限xx门店使用,本券不兑现");
obj1.setDiscountType("fullReduce");
obj1.setStartCount(3L);
obj1.setCount(2L);
req.setParam(obj1);
AlibabaHmMarketingCouponCreateactivityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHmMarketingCouponCreateactivityRequest req = new AlibabaHmMarketingCouponCreateactivityRequest();
AlibabaHmMarketingCouponCreateactivityRequest.CouponActivityDomain obj1 = new AlibabaHmMarketingCouponCreateactivityRequest.CouponActivityDomain();
obj1.RangeType = "rangeShop";
AlibabaHmMarketingCouponCreateactivityRequest.LimitInfoDomain obj2 = new AlibabaHmMarketingCouponCreateactivityRequest.LimitInfoDomain();
obj2.DailyLimitCnt = 30L;
obj2.UserDailyLimitCnt = 2L;
obj2.UserLimitCnt = 10L;
obj2.TotalLimitCnt = 100L;
obj1.LimitInfo= obj2;
obj1.Terminals = "1,2";
obj1.OutActId = "darunfa170907";
obj1.SendType = "registered";
obj1.LogoUrl = "https://www.taobao.com";
obj1.ShopIds = "123,456";
obj1.EndTime = 1506513600000L;
obj1.ApplicableCategories = new long[] { 11,22 };
;
obj1.Amount = 200L;
obj1.StartTime = 1503835200000L;
obj1.ApplyChannels = "fullSendCoupon";
obj1.ValidDays = 5L;
obj1.Description = "优惠券活动描述";
obj1.StartFee = 300L;
obj1.ActivityName = "优惠券活动名称";
obj1.Details = "仅限xx门店使用,本券不兑现";
obj1.DiscountType = "fullReduce";
obj1.StartCount = 3L;
obj1.Count = 2L;
req.Param_ = obj1;
AlibabaHmMarketingCouponCreateactivityResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHmMarketingCouponCreateactivityRequest;
$param = new CouponActivity;
$param->range_type="rangeShop";
$limit_info = new LimitInfo;
$limit_info->daily_limit_cnt="30";
$limit_info->user_daily_limit_cnt="2";
$limit_info->user_limit_cnt="10";
$limit_info->total_limit_cnt="100";
$param->limit_info = $limit_info;
$param->terminals="[1,2]";
$param->out_act_id="darunfa170907";
$param->send_type="registered";
$param->logo_url="https://www.taobao.com";
$param->shop_ids="[123,456]";
$param->end_time="1506513600000";
$param->applicable_categories="[11,22]";
$param->amount="200";
$param->start_time="1503835200000";
$param->apply_channels="fullSendCoupon";
$param->valid_days="5";
$param->description="优惠券活动描述";
$param->start_fee="300";
$param->activity_name="优惠券活动名称";
$param->details="[仅限xx门店使用,本券不兑现]";
$param->discount_type="fullReduce";
$param->start_count="3";
$param->count="2";
$req->setParam(json_encode($param));
$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.hm.marketing.coupon.createactivity' \
-d 'partner_id=apidoc' \
-d 'session=4e9e6a11-9dd9-406e-ba6a-f3a1d6f201f2' \
-d 'sign=B7FA796E780B575CB1C6E454187414C9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+12%3A14%3A39' \
-d 'v=2.0' \
-d 'param=null'

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

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

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

XML示例
JSON示例

<alibaba_hm_marketing_coupon_createactivity_response>
    <result>
        <message>请求参数非法</message>
        <data>124135</data>
        <error_code>REQUEST_PARAM_ERROR</error_code>
        <success>true</success>
    </result>
</alibaba_hm_marketing_coupon_createactivity_response>

{
    "alibaba_hm_marketing_coupon_createactivity_response":{
        "result":{
            "message":"请求参数非法",
            "data":124135,
            "error_code":"REQUEST_PARAM_ERROR",
            "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.hm.marketing.coupon.createactivity (优惠券活动创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ