淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_pull_card_template_open_req	PullCardTemplateOpenReq	可选			请求结果
└ brand_id String 可选 31232342 品牌id └ card_type String 可选 MEMBER 卡类型 └ deleted Boolean 可选 false 是否包含逻辑删除,数据下行时必须传递 └ gmt_modified Date 可选 2019-01-01 11:11:11 更新时间,数据下行时必须传递 └ last_max_id String 可选 34734823 上次拉取的业务ID,数据下行时必须传递 └ need_count Boolean 可选 true 是否需要总数,分页查询卡模板时必须传递 └ num Number 可选 10 单次返回数量,数据下行时必须传递 └ out_brand_id String 可选 33959 外部品牌id,与brand_id不可同时为空 └ out_shop_id String 可选 438738239 外部门店id └ page_no Number 可选 3 分页参数,当前页码,分页查询卡模板时必须传递 └ page_size Number 可选 5 分页参数,页面大小,分页查询卡模板时必须传递 └ shop_id String 可选 3456321 门店id └ detail_required Boolean 可选 true 是否查询详情,若需要详情,传true

名称	类型	示例值	描述
result	CommonPageResult		分页返回模型
└ biz_success Boolean false 成功状态 └ current_page Number 22 当前页码（原样传出）,若数据下行时为空 └ page_size Number 50 当前每页显示数量（原样传出）,若数据下行时为空 result_list CardTemplateOpenInfo [] 结果 └ card_template_id String 323423 卡模板ID └ card_type String MEMBER 卡类型 └ create_by String 小王创建者 └ deleted Boolean true 逻辑删除标志 └ expire_type String FIX 有效期类型 └ expire_value String 1 有效期值 ext_info Extinfo 扩展信息 └ empty Boolean Map └ gmt_create Date 2019-01-01 12:12:12 创建时间 └ gmt_modified Date 2019-01-01 12:12:12 修改时间 └ menu_id String 1231231 特价菜单ID └ menu_limit_type String 特价菜限制 └ menu_switch Boolean 特价菜单开关 └ name String 卡模板名称 └ open_gift_switch Boolean 开卡礼包开关 └ opt_plan_id String 2334455 运营计划ID └ phy_card_fee_amount Number 5.0 工本费金额 └ phy_card_fee_back Boolean true 是否可退卡费 └ phy_card_fee_switch Boolean true 工本费开关 └ pre_recharge_amount Number 10 开卡礼包-赠送预储金额 └ recharge_clear Boolean true 开卡礼包-有效期结束是否清零 recharge_rule_open_info RechargeRuleOpenInfo 储值规则信息对象 └ card_type String MEMBER 卡类型 └ create_by String 创建人 └ deduction_order String 1 扣减顺序：0-比例、1-先实储后赠送、2-先增储后实储 └ deleted Boolean false 逻辑删除标志 ext_info Extinfo 扩展信息 └ empty Boolean k-v └ full_gift_switch Boolean true 满赠开关：false-关，true-开，默认关闭 └ gift_type String 1 满赠类型：0-按金额（默认），1-按百分比、 └ gmt_create Date 2019-01-01 12:12:12 创建时间 └ gmt_modified Date 2019-01-01 12:12:12 修改时间 list_recharge_rule_detail_info_list RechargeRuleDetailOpenInfo [] 规则明细列表 └ gift_point Number 20 赠送积分 └ gift_value Number 20 赠送金额 └ real_value Number 20 储值金额 └ remark String 备注信息备注 └ pay_no_pwd_credit Number -1 免密额度:-1表示不限额，单位为分，默认200_00L └ pay_no_pwd_switch Boolean false 免密开关:0-关闭（默认），1-开启 └ rule_id String 34234234 规则id └ rule_name String 买10赠5 规则名称 └ shop_id String 2342352 门店id └ update_by String 修改人 └ out_shop_id String 22344 外部门店ID └ recharge_shop_ids String [] 111,222,333 储值门店列表 └ recharge_switch Boolean true 储值开关 └ sell_price Number 222 售价 └ sell_shop_group_id String 132433 售卡门店分组ID └ sell_shop_ids String [] 111,222,3333 售卡门店列表 └ startexpire_type String 何时开始计算有效期 └ status String 卡模板状态 └ update_by String 更新者 └ use_limit_type String 使用限制 └ use_shop_ids String [] 111,222,333 使用门店列表 vouchers OpenGiftVoucherOpenInfo [] 开卡礼包-优惠券模板列表 └ num Number 5 数量 └ voucher_id String 123123 券模板ID wx_card_ext WxCardOpenExt 微信卡扩展 └ brand_logo String http://xxx.jpg 品牌logoURL └ general_bg_logo String http://xxx.jpg 统一卡面URL └ general_bg_switch Boolean true 是否统一卡面 └ paid_get_switch Boolean true 支付后是否可领取 wx_level_bgs WxLevelBgOpenInfo [] 等级卡面列表 └ bg_url String http://xxx.jpg 卡面URL └ level_id String 1231434 等级ID └ level_name String 钻石等级名称 └ wx_card_switch Boolean true 微信卡开关 └ out_recharge_shop_ids String [] 111,222,333 外部储值门店 └ out_sell_shop_ids String [] 111,222,333 外部出售门店 └ out_use_shop_ids String [] 111,222,333 外部适用门店 └ publish Boolean true 是否已经制卡 └ result_code String 200 结果码 └ result_desc String 成功结果描述 └ result_view String "" 错误结果显示 └ total_size Number 123 总条数,若数据下行时为空

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmCardPagetmpRequest req = new AlibabaAlscCrmCardPagetmpRequest();
AlibabaAlscCrmCardPagetmpRequest.PullCardTemplateOpenReq obj1 = new AlibabaAlscCrmCardPagetmpRequest.PullCardTemplateOpenReq();
obj1.setBrandId("31232342");
obj1.setCardType("MEMBER");
obj1.setDeleted(false);
obj1.setGmtModified(StringUtils.parseDateTime("2019-01-01 11:11:11"));
obj1.setLastMaxId("34734823");
obj1.setNeedCount(true);
obj1.setNum(10L);
obj1.setOutBrandId("33959");
obj1.setOutShopId("438738239");
obj1.setPageNo(3L);
obj1.setPageSize(5L);
obj1.setShopId("3456321");
obj1.setDetailRequired(true);
req.setParamPullCardTemplateOpenReq(obj1);
AlibabaAlscCrmCardPagetmpResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmCardPagetmpRequest req = new AlibabaAlscCrmCardPagetmpRequest();
AlibabaAlscCrmCardPagetmpRequest.PullCardTemplateOpenReqDomain obj1 = new AlibabaAlscCrmCardPagetmpRequest.PullCardTemplateOpenReqDomain();
obj1.BrandId = "31232342";
obj1.CardType = "MEMBER";
obj1.Deleted = false;
obj1.GmtModified = DateTime.Parse(2019-01-01 11:11:11");
obj1.LastMaxId = "34734823";
obj1.NeedCount = true;
obj1.Num = 10L;
obj1.OutBrandId = "33959";
obj1.OutShopId = "438738239";
obj1.PageNo = 3L;
obj1.PageSize = 5L;
obj1.ShopId = "3456321";
obj1.DetailRequired = true;
req.ParamPullCardTemplateOpenReq_ = obj1;
AlibabaAlscCrmCardPagetmpResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmCardPagetmpRequest;
$param_pull_card_template_open_req = new PullCardTemplateOpenReq;
$param_pull_card_template_open_req->brand_id="31232342";
$param_pull_card_template_open_req->card_type="MEMBER";
$param_pull_card_template_open_req->deleted="false";
$param_pull_card_template_open_req->gmt_modified="2019-01-01 11:11:11";
$param_pull_card_template_open_req->last_max_id="34734823";
$param_pull_card_template_open_req->need_count="true";
$param_pull_card_template_open_req->num="10";
$param_pull_card_template_open_req->out_brand_id="33959";
$param_pull_card_template_open_req->out_shop_id="438738239";
$param_pull_card_template_open_req->page_no="3";
$param_pull_card_template_open_req->page_size="5";
$param_pull_card_template_open_req->shop_id="3456321";
$param_pull_card_template_open_req->detail_required="true";
$req->setParamPullCardTemplateOpenReq(json_encode($param_pull_card_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.card.pagetmp' \
-d 'partner_id=apidoc' \
-d 'sign=28018E79A9DEB48507ECBFBA3FF875F2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-11-07+07%3A32%3A31' \
-d 'v=2.0' \
-d 'param_pull_card_template_open_req=null'

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

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

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

XML示例
JSON示例

<alibaba_alsc_crm_card_pagetmp_response>
    <result>
        <biz_success>false</biz_success>
        <current_page>22</current_page>
        <page_size>50</page_size>
        <result_list>
            <card_template_open_info>
                <card_template_id>323423</card_template_id>
                <card_type>MEMBER</card_type>
                <create_by>小王</create_by>
                <deleted>true</deleted>
                <expire_type>FIX</expire_type>
                <expire_value>1</expire_value>
                <ext_info>
                    <empty></empty>
                </ext_info>
                <gmt_create>2019-01-01 12:12:12</gmt_create>
                <gmt_modified>2019-01-01 12:12:12</gmt_modified>
                <menu_id>1231231</menu_id>
                <menu_limit_type></menu_limit_type>
                <menu_switch></menu_switch>
                <name></name>
                <open_gift_switch></open_gift_switch>
                <opt_plan_id>2334455</opt_plan_id>
                <phy_card_fee_amount>5.0</phy_card_fee_amount>
                <phy_card_fee_back>true</phy_card_fee_back>
                <phy_card_fee_switch>true</phy_card_fee_switch>
                <pre_recharge_amount>10</pre_recharge_amount>
                <recharge_clear>true</recharge_clear>
                <recharge_rule_open_info>
                    <card_type>MEMBER</card_type>
                    <create_by></create_by>
                    <deduction_order>1</deduction_order>
                    <deleted>false</deleted>
                    <ext_info>
                        <empty></empty>
                    </ext_info>
                    <full_gift_switch>true</full_gift_switch>
                    <gift_type>1</gift_type>
                    <gmt_create>2019-01-01 12:12:12</gmt_create>
                    <gmt_modified>2019-01-01 12:12:12</gmt_modified>
                    <list_recharge_rule_detail_info_list>
                        <recharge_rule_detail_open_info>
                            <gift_point>20</gift_point>
                            <gift_value>20</gift_value>
                            <real_value>20</real_value>
                            <remark>备注信息</remark>
                        </recharge_rule_detail_open_info>
                    </list_recharge_rule_detail_info_list>
                    <pay_no_pwd_credit>-1</pay_no_pwd_credit>
                    <pay_no_pwd_switch>false</pay_no_pwd_switch>
                    <rule_id>34234234</rule_id>
                    <rule_name>买10赠5</rule_name>
                    <shop_id>2342352</shop_id>
                    <update_by></update_by>
                    <out_shop_id>22344</out_shop_id>
                </recharge_rule_open_info>
                <recharge_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>333</string>
                </recharge_shop_ids>
                <recharge_switch>true</recharge_switch>
                <sell_price>222</sell_price>
                <sell_shop_group_id>132433</sell_shop_group_id>
                <sell_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>3333</string>
                </sell_shop_ids>
                <startexpire_type></startexpire_type>
                <status></status>
                <update_by></update_by>
                <use_limit_type></use_limit_type>
                <use_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>333</string>
                </use_shop_ids>
                <vouchers>
                    <open_gift_voucher_open_info>
                        <num>5</num>
                        <voucher_id>123123</voucher_id>
                    </open_gift_voucher_open_info>
                </vouchers>
                <wx_card_ext>
                    <brand_logo>http://xxx.jpg</brand_logo>
                    <general_bg_logo>http://xxx.jpg</general_bg_logo>
                    <general_bg_switch>true</general_bg_switch>
                    <paid_get_switch>true</paid_get_switch>
                    <wx_level_bgs>
                        <wx_level_bg_open_info>
                            <bg_url>http://xxx.jpg</bg_url>
                            <level_id>1231434</level_id>
                            <level_name>钻石</level_name>
                        </wx_level_bg_open_info>
                    </wx_level_bgs>
                </wx_card_ext>
                <wx_card_switch>true</wx_card_switch>
                <out_recharge_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>333</string>
                </out_recharge_shop_ids>
                <out_sell_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>333</string>
                </out_sell_shop_ids>
                <out_use_shop_ids>
                    <string>111</string>
                    <string>222</string>
                    <string>333</string>
                </out_use_shop_ids>
                <publish>true</publish>
            </card_template_open_info>
        </result_list>
        <result_code>200</result_code>
        <result_desc>成功</result_desc>
        <result_view>&quot;&quot;</result_view>
        <total_size>123</total_size>
    </result>
</alibaba_alsc_crm_card_pagetmp_response>

{
    "alibaba_alsc_crm_card_pagetmp_response":{
        "result":{
            "biz_success":false,
            "current_page":22,
            "page_size":50,
            "result_list":{
                "card_template_open_info":[
                    {
                        "card_template_id":"323423",
                        "card_type":"MEMBER",
                        "create_by":"小王",
                        "deleted":true,
                        "expire_type":"FIX",
                        "expire_value":"1",
                        "ext_info":{
                            "empty":
                        },
                        "gmt_create":"2019-01-01 12:12:12",
                        "gmt_modified":"2019-01-01 12:12:12",
                        "menu_id":"1231231",
                        "menu_limit_type":"",
                        "menu_switch":,
                        "name":"",
                        "open_gift_switch":,
                        "opt_plan_id":"2334455",
                        "phy_card_fee_amount":5.0,
                        "phy_card_fee_back":true,
                        "phy_card_fee_switch":true,
                        "pre_recharge_amount":10,
                        "recharge_clear":true,
                        "recharge_rule_open_info":{
                            "card_type":"MEMBER",
                            "create_by":"",
                            "deduction_order":"1",
                            "deleted":false,
                            "ext_info":{
                                "empty":
                            },
                            "full_gift_switch":true,
                            "gift_type":"1",
                            "gmt_create":"2019-01-01 12:12:12",
                            "gmt_modified":"2019-01-01 12:12:12",
                            "list_recharge_rule_detail_info_list":{
                                "recharge_rule_detail_open_info":[
                                    {
                                        "gift_point":20,
                                        "gift_value":20,
                                        "real_value":20,
                                        "remark":"备注信息"
                                    }
                                ]
                            },
                            "pay_no_pwd_credit":-1,
                            "pay_no_pwd_switch":false,
                            "rule_id":"34234234",
                            "rule_name":"买10赠5",
                            "shop_id":"2342352",
                            "update_by":"",
                            "out_shop_id":"22344"
                        },
                        "recharge_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "333"
                            ]
                        },
                        "recharge_switch":true,
                        "sell_price":222,
                        "sell_shop_group_id":"132433",
                        "sell_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "3333"
                            ]
                        },
                        "startexpire_type":"",
                        "status":"",
                        "update_by":"",
                        "use_limit_type":"",
                        "use_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "333"
                            ]
                        },
                        "vouchers":{
                            "open_gift_voucher_open_info":[
                                {
                                    "num":5,
                                    "voucher_id":"123123"
                                }
                            ]
                        },
                        "wx_card_ext":{
                            "brand_logo":"http:\/\/xxx.jpg",
                            "general_bg_logo":"http:\/\/xxx.jpg",
                            "general_bg_switch":true,
                            "paid_get_switch":true,
                            "wx_level_bgs":{
                                "wx_level_bg_open_info":[
                                    {
                                        "bg_url":"http:\/\/xxx.jpg",
                                        "level_id":"1231434",
                                        "level_name":"钻石"
                                    }
                                ]
                            }
                        },
                        "wx_card_switch":true,
                        "out_recharge_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "333"
                            ]
                        },
                        "out_sell_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "333"
                            ]
                        },
                        "out_use_shop_ids":{
                            "string":[
                                "111",
                                "222",
                                "333"
                            ]
                        },
                        "publish":true
                    }
                ]
            },
            "result_code":"200",
            "result_desc":"成功",
            "result_view":"\"\"",
            "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.card.pagetmp (查询卡模板列表(支持数据下行))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ