淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 sanjiang170907 商家活动id └ by_channel Boolean 可选 true 是否自定义渠道同步 channel_config_list ChannelConfig [] 可选 [] 自定义同步渠道配置 └ channel String 可选 31 淘鲜达:"31",饿了么:"3",京东到家:"26",美团外卖:"2"

名称	类型	示例值	描述
result	MarketResult		查询返回结果
└ error_code String REQUEST_PARAM_ERROR 错误码 data ItemPoolActivity 返回的商品池活动信息 limit_info LimitInfo 通用限购信息，-1为不限制，默认为不限制 └ user_limit_cnt Number 10 每人活动期间总限购 └ user_daily_limit_cnt Number 2 每人每日限购 └ daily_limit_cnt Number 30 活动每日总限购 rule_stairs Rulestairs [] 商品池活动的梯度列表 └ enable_multiple Boolean false 活动是否上不封顶[只有满元活动可以使用上不封顶，且使用此功能时，只能有一个梯度]。如果活动设置为满10元减1元，传true代表满10元减1元，满20减2元，以此类推；传false代表满10元减1元，满20也减1元，以此类推 └ 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折，不能与满元、满件同时使用。此选项为true时，countAt和amountAt必须为false └ count Number 4 满多少件或者第多少件开始参与活动[传入4，代表满4件打折或者第4件打折]。该值与countBegin和countAt相关，如果countBegin为true，则为N件Y折活动，如果countAt为true，则为满件活动 └ decrease_money Number 700 减多少元[单位为分，传入700，代表减7元]，decrease为true时，必须设置 └ decrease Boolean false 是否使用减钱功能，不能与打折功能同时使用，此选项为true时，discount必须为false └ 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_amount Number 10 一口价价格[单位为分] └ fix_price Boolean false 一口价 └ out_act_id String sanjiang123123 商家活动id └ activity_id Number 123123 报名活动Id └ activity_name String 满30-10 活动名称 └ description String 三江满件活动活动描述 └ start_time Number 1516441828483 startTime └ end_time Number 1516441828483 endTime └ terminals Number [] [1,2] 优惠适用场景:APP\|POS\|POS+APP 分别对应的值为1\|2\|1,2 └ member_limit Number 1 会员维度活动参与人群限制：-1:不限制 1:会员专享 2:非会员专享 └ shop_ids String [] ["123","345"] shopIds └ merchant_crowd_code String SANJDEM merchantCrowdCode └ txd_crowd_code String ~SANJDEM txdCrowdCode └ success Boolean true 查询商品是否成功 └ message String 请求参数非法错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHmMarketingItempoolQueryactivityRequest req = new AlibabaHmMarketingItempoolQueryactivityRequest();
AlibabaHmMarketingItempoolQueryactivityRequest.CommonActivityParam obj1 = new AlibabaHmMarketingItempoolQueryactivityRequest.CommonActivityParam();
obj1.setActivityId(124135L);
obj1.setOutActId("sanjiang170907");
obj1.setByChannel(true);
List<AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfig> list3 = new ArrayList<AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfig>();
AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfig obj4 = new AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfig();
list3.add(obj4);
obj4.setChannel("31");
obj1.setChannelConfigList(list3);
req.setParam0(obj1);
AlibabaHmMarketingItempoolQueryactivityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHmMarketingItempoolQueryactivityRequest req = new AlibabaHmMarketingItempoolQueryactivityRequest();
AlibabaHmMarketingItempoolQueryactivityRequest.CommonActivityParamDomain obj1 = new AlibabaHmMarketingItempoolQueryactivityRequest.CommonActivityParamDomain();
obj1.ActivityId = 124135L;
obj1.OutActId = "sanjiang170907";
obj1.ByChannel = true;
List<AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfigDomain> list3 = new List<AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfigDomain>();
AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfigDomain obj4 = new AlibabaHmMarketingItempoolQueryactivityRequest.ChannelConfigDomain();
list3.Add(obj4);
obj4.Channel = "31";
obj1.ChannelConfigList= list3;
req.Param0_ = obj1;
AlibabaHmMarketingItempoolQueryactivityResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHmMarketingItempoolQueryactivityRequest;
$param0 = new CommonActivityParam;
$param0->activity_id="124135";
$param0->out_act_id="sanjiang170907";
$param0->by_channel="true";
$channel_config_list = new ChannelConfig;
$channel_config_list->channel="31";
$param0->channel_config_list = $channel_config_list;
$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.hm.marketing.itempool.queryactivity' \
-d 'partner_id=apidoc' \
-d 'session=ffb4d7b0-2df9-4eed-8ffa-ed6b8a0a7925' \
-d 'sign=A8C2CA640B5EEB33A99B2E640958B4FA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A57%3A22' \
-d 'v=2.0' \
-d 'param0=null'

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

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

XML示例
JSON示例

<alibaba_hm_marketing_itempool_queryactivity_response>
    <result>
        <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>
            </limit_info>
            <rule_stairs>
                <rulestairs>
                    <enable_multiple>false</enable_multiple>
                    <amount_at>false</amount_at>
                    <amount>700</amount>
                    <count_at>false</count_at>
                    <count_begin>false</count_begin>
                    <count>4</count>
                    <decrease_money>700</decrease_money>
                    <decrease>false</decrease>
                    <discount>false</discount>
                    <discount_rate>900</discount_rate>
                    <is_exchange>true</is_exchange>
                    <can_extra_item_num>1</can_extra_item_num>
                    <fix_price_amount>10</fix_price_amount>
                    <fix_price>false</fix_price>
                </rulestairs>
            </rule_stairs>
            <out_act_id>sanjiang123123</out_act_id>
            <activity_id>123123</activity_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>
            <member_limit>1</member_limit>
            <shop_ids>
                <string>[&quot;123&quot;</string>
                <string>&quot;345&quot;]</string>
            </shop_ids>
            <merchant_crowd_code>SANJDEM</merchant_crowd_code>
            <txd_crowd_code>~SANJDEM</txd_crowd_code>
        </data>
        <success>true</success>
        <message>请求参数非法</message>
    </result>
</alibaba_hm_marketing_itempool_queryactivity_response>

{
    "alibaba_hm_marketing_itempool_queryactivity_response":{
        "result":{
            "error_code":"REQUEST_PARAM_ERROR",
            "data":{
                "limit_info":{
                    "user_limit_cnt":10,
                    "user_daily_limit_cnt":2,
                    "daily_limit_cnt":30
                },
                "rule_stairs":{
                    "rulestairs":[
                        {
                            "enable_multiple":false,
                            "amount_at":false,
                            "amount":700,
                            "count_at":false,
                            "count_begin":false,
                            "count":4,
                            "decrease_money":700,
                            "decrease":false,
                            "discount":false,
                            "discount_rate":900,
                            "is_exchange":true,
                            "can_extra_item_num":1,
                            "fix_price_amount":10,
                            "fix_price":false
                        }
                    ]
                },
                "out_act_id":"sanjiang123123",
                "activity_id":123123,
                "activity_name":"满30-10",
                "description":"三江满件活动",
                "start_time":1516441828483,
                "end_time":1516441828483,
                "terminals":{
                    "number":[
                        [1,
                        2]
                    ]
                },
                "member_limit":1,
                "shop_ids":{
                    "string":[
                        "[\"123\"",
                        "\"345\"]"
                    ]
                },
                "merchant_crowd_code":"SANJDEM",
                "txd_crowd_code":"~SANJDEM"
            },
            "success":true,
            "message":"请求参数非法"
        }
    }
}

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.itempool.queryactivity (查找商品池活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ