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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
customer_voucher_full_open_req	CustomerVoucherFullOpenReq	可选			获取顾客优惠券列表
└ brand_id String 可选 123 品牌ID └ customer_id String 可选 3333 顾客ID └ out_brand_id String 可选 111 外部品牌ID └ out_shop_id String 可选 111222 外部门店ID └ page_no Number 可选 1 第几页,从1开始计数 └ page_size Number 可选 20 每页大小，默认20 └ shop_id String 可选 222 SaaS门店ID └ voucher_status_list String [] 可选 NORMAL 优惠券状态 NORMAL，DELETED，ISUSED

名称	类型	示例值	描述
result	CommonPageResult	1	分页返回模型
└ biz_success Boolean true 成功状态 └ current_page Number 1 当前页码 └ has_next_page Boolean true 是否有下一页 └ page_size Number 20 当前每页显示数量 result_list CustomerVoucherFullOpenInfo [] Object 1 └ amount Number 0 优惠券金额 └ customer_id Number 123456 顾客ID └ end_time String 2019-08-08 05:33:20 结束时间 └ gmt_created String 2019-08-07 18:22:52 创建时间 └ start_fee Number 1 满足金额阀值 └ start_time String 2019-08-07 18:20:00 开始时间 └ status String NORMAL 优惠券状态 └ title String 优惠券名称优惠券名称 └ voucher_id String 123 优惠券ID └ discount_rate String 8.88 优惠率 └ voucher_template_id String 123 优惠券模版ID └ gift_point Number 100 券实例有效点数 └ 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);
AlibabaAlscCrmCustomerVoucherListRequest req = new AlibabaAlscCrmCustomerVoucherListRequest();
AlibabaAlscCrmCustomerVoucherListRequest.CustomerVoucherFullOpenReq obj1 = new AlibabaAlscCrmCustomerVoucherListRequest.CustomerVoucherFullOpenReq();
obj1.setBrandId("123");
obj1.setCustomerId("3333");
obj1.setOutBrandId("111");
obj1.setOutShopId("111222");
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setShopId("222");
obj1.setVoucherStatusList("NORMAL");
req.setCustomerVoucherFullOpenReq(obj1);
AlibabaAlscCrmCustomerVoucherListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmCustomerVoucherListRequest req = new AlibabaAlscCrmCustomerVoucherListRequest();
AlibabaAlscCrmCustomerVoucherListRequest.CustomerVoucherFullOpenReqDomain obj1 = new AlibabaAlscCrmCustomerVoucherListRequest.CustomerVoucherFullOpenReqDomain();
obj1.BrandId = "123";
obj1.CustomerId = "3333";
obj1.OutBrandId = "111";
obj1.OutShopId = "111222";
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.ShopId = "222";
obj1.VoucherStatusList = "NORMAL";
req.CustomerVoucherFullOpenReq_ = obj1;
AlibabaAlscCrmCustomerVoucherListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmCustomerVoucherListRequest;
$customer_voucher_full_open_req = new CustomerVoucherFullOpenReq;
$customer_voucher_full_open_req->brand_id="123";
$customer_voucher_full_open_req->customer_id="3333";
$customer_voucher_full_open_req->out_brand_id="111";
$customer_voucher_full_open_req->out_shop_id="111222";
$customer_voucher_full_open_req->page_no="1";
$customer_voucher_full_open_req->page_size="20";
$customer_voucher_full_open_req->shop_id="222";
$customer_voucher_full_open_req->voucher_status_list="NORMAL";
$req->setCustomerVoucherFullOpenReq(json_encode($customer_voucher_full_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.customer.voucher.list' \
-d 'partner_id=apidoc' \
-d 'sign=C06DA7AC09FADC548D9225893473405D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A20%3A54' \
-d 'v=2.0' \
-d 'customer_voucher_full_open_req=null'

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

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

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

XML示例
JSON示例

<alibaba_alsc_crm_customer_voucher_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>
            <customer_voucher_full_open_info>
                <amount>0</amount>
                <customer_id>123456</customer_id>
                <end_time>2019-08-08 05:33:20</end_time>
                <gmt_created>2019-08-07 18:22:52</gmt_created>
                <start_fee>1</start_fee>
                <start_time>2019-08-07 18:20:00</start_time>
                <status>NORMAL</status>
                <title>优惠券名称</title>
                <voucher_id>123</voucher_id>
                <discount_rate>8.88</discount_rate>
                <voucher_template_id>123</voucher_template_id>
                <gift_point>100</gift_point>
            </customer_voucher_full_open_info>
        </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_customer_voucher_list_response>

{
    "alibaba_alsc_crm_customer_voucher_list_response":{
        "result":{
            "biz_success":true,
            "current_page":1,
            "has_next_page":true,
            "page_size":20,
            "result_list":{
                "customer_voucher_full_open_info":[
                    {
                        "amount":0,
                        "customer_id":123456,
                        "end_time":"2019-08-08 05:33:20",
                        "gmt_created":"2019-08-07 18:22:52",
                        "start_fee":1,
                        "start_time":"2019-08-07 18:20:00",
                        "status":"NORMAL",
                        "title":"优惠券名称",
                        "voucher_id":"123",
                        "discount_rate":"8.88",
                        "voucher_template_id":"123",
                        "gift_point":100
                    }
                ]
            },
            "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.customer.voucher.list (获取顾客优惠券列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈