淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
activity_id	String	可选	123	活动id
activity_status	String	可选	ENABLED	活动状态
activity_type_id	Number	可选	1	活动类型
brand_id	String	可选	123	品牌id(brandId和outerBrandId必传其一)
operator_id	String	可选	123	操作人id
operator_name	String	可选	name	操作人姓名
out_brand_id	String	可选	123	外部品牌id
out_shop_id	String	可选	123	外部门店id
request_id	String	可选	12323123	请求幂等id
shop_id	String	可选	123	门店id

名称	类型	示例值	描述
result	CommonResult	Object	接口结果
└ biz_success Boolean true 是否成功 result ActivityListInfo Object 结果 activity_infos ActivityInfo [] List 活动信息 └ activity_customer String 无目标人群 └ activity_desc String 无活动描述 └ activity_id String 123 活动id └ activity_name String 活动活动名称 └ activity_rule String [{"voucher":[{"voucherId":"12345","voucherNum":"1"}], "gmtStart":"2018-07-09 00:00:00","gmtEnd":"2018-07-09 00:00:00",shop:"123,456","isDaily":"Y"}] 活动规则 └ activity_shops String [] 123,456 目标门店 └ activity_type_id Number 1 活动类型 └ brand_id String 1 品牌id └ gmt_end String 2018-07-09 00:00:00 有效期结束日期 └ gmt_start String 2018-07-09 00:00:00 有效期开始日期 └ out_biz_id String 1 外部业务ID └ source_channel String 1 来源 └ status String ENABLED 活动状态 └ result_code String 1 错误码 └ result_desc String 成功错误描述 └ result_view String 成功错误展示信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmMarketingActivitySearchRequest req = new AlibabaAlscCrmMarketingActivitySearchRequest();
req.setActivityId("123");
req.setActivityStatus("ENABLED");
req.setActivityTypeId(1L);
req.setBrandId("123");
req.setOperatorId("123");
req.setOperatorName("name");
req.setOutBrandId("123");
req.setOutShopId("123");
req.setRequestId("12323123");
req.setShopId("123");
AlibabaAlscCrmMarketingActivitySearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmMarketingActivitySearchRequest req = new AlibabaAlscCrmMarketingActivitySearchRequest();
req.ActivityId = "123";
req.ActivityStatus = "ENABLED";
req.ActivityTypeId = 1L;
req.BrandId = "123";
req.OperatorId = "123";
req.OperatorName = "name";
req.OutBrandId = "123";
req.OutShopId = "123";
req.RequestId = "12323123";
req.ShopId = "123";
AlibabaAlscCrmMarketingActivitySearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmMarketingActivitySearchRequest;
$req->setActivityId("123");
$req->setActivityStatus("ENABLED");
$req->setActivityTypeId("1");
$req->setBrandId("123");
$req->setOperatorId("123");
$req->setOperatorName("name");
$req->setOutBrandId("123");
$req->setOutShopId("123");
$req->setRequestId("12323123");
$req->setShopId("123");
$resp = $c->execute($req);

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.alsc.crm.marketing.activity.search' \
-d 'partner_id=apidoc' \
-d 'sign=35B972B47D0CE853D852282BD3850F5F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+16%3A41%3A49' \
-d 'v=2.0' \
-d 'activity_id=123' \
-d 'activity_status=ENABLED' \
-d 'activity_type_id=1' \
-d 'brand_id=123' \
-d 'operator_id=123' \
-d 'operator_name=name' \
-d 'out_brand_id=123' \
-d 'out_shop_id=123' \
-d 'request_id=12323123' \
-d 'shop_id=123'

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

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

req.activity_id="123"
req.activity_status="ENABLED"
req.activity_type_id=1
req.brand_id="123"
req.operator_id="123"
req.operator_name="name"
req.out_brand_id="123"
req.out_shop_id="123"
req.request_id="12323123"
req.shop_id="123"
try:
	resp= req.getResponse()
	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.alsc.crm.marketing.activity.search");
add_param(pRequest,"activity_id","123");
add_param(pRequest,"activity_status","ENABLED");
add_param(pRequest,"activity_type_id","1");
add_param(pRequest,"brand_id","123");
add_param(pRequest,"operator_id","123");
add_param(pRequest,"operator_name","name");
add_param(pRequest,"out_brand_id","123");
add_param(pRequest,"out_shop_id","123");
add_param(pRequest,"request_id","12323123");
add_param(pRequest,"shop_id","123");
pResponse = top_execute(pClient,pRequest,NULL);
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.alsc.crm.marketing.activity.search', {
	'activity_id':'123',
	'activity_status':'ENABLED',
	'activity_type_id':'1',
	'brand_id':'123',
	'operator_id':'123',
	'operator_name':'name',
	'out_brand_id':'123',
	'out_shop_id':'123',
	'request_id':'12323123',
	'shop_id':'123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_crm_marketing_activity_search_response>
    <result>
        <biz_success>true</biz_success>
        <result>
            <activity_infos>
                <activity_info>
                    <activity_customer>无</activity_customer>
                    <activity_desc>无</activity_desc>
                    <activity_id>123</activity_id>
                    <activity_name>活动</activity_name>
                    <activity_rule>[{&quot;voucher&quot;:[{&quot;voucherId&quot;:&quot;12345&quot;,&quot;voucherNum&quot;:&quot;1&quot;}], &quot;gmtStart&quot;:&quot;2018-07-09 00:00:00&quot;,&quot;gmtEnd&quot;:&quot;2018-07-09 00:00:00&quot;,shop:&quot;123,456&quot;,&quot;isDaily&quot;:&quot;Y&quot;}]</activity_rule>
                    <activity_shops>
                        <string>123</string>
                        <string>456</string>
                    </activity_shops>
                    <activity_type_id>1</activity_type_id>
                    <brand_id>1</brand_id>
                    <gmt_end>2018-07-09 00:00:00</gmt_end>
                    <gmt_start>2018-07-09 00:00:00</gmt_start>
                    <out_biz_id>1</out_biz_id>
                    <source_channel>1</source_channel>
                    <status>ENABLED</status>
                </activity_info>
            </activity_infos>
        </result>
        <result_code>1</result_code>
        <result_desc>成功</result_desc>
        <result_view>成功</result_view>
    </result>
</alibaba_alsc_crm_marketing_activity_search_response>

{
    "alibaba_alsc_crm_marketing_activity_search_response":{
        "result":{
            "biz_success":true,
            "result":{
                "activity_infos":{
                    "activity_info":[
                        {
                            "activity_customer":"无",
                            "activity_desc":"无",
                            "activity_id":"123",
                            "activity_name":"活动",
                            "activity_rule":"[{\"voucher\":[{\"voucherId\":\"12345\",\"voucherNum\":\"1\"}], \"gmtStart\":\"2018-07-09 00:00:00\",\"gmtEnd\":\"2018-07-09 00:00:00\",shop:\"123,456\",\"isDaily\":\"Y\"}]",
                            "activity_shops":{
                                "string":[
                                    "123",
                                    "456"
                                ]
                            },
                            "activity_type_id":1,
                            "brand_id":"1",
                            "gmt_end":"2018-07-09 00:00:00",
                            "gmt_start":"2018-07-09 00:00:00",
                            "out_biz_id":"1",
                            "source_channel":"1",
                            "status":"ENABLED"
                        }
                    ]
                }
            },
            "result_code":"1",
            "result_desc":"成功",
            "result_view":"成功"
        }
    }
}

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.alsc.crm.marketing.activity.search (查询营销方案)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ