淘宝开放平台 - 文档中心

请求地址：

环境	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	ItemPoolActivityOperateRequest	必须			创建商品池活动参数
periodic_config PeriodicConfigDto 可选周期配置 └ every_day_periods String [] 可选 ["03:00:00_05:00:00"] 每天的什么时间阶段搞活动,精确到秒单位例如:03:00:00_05:00:00 └ periodic Boolean 可选 true 周期配置是否生效 └ weekdays String [] 可选 [1,2,3] 星期几搞活动 [1:Mon;2:Tues;3:Wed;4:Thur;5:Fri;6:Sat;7:Sun] └ activity_name String 必须 erp特价活动名称，最长15个字符 └ creator_id String 必须 1123 操作人id └ creator_name String 必须操作人名称操作人名称 └ description String 可选 erp特价活动描述活动描述，最长30个字符 stair_groups StairGroupDto [] 必须阶梯分组 └ number Number 必须 1 分组序号 condition Condition 必须优惠门槛 └ amount Number 可选 1000 满元金额，单位分 └ count_at Boolean 可选 false 是否满件 └ count_begin Boolean 可选 false 是否指定件数 └ appoint Boolean 可选 false 是否第N件 └ count Number 可选 1 满件门槛 └ amount_at Boolean 可选 true 是否满元 action Action 必须优惠效果 └ decrease_money Number 可选 10 减钱金额，单位分 └ discount_rate Number 可选 950 折扣，950，表示9.5折 └ discount Boolean 可选 false 是否打折 └ fix_price Boolean 可选 false 是否一口价 └ fix_price_money Number 可选 100 一口价金额，单位分 └ decrease Boolean 可选 true 是否减钱 └ fix_price_type Number 可选 1 一口价类型，0：普通一口价，1：第N件一口价，2：整体一口价 └ terminals String [] 必须 [1,2] 支持的终端，1：APP,2:POS └ store_ids String [] 必须 ["CSWZWA013"] 经营店 limit LimitDto 可选限购 └ order_limit_cnt Number 可选 10 每单限购 └ daily_total_limit_cnt Number 可选 20 每日总限购 └ total_limit_cnt Number 可选 20 总限购 └ user_total_limit_cnt Number 可选 20 每人总限购 └ user_daily_limit_cnt Number 可选 20 每人每日总限购 └ out_act_id String 可选 141231 外部商家erp活动id └ start_time Number 必须 1609396282413 活动开始时间戳 └ end_time Number 必须 1609396282413 活动结束时间戳 └ member_crowd_code String [] 可选 ["NEW_USER"] 限制人群,OLD_USER:老用户，NEW_USER:新用户，LIGHT_NEW_USER：闪购新客，MERCHANT_NEW_USER：商家新用户，MERCHANT_OLD_USER：商家老用户 logic_groups LogicGroupDto [] 必须逻辑分组 └ number Number 必须 1 分组序号，换购场景需要两个逻辑分组，一个序号为1的普通逻辑分组和一个序号为2的换购逻辑分组 └ type Number 必须 1 分组类型，1: 普通分组， 2: 换购分组 └ exchange Boolean 可选 false 换购分组标识 exchange_rule ExchangeRuleDto 可选换购规则 └ max_buy_num Number 可选 1 每组最大购买数量, 单次下单可换购的不同sku商品数。换购分组该字段为必填 └ order_num Number 可选 1 换购分组顺序 └ effective_group Boolean 必须 true 是否生效分组（多分组情况下，可能为false，例如商品池换购，普通逻辑分组为false，换购分组为true） └ enable_multiple Boolean 可选 false 上不封顶标识，若设置{@link #enableMultiple}=true，则不支持多阶梯配置，且可以叠加优惠 └ channels String [] 可选 ["2","3"] 枚举： 2 美团 3 饿了么 26 京东到家 31 翱象淘鲜达 32 翱象共享库存 └ attributes String 可选 {"type":"1"} 扩展信息

名称	类型	示例值	描述
result	OctopusOpenResult	result	操作结果
└ data Number 111 活动id └ success Boolean true 是否成功 └ error_message String 系统错误错误提示 └ error_code String system_error 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaRetailMarketingItempoolActivityCreateRequest req = new AlibabaRetailMarketingItempoolActivityCreateRequest();
AlibabaRetailMarketingItempoolActivityCreateRequest.ItemPoolActivityOperateRequest obj1 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ItemPoolActivityOperateRequest();
AlibabaRetailMarketingItempoolActivityCreateRequest.PeriodicConfigDto obj2 = new AlibabaRetailMarketingItempoolActivityCreateRequest.PeriodicConfigDto();
obj2.setEveryDayPeriods(""03:00:00_05:00:00"");
obj2.setPeriodic(true);
obj2.setWeekdays("1,2,3");
obj1.setPeriodicConfig(obj2);
obj1.setActivityName("erp特价");
obj1.setCreatorId("1123");
obj1.setCreatorName("操作人名称");
obj1.setDescription("erp特价活动描述");
List<AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDto> list4 = new ArrayList<AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDto>();
AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDto obj5 = new AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDto();
list4.add(obj5);
obj5.setNumber(1L);
AlibabaRetailMarketingItempoolActivityCreateRequest.Condition obj7 = new AlibabaRetailMarketingItempoolActivityCreateRequest.Condition();
obj7.setAmount(1000L);
obj7.setCountAt(false);
obj7.setCountBegin(false);
obj7.setAppoint(false);
obj7.setCount(1L);
obj7.setAmountAt(true);
list6.setCondition(obj7);
AlibabaRetailMarketingItempoolActivityCreateRequest.Action obj9 = new AlibabaRetailMarketingItempoolActivityCreateRequest.Action();
obj9.setDecreaseMoney(10L);
obj9.setDiscountRate(950L);
obj9.setDiscount(false);
obj9.setFixPrice(false);
obj9.setFixPriceMoney(100L);
obj9.setDecrease(true);
obj9.setFixPriceType(1L);
list8.setAction(obj9);
obj1.setStairGroups(list4);
obj1.setTerminals("1,2");
obj1.setStoreIds(""CSWZWA013"");
AlibabaRetailMarketingItempoolActivityCreateRequest.LimitDto obj10 = new AlibabaRetailMarketingItempoolActivityCreateRequest.LimitDto();
obj10.setOrderLimitCnt(10L);
obj10.setDailyTotalLimitCnt(20L);
obj10.setTotalLimitCnt(20L);
obj10.setUserTotalLimitCnt(20L);
obj10.setUserDailyLimitCnt(20L);
obj1.setLimit(obj10);
obj1.setOutActId("141231");
obj1.setStartTime(1609396282413L);
obj1.setEndTime(1609396282413L);
obj1.setMemberCrowdCode(""NEW_USER"");
List<AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDto> list12 = new ArrayList<AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDto>();
AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDto obj13 = new AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDto();
list12.add(obj13);
obj13.setNumber(1L);
obj13.setType(1L);
obj13.setExchange(false);
AlibabaRetailMarketingItempoolActivityCreateRequest.ExchangeRuleDto obj15 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ExchangeRuleDto();
obj15.setMaxBuyNum(1L);
obj15.setOrderNum(1L);
list14.setExchangeRule(obj15);
obj13.setEffectiveGroup(true);
obj1.setLogicGroups(list12);
obj1.setEnableMultiple(false);
obj1.setChannels(""2","3"");
obj1.setAttributes("{\"type\":\"1\"}");
req.setParam(obj1);
AlibabaRetailMarketingItempoolActivityCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaRetailMarketingItempoolActivityCreateRequest req = new AlibabaRetailMarketingItempoolActivityCreateRequest();
AlibabaRetailMarketingItempoolActivityCreateRequest.ItemPoolActivityOperateRequestDomain obj1 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ItemPoolActivityOperateRequestDomain();
AlibabaRetailMarketingItempoolActivityCreateRequest.PeriodicConfigDtoDomain obj2 = new AlibabaRetailMarketingItempoolActivityCreateRequest.PeriodicConfigDtoDomain();
obj2.EveryDayPeriods = ""03:00:00_05:00:00"";
obj2.Periodic = true;
obj2.Weekdays = "1,2,3";
obj1.PeriodicConfig= obj2;
obj1.ActivityName = "erp特价";
obj1.CreatorId = "1123";
obj1.CreatorName = "操作人名称";
obj1.Description = "erp特价活动描述";
List<AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDtoDomain> list4 = new List<AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDtoDomain>();
AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDtoDomain obj5 = new AlibabaRetailMarketingItempoolActivityCreateRequest.StairGroupDtoDomain();
list4.Add(obj5);
obj5.Number = 1L;
AlibabaRetailMarketingItempoolActivityCreateRequest.ConditionDomain obj6 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ConditionDomain();
obj6.Amount = 1000L;
obj6.CountAt = false;
obj6.CountBegin = false;
obj6.Appoint = false;
obj6.Count = 1L;
obj6.AmountAt = true;
obj5.Condition= obj6;
AlibabaRetailMarketingItempoolActivityCreateRequest.ActionDomain obj7 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ActionDomain();
obj7.DecreaseMoney = 10L;
obj7.DiscountRate = 950L;
obj7.Discount = false;
obj7.FixPrice = false;
obj7.FixPriceMoney = 100L;
obj7.Decrease = true;
obj7.FixPriceType = 1L;
obj5.Action= obj7;
obj1.StairGroups= list4;
obj1.Terminals = "1,2";
obj1.StoreIds = ""CSWZWA013"";
AlibabaRetailMarketingItempoolActivityCreateRequest.LimitDtoDomain obj8 = new AlibabaRetailMarketingItempoolActivityCreateRequest.LimitDtoDomain();
obj8.OrderLimitCnt = 10L;
obj8.DailyTotalLimitCnt = 20L;
obj8.TotalLimitCnt = 20L;
obj8.UserTotalLimitCnt = 20L;
obj8.UserDailyLimitCnt = 20L;
obj1.Limit= obj8;
obj1.OutActId = "141231";
obj1.StartTime = 1609396282413L;
obj1.EndTime = 1609396282413L;
obj1.MemberCrowdCode = ""NEW_USER"";
List<AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDtoDomain> list10 = new List<AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDtoDomain>();
AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDtoDomain obj11 = new AlibabaRetailMarketingItempoolActivityCreateRequest.LogicGroupDtoDomain();
list10.Add(obj11);
obj11.Number = 1L;
obj11.Type = 1L;
obj11.Exchange = false;
AlibabaRetailMarketingItempoolActivityCreateRequest.ExchangeRuleDtoDomain obj12 = new AlibabaRetailMarketingItempoolActivityCreateRequest.ExchangeRuleDtoDomain();
obj12.MaxBuyNum = 1L;
obj12.OrderNum = 1L;
obj11.ExchangeRule= obj12;
obj11.EffectiveGroup = true;
obj1.LogicGroups= list10;
obj1.EnableMultiple = false;
obj1.Channels = ""2","3"";
obj1.Attributes = "{\"type\":\"1\"}";
req.Param_ = obj1;
AlibabaRetailMarketingItempoolActivityCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaRetailMarketingItempoolActivityCreateRequest;
$param = new ItemPoolActivityOperateRequest;
$periodic_config = new PeriodicConfigDto;
$periodic_config->every_day_periods="[\"03:00:00_05:00:00\"]";
$periodic_config->periodic="true";
$periodic_config->weekdays="[1,2,3]";
$param->periodic_config = $periodic_config;
$param->activity_name="erp特价";
$param->creator_id="1123";
$param->creator_name="操作人名称";
$param->description="erp特价活动描述";
$stair_groups = new StairGroupDto;
$stair_groups->number="1";
$condition = new Condition;
$condition->amount="1000";
$condition->count_at="false";
$condition->count_begin="false";
$condition->appoint="false";
$condition->count="1";
$condition->amount_at="true";
$stair_groups->condition = $condition;
$action = new Action;
$action->decrease_money="10";
$action->discount_rate="950";
$action->discount="false";
$action->fix_price="false";
$action->fix_price_money="100";
$action->decrease="true";
$action->fix_price_type="1";
$stair_groups->action = $action;
$param->stair_groups = $stair_groups;
$param->terminals="[1,2]";
$param->store_ids="[\"CSWZWA013\"]";
$limit = new LimitDto;
$limit->order_limit_cnt="10";
$limit->daily_total_limit_cnt="20";
$limit->total_limit_cnt="20";
$limit->user_total_limit_cnt="20";
$limit->user_daily_limit_cnt="20";
$param->limit = $limit;
$param->out_act_id="141231";
$param->start_time="1609396282413";
$param->end_time="1609396282413";
$param->member_crowd_code="[\"NEW_USER\"]";
$logic_groups = new LogicGroupDto;
$logic_groups->number="1";
$logic_groups->type="1";
$logic_groups->exchange="false";
$exchange_rule = new ExchangeRuleDto;
$exchange_rule->max_buy_num="1";
$exchange_rule->order_num="1";
$logic_groups->exchange_rule = $exchange_rule;
$logic_groups->effective_group="true";
$param->logic_groups = $logic_groups;
$param->enable_multiple="false";
$param->channels="[\"2\",\"3\"]";
$param->attributes="{\"type\":\"1\"}";
$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.retail.marketing.itempool.activity.create' \
-d 'partner_id=apidoc' \
-d 'session=9dc25f1b-5e47-455d-85fc-6dd5294c9a4d' \
-d 'sign=2397D16D1C38CA2DB3538DA4159EC46D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A39%3A23' \
-d 'v=2.0' \
-d 'param=null'

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

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

XML示例
JSON示例

<alibaba_retail_marketing_itempool_activity_create_response>
    <result>
        <data>111</data>
        <success>true</success>
        <error_message>系统错误</error_message>
        <error_code>system_error</error_code>
    </result>
</alibaba_retail_marketing_itempool_activity_create_response>

{
    "alibaba_retail_marketing_itempool_activity_create_response":{
        "result":{
            "data":111,
            "success":true,
            "error_message":"系统错误",
            "error_code":"system_error"
        }
    }
}

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.retail.marketing.itempool.activity.create (创建商品池活动【同城零售】)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ