淘宝开放平台 - 文档中心

请求地址：

环境	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	ItemPoolActivity	必须			创建活动请求入参
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 可选 sanjiang170907 商家活动id └ shop_ids String [] 必须 [123,456] 参加活动的渠道店ids └ end_time Number 必须 1506513600000 活动结束时间，时间戳 rule_stairs Rulestairs [] 必须商品池活动的梯度列表 └ enable_multiple Boolean 可选 false 活动是否上不封顶 └ amount_at Boolean 可选 false 是否使用满元条件，不能与满件、N件Y折同时使用。此选项为true时，countAt和countBegin必须为false └ amount Number 可选 700 满多少元[单位为分，传入700，代表满7元]，amountAt为true时，必须设置 └ count_at Boolean 可选 false 是否使用满件条件，不能与满元、N件Y折同时使用。此选项为true时，countBegin和amountAt必须为false └ count_begin Boolean 可选 false 是否使用N件Y折或N件Y元，不能与满元、满件同时使用。此选项为true时，countAt和amountAt必须为false └ count Number 可选 4 满多少件或者第多少件开始参与活动[传入4，代表满4件打折或者第4件打折]。该值与countBegin和countAt相关，如果countBegin为true，则为N件Y折活动，如果countAt为true，则为满件活动 └ decrease Boolean 可选 false 是否使用减钱功能，不能与打折功能同时使用，此选项为true时，discount必须为false └ decrease_money Number 可选 700 减多少元[单位为分，传入700，代表减7元]，decrease为true时，必须设置 └ discount Boolean 可选 false 是否使用打折功能，不能与减钱功能同时使用，此选项为true时，decrease必须为false └ discount_rate Number 可选 900 打几折[单位为分，传入900，代表打9折]，discount为true时，必须设置 └ is_exchange Boolean 可选 true 是否为换购活动 └ can_extra_item_num Number 可选 1 可换购的数量 └ fix_price Boolean 可选 false 是否一口价 └ fix_price_amount Number 可选 1000 一口价[单位为分] └ start_time Number 必须 1503835200000 活动开始时间，时间戳 └ description String 必须商品池活动描述商品池活动详情描述,不超过30个英文字符 └ activity_name String 必须商品池活动名称商品池活动名称,不超过10个英文字符 └ member_limit Number 可选 1 会员维度活动参与人群限制：-1:不限制 1:会员专享 2:非会员专享 └ merchant_crowd_code String 可选 OLD_USER 商家人群编码 └ txd_crowd_code String 可选 ~OLD_USER 淘鲜达人群编码 └ is_category Boolean 可选 false 是否是类目活动 └ by_channel Boolean 可选 true 是否自定义渠道同步 channel_config_list ChannelConfig [] 可选 [] 自定义同步渠道配置 └ channel String 可选 31 淘鲜达:"31",饿了么:"3",京东到家:"26",美团外卖:"2"

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

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkMarketingItempoolCreateactivityRequest req = new AlibabaWdkMarketingItempoolCreateactivityRequest();
AlibabaWdkMarketingItempoolCreateactivityRequest.ItemPoolActivity obj1 = new AlibabaWdkMarketingItempoolCreateactivityRequest.ItemPoolActivity();
AlibabaWdkMarketingItempoolCreateactivityRequest.LimitInfo obj2 = new AlibabaWdkMarketingItempoolCreateactivityRequest.LimitInfo();
obj2.setDailyLimitCnt(30L);
obj2.setUserDailyLimitCnt(2L);
obj2.setUserLimitCnt(10L);
obj2.setTotalLimitCnt(100L);
obj1.setLimitInfo(obj2);
obj1.setTerminals("1,2");
obj1.setOutActId("sanjiang170907");
obj1.setShopIds("123,456");
obj1.setEndTime(1506513600000L);
List<AlibabaWdkMarketingItempoolCreateactivityRequest.Rulestairs> list4 = new ArrayList<AlibabaWdkMarketingItempoolCreateactivityRequest.Rulestairs>();
AlibabaWdkMarketingItempoolCreateactivityRequest.Rulestairs obj5 = new AlibabaWdkMarketingItempoolCreateactivityRequest.Rulestairs();
list4.add(obj5);
obj5.setEnableMultiple(false);
obj5.setAmountAt(false);
obj5.setAmount(700L);
obj5.setCountAt(false);
obj5.setCountBegin(false);
obj5.setCount(4L);
obj5.setDecrease(false);
obj5.setDecreaseMoney(700L);
obj5.setDiscount(false);
obj5.setDiscountRate(900L);
obj5.setIsExchange(true);
obj5.setCanExtraItemNum(1L);
obj5.setFixPrice(false);
obj5.setFixPriceAmount(1000L);
obj1.setRuleStairs(list4);
obj1.setStartTime(1503835200000L);
obj1.setDescription("商品池活动描述");
obj1.setActivityName("商品池活动名称");
obj1.setMemberLimit(1L);
obj1.setMerchantCrowdCode("OLD_USER");
obj1.setTxdCrowdCode("~OLD_USER");
obj1.setIsCategory(false);
obj1.setByChannel(true);
List<AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfig> list7 = new ArrayList<AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfig>();
AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfig obj8 = new AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfig();
list7.add(obj8);
obj8.setChannel("31");
obj1.setChannelConfigList(list7);
req.setParam(obj1);
AlibabaWdkMarketingItempoolCreateactivityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkMarketingItempoolCreateactivityRequest req = new AlibabaWdkMarketingItempoolCreateactivityRequest();
AlibabaWdkMarketingItempoolCreateactivityRequest.ItemPoolActivityDomain obj1 = new AlibabaWdkMarketingItempoolCreateactivityRequest.ItemPoolActivityDomain();
AlibabaWdkMarketingItempoolCreateactivityRequest.LimitInfoDomain obj2 = new AlibabaWdkMarketingItempoolCreateactivityRequest.LimitInfoDomain();
obj2.DailyLimitCnt = 30L;
obj2.UserDailyLimitCnt = 2L;
obj2.UserLimitCnt = 10L;
obj2.TotalLimitCnt = 100L;
obj1.LimitInfo= obj2;
obj1.Terminals = "1,2";
obj1.OutActId = "sanjiang170907";
obj1.ShopIds = "123,456";
obj1.EndTime = 1506513600000L;
List<AlibabaWdkMarketingItempoolCreateactivityRequest.RulestairsDomain> list4 = new List<AlibabaWdkMarketingItempoolCreateactivityRequest.RulestairsDomain>();
AlibabaWdkMarketingItempoolCreateactivityRequest.RulestairsDomain obj5 = new AlibabaWdkMarketingItempoolCreateactivityRequest.RulestairsDomain();
list4.Add(obj5);
obj5.EnableMultiple = false;
obj5.AmountAt = false;
obj5.Amount = 700L;
obj5.CountAt = false;
obj5.CountBegin = false;
obj5.Count = 4L;
obj5.Decrease = false;
obj5.DecreaseMoney = 700L;
obj5.Discount = false;
obj5.DiscountRate = 900L;
obj5.IsExchange = true;
obj5.CanExtraItemNum = 1L;
obj5.FixPrice = false;
obj5.FixPriceAmount = 1000L;
obj1.RuleStairs= list4;
obj1.StartTime = 1503835200000L;
obj1.Description = "商品池活动描述";
obj1.ActivityName = "商品池活动名称";
obj1.MemberLimit = 1L;
obj1.MerchantCrowdCode = "OLD_USER";
obj1.TxdCrowdCode = "~OLD_USER";
obj1.IsCategory = false;
obj1.ByChannel = true;
List<AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfigDomain> list7 = new List<AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfigDomain>();
AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfigDomain obj8 = new AlibabaWdkMarketingItempoolCreateactivityRequest.ChannelConfigDomain();
list7.Add(obj8);
obj8.Channel = "31";
obj1.ChannelConfigList= list7;
req.Param_ = obj1;
AlibabaWdkMarketingItempoolCreateactivityResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkMarketingItempoolCreateactivityRequest;
$param = new ItemPoolActivity;
$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="sanjiang170907";
$param->shop_ids="[123,456]";
$param->end_time="1506513600000";
$rule_stairs = new Rulestairs;
$rule_stairs->enable_multiple="false";
$rule_stairs->amount_at="false";
$rule_stairs->amount="700";
$rule_stairs->count_at="false";
$rule_stairs->count_begin="false";
$rule_stairs->count="4";
$rule_stairs->decrease="false";
$rule_stairs->decrease_money="700";
$rule_stairs->discount="false";
$rule_stairs->discount_rate="900";
$rule_stairs->is_exchange="true";
$rule_stairs->can_extra_item_num="1";
$rule_stairs->fix_price="false";
$rule_stairs->fix_price_amount="1000";
$param->rule_stairs = $rule_stairs;
$param->start_time="1503835200000";
$param->description="商品池活动描述";
$param->activity_name="商品池活动名称";
$param->member_limit="1";
$param->merchant_crowd_code="OLD_USER";
$param->txd_crowd_code="~OLD_USER";
$param->is_category="false";
$param->by_channel="true";
$channel_config_list = new ChannelConfig;
$channel_config_list->channel="31";
$param->channel_config_list = $channel_config_list;
$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.wdk.marketing.itempool.createactivity' \
-d 'partner_id=apidoc' \
-d 'session=d471f582-2069-468e-92e4-365d5bc3baba' \
-d 'sign=2624389D403DD6E958B5776DB0CDDD43' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A48%3A25' \
-d 'v=2.0' \
-d 'param=null'

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

req=top.api.AlibabaWdkMarketingItempoolCreateactivityRequest(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.wdk.marketing.itempool.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.wdk.marketing.itempool.createactivity', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

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

{
    "alibaba_wdk_marketing_itempool_createactivity_response":{
        "result":{
            "message":"请求参数非法",
            "error_code":"REQUEST_PARAM_ERROR",
            "data":124135,
            "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.itempool.createactivity (添加商品池活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ