淘宝开放平台 - 文档中心

请求地址：

环境	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_query_card_open_req	QueryCardOpenReq	可选			请求对象
└ account_required Boolean 可选 true 查询关联资产账户 └ brand_id String 可选 452346356 品牌id └ card_id String 可选 43523452 卡实例id └ out_brand_id String 可选 33959 外部品牌id和品牌id必传1 └ out_shop_id String 可选 648934878 外部门店id └ physical_card_id String 可选 45325 物理卡号 └ physical_card_required Boolean 可选 true 查询关联物理卡 └ shop_id String 可选 44554 saas门店id

名称	类型	示例值	描述
result	CommonResult		接口结果
└ biz_success Boolean 成功状态 result CardOpenInfo 结果 accounts AccountOpenInfo [] 资产账户列表 └ account_id String 4352345 账户ID └ account_type String 账户类型（暂时不用） └ balance Number 3242 储值余额 └ create_by String XXX 创建人 └ currency String RMB 币种 └ deleted Boolean false 逻辑删除标志 └ gift Number 4323 增储 └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 └ pre Number 32 预储 └ real Number 20 实储 └ status String 账户状态（暂时不用） └ total_gift Number 22 累计增储 └ total_pre Number 22 累计预储 └ total_real Number 444 累计实储 └ update_by String XX 修改人 └ opt_plan_id String 232 运营计划ID └ active_operator_id String 3452345 激活操作人ID └ active_operator_name String XXX 激活操作人名 └ active_shop_id String 43534 激活门店ID └ active_time Date 2019-01-01 11:11:11 激活时间 └ buy Boolean true 是否主动购买（是则赠送开卡礼包） └ card_id String 4534523 卡实例ID └ card_template_id String 2342512 卡模板ID └ card_type String MEMBER 卡类型 └ create_by String XXX 创建人 └ customer_id String 34235 顾客id └ deleted Boolean false 逻辑删除 └ expire_end Date 2019-01-01 11:11:11 有效期结束时间 └ expire_start Date 2019-01-01 11:11:11 有效期起始时间 └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 └ open_operator_id String 252345 开卡操作人ID └ open_operator_name String 小王开卡操作人名 └ open_shop_id String 45622 开卡门店ID └ open_shop_name String XXX小店开卡门店名称 └ open_time Date 2019-01-01 11:11:11 开卡时间 └ operator_id String 564321 操作员id └ opt_plan_id String 535421 运营计划ID physical_cards PhysicalCardOpenInfo [] 关联的物理卡列表 └ bind_operator_id String 45321 绑定操作人ID └ bind_shop_id String 346325 绑定门店ID └ bind_time Date 2019-01-01 11:11:11 绑定时间 └ card_id String 35246315 卡实例ID └ card_template_id String 35242 卡模板ID └ card_type String MEMBER 卡类型 └ create_by String XXX 创建人 └ deleted Boolean false 逻辑删除 └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 └ operator_id String 456352 操作员id └ physical_card_id String 345234523 物理卡号 └ plan_id String 345234 会员计划id └ publish_id String 43352345 发行记录ID └ status String WAIT_MAKE WAIT_MAKE("WAIT_MAKE", "未制卡"), /** * 未出售 / WAIT_SELL("WAIT_SELL", "未出售"), /* * 已出售 / SOLD("SOLD", "已出售"), /* * 已作废 */ INVALID("INVALID", "已作废"); └ update_by String XXX 修改人 └ plan_id String 3542451 会员计划ID └ status String SOLD SOLD("SOLD", "已出售"), ACTIVED("ACTIVED", "已激活"), STOP("STOP", "已停用"), INVALID("INVALID", "已作废"), EXPIRED("EXPIRED", "已过期"), REFUND("REFUND", "已退卡") └ update_by String XXX 修改人 └ result_code String 200 结果码 └ result_desc String 成功结果描述 └ result_view String "" 错误结果显示

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmCardQryRequest req = new AlibabaAlscCrmCardQryRequest();
AlibabaAlscCrmCardQryRequest.QueryCardOpenReq obj1 = new AlibabaAlscCrmCardQryRequest.QueryCardOpenReq();
obj1.setAccountRequired(true);
obj1.setBrandId("452346356");
obj1.setCardId("43523452");
obj1.setOutBrandId("33959");
obj1.setOutShopId("648934878");
obj1.setPhysicalCardId("45325");
obj1.setPhysicalCardRequired(true);
obj1.setShopId("44554");
req.setParamQueryCardOpenReq(obj1);
AlibabaAlscCrmCardQryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmCardQryRequest req = new AlibabaAlscCrmCardQryRequest();
AlibabaAlscCrmCardQryRequest.QueryCardOpenReqDomain obj1 = new AlibabaAlscCrmCardQryRequest.QueryCardOpenReqDomain();
obj1.AccountRequired = true;
obj1.BrandId = "452346356";
obj1.CardId = "43523452";
obj1.OutBrandId = "33959";
obj1.OutShopId = "648934878";
obj1.PhysicalCardId = "45325";
obj1.PhysicalCardRequired = true;
obj1.ShopId = "44554";
req.ParamQueryCardOpenReq_ = obj1;
AlibabaAlscCrmCardQryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmCardQryRequest;
$param_query_card_open_req = new QueryCardOpenReq;
$param_query_card_open_req->account_required="true";
$param_query_card_open_req->brand_id="452346356";
$param_query_card_open_req->card_id="43523452";
$param_query_card_open_req->out_brand_id="33959";
$param_query_card_open_req->out_shop_id="648934878";
$param_query_card_open_req->physical_card_id="45325";
$param_query_card_open_req->physical_card_required="true";
$param_query_card_open_req->shop_id="44554";
$req->setParamQueryCardOpenReq(json_encode($param_query_card_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.qry' \
-d 'partner_id=apidoc' \
-d 'sign=387E02FEC9CD887036E64F20629165C3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-11-07+07%3A30%3A07' \
-d 'v=2.0' \
-d 'param_query_card_open_req=null'

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

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

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

XML示例
JSON示例

<alibaba_alsc_crm_card_qry_response>
    <result>
        <biz_success></biz_success>
        <result>
            <accounts>
                <account_open_info>
                    <account_id>4352345</account_id>
                    <account_type></account_type>
                    <balance>3242</balance>
                    <create_by>XXX</create_by>
                    <currency>RMB</currency>
                    <deleted>false</deleted>
                    <gift>4323</gift>
                    <gmt_create>2019-01-01 11:11:11</gmt_create>
                    <gmt_modified>2019-01-01 11:11:11</gmt_modified>
                    <pre>32</pre>
                    <real>20</real>
                    <status></status>
                    <total_gift>22</total_gift>
                    <total_pre>22</total_pre>
                    <total_real>444</total_real>
                    <update_by>XX</update_by>
                    <opt_plan_id>232</opt_plan_id>
                </account_open_info>
            </accounts>
            <active_operator_id>3452345</active_operator_id>
            <active_operator_name>XXX</active_operator_name>
            <active_shop_id>43534</active_shop_id>
            <active_time>2019-01-01 11:11:11</active_time>
            <buy>true</buy>
            <card_id>4534523</card_id>
            <card_template_id>2342512</card_template_id>
            <card_type>MEMBER</card_type>
            <create_by>XXX</create_by>
            <customer_id>34235</customer_id>
            <deleted>false</deleted>
            <expire_end>2019-01-01 11:11:11</expire_end>
            <expire_start>2019-01-01 11:11:11</expire_start>
            <gmt_create>2019-01-01 11:11:11</gmt_create>
            <gmt_modified>2019-01-01 11:11:11</gmt_modified>
            <open_operator_id>252345</open_operator_id>
            <open_operator_name>小王</open_operator_name>
            <open_shop_id>45622</open_shop_id>
            <open_shop_name>XXX小店</open_shop_name>
            <open_time>2019-01-01 11:11:11</open_time>
            <operator_id>564321</operator_id>
            <opt_plan_id>535421</opt_plan_id>
            <physical_cards>
                <physical_card_open_info>
                    <bind_operator_id>45321</bind_operator_id>
                    <bind_shop_id>346325</bind_shop_id>
                    <bind_time>2019-01-01 11:11:11</bind_time>
                    <card_id>35246315</card_id>
                    <card_template_id>35242</card_template_id>
                    <card_type>MEMBER</card_type>
                    <create_by>XXX</create_by>
                    <deleted>false</deleted>
                    <gmt_create>2019-01-01 11:11:11</gmt_create>
                    <gmt_modified>2019-01-01 11:11:11</gmt_modified>
                    <operator_id>456352</operator_id>
                    <physical_card_id>345234523</physical_card_id>
                    <plan_id>345234</plan_id>
                    <publish_id>43352345</publish_id>
                    <status>WAIT_MAKE</status>
                    <update_by>XXX</update_by>
                </physical_card_open_info>
            </physical_cards>
            <plan_id>3542451</plan_id>
            <status>SOLD</status>
            <update_by>XXX</update_by>
        </result>
        <result_code>200</result_code>
        <result_desc>成功</result_desc>
        <result_view>&quot;&quot;</result_view>
    </result>
</alibaba_alsc_crm_card_qry_response>

{
    "alibaba_alsc_crm_card_qry_response":{
        "result":{
            "biz_success":,
            "result":{
                "accounts":{
                    "account_open_info":[
                        {
                            "account_id":"4352345",
                            "account_type":"",
                            "balance":3242,
                            "create_by":"XXX",
                            "currency":"RMB",
                            "deleted":false,
                            "gift":4323,
                            "gmt_create":"2019-01-01 11:11:11",
                            "gmt_modified":"2019-01-01 11:11:11",
                            "pre":32,
                            "real":20,
                            "status":"",
                            "total_gift":22,
                            "total_pre":22,
                            "total_real":444,
                            "update_by":"XX",
                            "opt_plan_id":"232"
                        }
                    ]
                },
                "active_operator_id":"3452345",
                "active_operator_name":"XXX",
                "active_shop_id":"43534",
                "active_time":"2019-01-01 11:11:11",
                "buy":true,
                "card_id":"4534523",
                "card_template_id":"2342512",
                "card_type":"MEMBER",
                "create_by":"XXX",
                "customer_id":"34235",
                "deleted":false,
                "expire_end":"2019-01-01 11:11:11",
                "expire_start":"2019-01-01 11:11:11",
                "gmt_create":"2019-01-01 11:11:11",
                "gmt_modified":"2019-01-01 11:11:11",
                "open_operator_id":"252345",
                "open_operator_name":"小王",
                "open_shop_id":"45622",
                "open_shop_name":"XXX小店",
                "open_time":"2019-01-01 11:11:11",
                "operator_id":"564321",
                "opt_plan_id":"535421",
                "physical_cards":{
                    "physical_card_open_info":[
                        {
                            "bind_operator_id":"45321",
                            "bind_shop_id":"346325",
                            "bind_time":"2019-01-01 11:11:11",
                            "card_id":"35246315",
                            "card_template_id":"35242",
                            "card_type":"MEMBER",
                            "create_by":"XXX",
                            "deleted":false,
                            "gmt_create":"2019-01-01 11:11:11",
                            "gmt_modified":"2019-01-01 11:11:11",
                            "operator_id":"456352",
                            "physical_card_id":"345234523",
                            "plan_id":"345234",
                            "publish_id":"43352345",
                            "status":"WAIT_MAKE",
                            "update_by":"XXX"
                        }
                    ]
                },
                "plan_id":"3542451",
                "status":"SOLD",
                "update_by":"XXX"
            },
            "result_code":"200",
            "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.card.qry (查询卡实例)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ