淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
voucher_template_open_req	VoucherTemplateOpenReq	可选			获取优惠模版规则请求参数
└ brand_id String 可选 123 品牌ID └ deleted Boolean 可选 false 已删除数据 └ gmt_modified String 可选 2019-08-01 20:00:00 最后修改时间 └ out_brand_id String 可选 111 外部品牌ID └ out_shop_id String 可选 111222 外部门店ID └ page_no Number 可选 1 第几页,从1开始计数 └ page_size Number 可选 20 第几页,从1开始计数 └ shop_id String 可选 222 SaaS门店ID └ status_list String [] 可选 ["USED"] UNUSED,USED,NO_INVENTORY,INVALID, 未使用,使用中,无库存,已失效 └ last_id String 可选 123 最后ID └ voucher_template_id String 可选 123 模版ID

名称	类型	示例值	描述
result	CommonPageResult		分页返回模型
└ biz_success Boolean true 成功状态 └ current_page Number 1 当前页码 └ has_next_page Boolean true 是否有下一页 └ page_size Number 20 当前每页显示数量 result_list VoucherTemplateOpenInfo [] 1 获取优惠券模版列表 └ available_time String {\"type\":0,\"settings\":[{\"dayStartTime\":\"00:00\",\"dayEndTime\":\"23:59\",\"week\":[]}]} {\"type\":0,\"settings\":[{\"dayStartTime\":\"00:00\",\"dayEndTime\":\"23:59\",\"week\":[]}]} type:0不限制，1限制 dayStartTime:开始时间 dayEndTime:结束时间 week:1,2,3,4,5,6,7 └ description String 使用说明使用说明 └ end_time String 2019-08-01 20:00:00 绝对日期中的结束时间 └ ext_info String 1 扩展字段 └ inventory Number 100 库存数量 └ item_coverage String ALL 适用商品范围值：ALL，PART_AVAILABLE，PART_UNAVAILABLE * 说明：全部商品可用，部分商品可用，部分商品不可用 item_selected_open_info_list ItemSelectedOpenInfo [] 1 1 └ sku_id String 123 规则ID └ dish_id String 123 菜品ID └ dish_out_no String 123 外部菜品ID └ sku_out_no String 123 外部规则ID └ min_charge Number 88 最低消费 └ name String 券模板名称券模板名称 shop_selected_open_info_list ShopSelectedOpenInfo [] 1 1 └ shop_id String 123 门店ID └ out_shop_id String 123 外部门店ID └ start_time String 2019-08-01 20:00:00 绝对日期中的开始时间 └ status String UNUSED // 未使用 UNUSED, // 使用中 USED, // 无库存 NO_INVENTORY, // 已失效 INVALID, ; └ today_available Boolean false 相对日期中的当天是否有效 └ type String GIFT 券模板类型 * 值：GIFT、DISCOUNT、CASH * 说明：礼品券、礼品券、礼品券 └ use_condition String "[\"TAKE_OUT\",\"DINE_IN\"]" 使用场景DINE_IN 堂食,TAKE_OUT外卖 └ user_limit Number 3 每人限领 └ valid_date_type String FIXED 券有效期类型值： FIXED、RELATIVE * 说明：绝对时间，相对于用户领券时间 └ valid_day_count Number 30 相对日期中的有效天数 └ voucher_template_id String 123 模版ID └ deleted Boolean true 是否删除 └ denomination String 13 面额 └ update_by String 3243 更新人 └ create_by String 43 创建人 └ gmt_create Date 2019-08-01 20:00:00 创建时间 └ gmt_modified Date 2019-08-01 20:00:00 更新时间 └ 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);
AlibabaAlscCrmVoucherTemplateListRequest req = new AlibabaAlscCrmVoucherTemplateListRequest();
AlibabaAlscCrmVoucherTemplateListRequest.VoucherTemplateOpenReq obj1 = new AlibabaAlscCrmVoucherTemplateListRequest.VoucherTemplateOpenReq();
obj1.setBrandId("123");
obj1.setDeleted(false);
obj1.setGmtModified("2019-08-01 20:00:00");
obj1.setOutBrandId("111");
obj1.setOutShopId("111222");
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setShopId("222");
obj1.setStatusList(""USED"");
obj1.setLastId("123");
obj1.setVoucherTemplateId("123");
req.setVoucherTemplateOpenReq(obj1);
AlibabaAlscCrmVoucherTemplateListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmVoucherTemplateListRequest req = new AlibabaAlscCrmVoucherTemplateListRequest();
AlibabaAlscCrmVoucherTemplateListRequest.VoucherTemplateOpenReqDomain obj1 = new AlibabaAlscCrmVoucherTemplateListRequest.VoucherTemplateOpenReqDomain();
obj1.BrandId = "123";
obj1.Deleted = false;
obj1.GmtModified = "2019-08-01 20:00:00";
obj1.OutBrandId = "111";
obj1.OutShopId = "111222";
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.ShopId = "222";
obj1.StatusList = ""USED"";
obj1.LastId = "123";
obj1.VoucherTemplateId = "123";
req.VoucherTemplateOpenReq_ = obj1;
AlibabaAlscCrmVoucherTemplateListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmVoucherTemplateListRequest;
$voucher_template_open_req = new VoucherTemplateOpenReq;
$voucher_template_open_req->brand_id="123";
$voucher_template_open_req->deleted="false";
$voucher_template_open_req->gmt_modified="2019-08-01 20:00:00";
$voucher_template_open_req->out_brand_id="111";
$voucher_template_open_req->out_shop_id="111222";
$voucher_template_open_req->page_no="1";
$voucher_template_open_req->page_size="20";
$voucher_template_open_req->shop_id="222";
$voucher_template_open_req->status_list="[\"USED\"]";
$voucher_template_open_req->last_id="123";
$voucher_template_open_req->voucher_template_id="123";
$req->setVoucherTemplateOpenReq(json_encode($voucher_template_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.voucher.template.list' \
-d 'partner_id=apidoc' \
-d 'sign=7AFAF850F536E084BBF6CF2F12BFEBBF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A23%3A35' \
-d 'v=2.0' \
-d 'voucher_template_open_req=null'

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

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

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

XML示例
JSON示例

<alibaba_alsc_crm_voucher_template_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>
            <voucher_template_open_info>
                <available_time>{\&quot;type\&quot;:0,\&quot;settings\&quot;:[{\&quot;dayStartTime\&quot;:\&quot;00:00\&quot;,\&quot;dayEndTime\&quot;:\&quot;23:59\&quot;,\&quot;week\&quot;:[]}]}</available_time>
                <description>使用说明</description>
                <end_time>2019-08-01 20:00:00</end_time>
                <ext_info>1</ext_info>
                <inventory>100</inventory>
                <item_coverage>ALL</item_coverage>
                <item_selected_open_info_list>
                    <item_selected_open_info>
                        <sku_id>123</sku_id>
                        <dish_id>123</dish_id>
                        <dish_out_no>123</dish_out_no>
                        <sku_out_no>123</sku_out_no>
                    </item_selected_open_info>
                </item_selected_open_info_list>
                <min_charge>88</min_charge>
                <name>券模板名称</name>
                <shop_selected_open_info_list>
                    <shop_selected_open_info>
                        <shop_id>123</shop_id>
                        <out_shop_id>123</out_shop_id>
                    </shop_selected_open_info>
                </shop_selected_open_info_list>
                <start_time>2019-08-01 20:00:00</start_time>
                <status>UNUSED</status>
                <today_available>false</today_available>
                <type>GIFT</type>
                <use_condition>&quot;[\&quot;TAKE_OUT\&quot;,\&quot;DINE_IN\&quot;]&quot;</use_condition>
                <user_limit>3</user_limit>
                <valid_date_type>FIXED</valid_date_type>
                <valid_day_count>30</valid_day_count>
                <voucher_template_id>123</voucher_template_id>
                <deleted>true</deleted>
                <denomination>13</denomination>
                <update_by>3243</update_by>
                <create_by>43</create_by>
                <gmt_create>2019-08-01 20:00:00</gmt_create>
                <gmt_modified>2019-08-01 20:00:00</gmt_modified>
            </voucher_template_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_voucher_template_list_response>

{
    "alibaba_alsc_crm_voucher_template_list_response":{
        "result":{
            "biz_success":true,
            "current_page":1,
            "has_next_page":true,
            "page_size":20,
            "result_list":{
                "voucher_template_open_info":[
                    {
                        "available_time":"{\\\"type\\\":0,\\\"settings\\\":[{\\\"dayStartTime\\\":\\\"00:00\\\",\\\"dayEndTime\\\":\\\"23:59\\\",\\\"week\\\":[]}]}",
                        "description":"使用说明",
                        "end_time":"2019-08-01 20:00:00",
                        "ext_info":"1",
                        "inventory":100,
                        "item_coverage":"ALL",
                        "item_selected_open_info_list":{
                            "item_selected_open_info":[
                                {
                                    "sku_id":"123",
                                    "dish_id":"123",
                                    "dish_out_no":"123",
                                    "sku_out_no":"123"
                                }
                            ]
                        },
                        "min_charge":88,
                        "name":"券模板名称",
                        "shop_selected_open_info_list":{
                            "shop_selected_open_info":[
                                {
                                    "shop_id":"123",
                                    "out_shop_id":"123"
                                }
                            ]
                        },
                        "start_time":"2019-08-01 20:00:00",
                        "status":"UNUSED",
                        "today_available":false,
                        "type":"GIFT",
                        "use_condition":"\"[\\\"TAKE_OUT\\\",\\\"DINE_IN\\\"]\"",
                        "user_limit":3,
                        "valid_date_type":"FIXED",
                        "valid_day_count":30,
                        "voucher_template_id":"123",
                        "deleted":true,
                        "denomination":"13",
                        "update_by":"3243",
                        "create_by":"43",
                        "gmt_create":"2019-08-01 20:00:00",
                        "gmt_modified":"2019-08-01 20:00:00"
                    }
                ]
            },
            "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.voucher.template.list (获取优惠券模版列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ