阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
promotion_facade_open_req	PromotionFacadeOpenReq	可选			获取促销规则请求参数
└ brand_id String 可选 123 品牌ID └ deleted Boolean 可选 false 1 └ gmt_modified String 可选 2019-08-01 20:00:00 最后修改时间 └ out_brand_id String 可选 111 外部品牌ID └ page_no Number 可选 1 第几页,从1开始计数 └ page_size Number 可选 20 每页大小，默认20 └ status_list String [] 可选 ["STATUS_NEW"] STATUS_NEW,STATUS_WORKING,STATUS_SUSPEND,STATUS_END，STATUS_EXPIRED,未投放,执行中,已暂停,已终止,已终止 └ last_id String 可选 123 最后时间 └ promotion_id String 可选 111 促销ID

名称	类型	示例值	描述
result	CommonPageResult		分页返回模型
└ biz_success Boolean true 成功状态 └ current_page Number 1 当前页码 └ has_next_page Boolean true 是否有下一页 └ page_size Number 20 当前每页显示数量 result_list PromotionFacadeOpenInfoList [] 1 促销模版集合 └ available_time String [{"days":"0000101","startTime":"08:00:00","endTime":"11:59:59"}, {"days":"0010101","startTime":"08:00:00","endTime":"11:59:59"}] 可用时段 0000101（星期五，星期天） [{"days":"0000101","startTime":"08:00:00","endTime":"11:59:59"}, {"days":"0010101","startTime":"08:00:00","endTime":"11:59:59"}] └ gmt_create String 2019-08-01 20:00:00 创建时间 └ deleted Boolean false 是否已经删除 └ description String 促销规则描述规则描述 └ end_time String 2019-08-01 20:00:00 促销周期结束时间 └ item_coverage String ALL 适用商品范围值：ALL，PART_AVAILABLE，PART_UNAVAILABLE * 说明：全部商品可用，部分商品可用，部分商品不可用 item_selected_open_info_list ItemSelectedOpenInfoList [] 圈选商品 └ sku_id String 规格id └ dish_id String 菜单id └ sku_out_no String 规则号 └ dish_out_no String 菜品号 └ name String 促销规则名称促销规则名称 └ promotion_id String 促销规则Id 促销规则Id shop_selected_open_info_list ShopSelectedOpenInfoList [] 圈选门店圈选门店 └ shop_id String 门店id └ out_shop_id String 外部门店id └ start_time String 2019-08-01 20:00:00 促销周期开始时间 └ status String INVALID 状态促销活动状态值：UNUSED,USED,NO_INVENTORY,INVALID 说明：未使用,使用中,使用中,使用中 └ suitable_people String MEMBER 促销活动适用人群值：MEMBER，CUSTOMER，ALL * 说明：会员,非会员，不限 └ gmt_modified String 2019-08-01 20:00:00 更新时间 └ type String TYPE_FULL_AMOUNT /** * 满量促销 / TYPE_FULL_AMOUNT, /* * 满额促销 / TYPE_FULL_CAPACITY, /* * 买赠活动 */ TYPE_BOUGHT_GIFT; └ ext_info String {"isVoucherShared":true,"giftGoodsIdList":"[\"123\",\"234\"]","privilegeCondition":{"name":"money","type":"FIXPRICE","value":"3000"},"isAdded":true,"privilegeType":{}} 扩展字段 isAdded:是否叠加,isVoucherShared:是否与优惠券共享,giftGoodsIdList:赠品类似、活动商品,privilegeCondition:权益条件(类型type: 满量 "type":"FULL_AMOUNT","name":"num", "value":"3" 满额 "type":"FULL_CAPACITY", "name":"money","value":"300" 下一份 "type":"NEXT", "name":"num","value":"3" 加价购),privilegeType:权益类型(一口价"type":"FIXPRICE","name":"money","value":"3000" 减免"type":"DECREASE","name":"money","value":"10" 减低价"type":"REDUCE_LOW_PRICE","name":"","value":"" 折扣："type":"DISCOUNT","name":"discount","value":"80" 赠品 "type":"GIFT", "name":"num", "value":"2") └ create_by String 1324 创建人 └ update_by String 52434 更新人 └ update_by_name String 小王更新人名称 └ result_code String 0 结果码 └ result_desc String 处理成功结果描述 └ result_view String 处理成功结果显示 └ total_page Number 10 总页数 └ total_size Number 123 总数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmPromotionListRequest req = new AlibabaAlscCrmPromotionListRequest();
AlibabaAlscCrmPromotionListRequest.PromotionFacadeOpenReq obj1 = new AlibabaAlscCrmPromotionListRequest.PromotionFacadeOpenReq();
obj1.setBrandId("123");
obj1.setDeleted(false);
obj1.setGmtModified("2019-08-01 20:00:00");
obj1.setOutBrandId("111");
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setStatusList(""STATUS_NEW"");
obj1.setLastId("123");
obj1.setPromotionId("111");
req.setPromotionFacadeOpenReq(obj1);
AlibabaAlscCrmPromotionListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmPromotionListRequest req = new AlibabaAlscCrmPromotionListRequest();
AlibabaAlscCrmPromotionListRequest.PromotionFacadeOpenReqDomain obj1 = new AlibabaAlscCrmPromotionListRequest.PromotionFacadeOpenReqDomain();
obj1.BrandId = "123";
obj1.Deleted = false;
obj1.GmtModified = "2019-08-01 20:00:00";
obj1.OutBrandId = "111";
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.StatusList = ""STATUS_NEW"";
obj1.LastId = "123";
obj1.PromotionId = "111";
req.PromotionFacadeOpenReq_ = obj1;
AlibabaAlscCrmPromotionListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmPromotionListRequest;
$promotion_facade_open_req = new PromotionFacadeOpenReq;
$promotion_facade_open_req->brand_id="123";
$promotion_facade_open_req->deleted="false";
$promotion_facade_open_req->gmt_modified="2019-08-01 20:00:00";
$promotion_facade_open_req->out_brand_id="111";
$promotion_facade_open_req->page_no="1";
$promotion_facade_open_req->page_size="20";
$promotion_facade_open_req->status_list="[\"STATUS_NEW\"]";
$promotion_facade_open_req->last_id="123";
$promotion_facade_open_req->promotion_id="111";
$req->setPromotionFacadeOpenReq(json_encode($promotion_facade_open_req));
$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.promotion.list' \
-d 'partner_id=apidoc' \
-d 'sign=423632D1FAD868948F102E2BC8EE7055' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A00%3A41' \
-d 'v=2.0' \
-d 'promotion_facade_open_req=null'

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

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

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

XML示例
JSON示例

<alibaba_alsc_crm_promotion_list_response>
    <result>
        <biz_success>true</biz_success>
        <current_page>1</current_page>
        <has_next_page>true</has_next_page>
        <page_size>20</page_size>
        <result_list>
            <promotion_facade_open_info_list>
                <available_time>[{&quot;days&quot;:&quot;0000101&quot;,&quot;startTime&quot;:&quot;08:00:00&quot;,&quot;endTime&quot;:&quot;11:59:59&quot;},       {&quot;days&quot;:&quot;0010101&quot;,&quot;startTime&quot;:&quot;08:00:00&quot;,&quot;endTime&quot;:&quot;11:59:59&quot;}]</available_time>
                <gmt_create>2019-08-01 20:00:00</gmt_create>
                <deleted>false</deleted>
                <description>促销规则描述</description>
                <end_time>2019-08-01 20:00:00</end_time>
                <item_coverage>ALL</item_coverage>
                <item_selected_open_info_list>
                    <item_selected_open_info_list>
                        <sku_id></sku_id>
                        <dish_id></dish_id>
                        <sku_out_no></sku_out_no>
                        <dish_out_no></dish_out_no>
                    </item_selected_open_info_list>
                </item_selected_open_info_list>
                <name>促销规则名称</name>
                <promotion_id>促销规则Id</promotion_id>
                <shop_selected_open_info_list>
                    <shop_selected_open_info_list>
                        <shop_id></shop_id>
                        <out_shop_id></out_shop_id>
                    </shop_selected_open_info_list>
                </shop_selected_open_info_list>
                <start_time>2019-08-01 20:00:00</start_time>
                <status>INVALID</status>
                <suitable_people>MEMBER</suitable_people>
                <gmt_modified>2019-08-01 20:00:00</gmt_modified>
                <type>TYPE_FULL_AMOUNT</type>
                <ext_info>{&quot;isVoucherShared&quot;:true,&quot;giftGoodsIdList&quot;:&quot;[\&quot;123\&quot;,\&quot;234\&quot;]&quot;,&quot;privilegeCondition&quot;:{&quot;name&quot;:&quot;money&quot;,&quot;type&quot;:&quot;FIXPRICE&quot;,&quot;value&quot;:&quot;3000&quot;},&quot;isAdded&quot;:true,&quot;privilegeType&quot;:{}}</ext_info>
                <create_by>1324</create_by>
                <update_by>52434</update_by>
                <update_by_name>小王</update_by_name>
            </promotion_facade_open_info_list>
        </result_list>
        <result_code>0</result_code>
        <result_desc>处理成功</result_desc>
        <result_view>处理成功</result_view>
        <total_page>10</total_page>
        <total_size>123</total_size>
    </result>
</alibaba_alsc_crm_promotion_list_response>

{
    "alibaba_alsc_crm_promotion_list_response":{
        "result":{
            "biz_success":true,
            "current_page":1,
            "has_next_page":true,
            "page_size":20,
            "result_list":{
                "promotion_facade_open_info_list":[
                    {
                        "available_time":"[{\"days\":\"0000101\",\"startTime\":\"08:00:00\",\"endTime\":\"11:59:59\"},       {\"days\":\"0010101\",\"startTime\":\"08:00:00\",\"endTime\":\"11:59:59\"}]",
                        "gmt_create":"2019-08-01 20:00:00",
                        "deleted":false,
                        "description":"促销规则描述",
                        "end_time":"2019-08-01 20:00:00",
                        "item_coverage":"ALL",
                        "item_selected_open_info_list":{
                            "item_selected_open_info_list":[
                                {
                                    "sku_id":"",
                                    "dish_id":"",
                                    "sku_out_no":"",
                                    "dish_out_no":""
                                }
                            ]
                        },
                        "name":"促销规则名称",
                        "promotion_id":"促销规则Id",
                        "shop_selected_open_info_list":{
                            "shop_selected_open_info_list":[
                                {
                                    "shop_id":"",
                                    "out_shop_id":""
                                }
                            ]
                        },
                        "start_time":"2019-08-01 20:00:00",
                        "status":"INVALID",
                        "suitable_people":"MEMBER",
                        "gmt_modified":"2019-08-01 20:00:00",
                        "type":"TYPE_FULL_AMOUNT",
                        "ext_info":"{\"isVoucherShared\":true,\"giftGoodsIdList\":\"[\\\"123\\\",\\\"234\\\"]\",\"privilegeCondition\":{\"name\":\"money\",\"type\":\"FIXPRICE\",\"value\":\"3000\"},\"isAdded\":true,\"privilegeType\":{}}",
                        "create_by":"1324",
                        "update_by":"52434",
                        "update_by_name":"小王"
                    }
                ]
            },
            "result_code":"0",
            "result_desc":"处理成功",
            "result_view":"处理成功",
            "total_page":10,
            "total_size":123
        }
    }
}

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.promotion.list (获取促销规则列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈