文档中心 > API类目 > 本地生活API

alibaba.alsc.crm.card.searchcard (搜索卡实例列表(支持号段查询))

搜索卡实例列表(支持号段查询)

公共参数

请求地址：

环境	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_search_card_open_req	SearchCardOpenReq	可选			请求对象
└ brand_id String 可选 33959 品牌id └ card_template_ids String [] 可选 111,222,333 卡模板ID └ card_type String 可选 MEMBER 卡类型 └ need_count Boolean 可选 true 是否需要总数 └ no String 可选 4352124 号码（手机号/卡实例ID/物理卡号） └ open_card_shop_ids String [] 可选 111,222,333 开卡门店ID └ open_time_end String 可选 2019-11-11 开卡时间终止 └ open_time_start String 可选 2019-11-11 开卡时间开始 └ out_brand_id String 可选 33959 外部品牌id,brandId与out_brand_id不可同时为空 └ out_shop_id String 可选 123424 外部门店ID,shop_id和out_shop_id不可同时为空 └ page_no Number 可选 1 第几页,从1开始计数 └ page_size Number 可选 20 每页大小，默认20 └ shop_id String 可选 324532 门店id └ statuses String [] 可选 SOLD,ACTIVED,STOP 卡实例状态

响应参数

名称	类型	示例值	描述
result	CommonPageResult		分页返回模型
└ biz_success Boolean true 成功状态 └ current_page Number 123 当前页码（原样传出） └ has_next_page Boolean true 是否有下一页 └ page_size Number 123 每页几条 result_list CardOpenInfo [] 结果数据 accounts AccountOpenInfo [] 资产账户列表 └ account_id String 1232433 账户ID └ account_type String 账户类型（暂时不用） └ balance Number 22 储值余额 └ create_by String 小李创建人 └ currency String RMB 币种 └ deleted Boolean false 逻辑删除 ext_info Extinfo 扩展信息 └ empty Boolean Map └ gift Number 20 增储 └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 └ pre Number 20 预储 └ real Number 100 实储 └ status String 账户状态（暂时不用） └ total_gift Number 200 累计增储 └ total_pre Number 20 累计预储 └ total_real Number 200 累计实储 └ update_by String 小王修改人 └ active_operator_id String 435422134 激活操作人ID └ active_operator_name String 小李激活操作人名称 └ active_shop_id String 3243432 激活门店ID └ active_time Date 2019-01-01 11:11:11 激活时间 └ buy Boolean true 是否主动购买（是则赠送开卡礼包） └ card_id String 32456432 卡实例ID └ card_template_id String 324532 卡模板ID └ card_type String MEMBER 卡类型 └ create_by String 小刘创建人 └ customer_id String 54363231 顾客id └ deleted Boolean false 逻辑删除 └ expire_end Date 有效期结束时间 └ expire_start Date 有效期开始时间 ext_info Extinfo 扩展信息 └ empty Boolean Map └ gmt_create Date 创建时间 └ gmt_modified Date 修改时间 └ open_operator_id String 23452134 开卡操作人id └ open_operator_name String 小李子开卡操作人名称 └ open_shop_id String 32453 开卡门店ID └ open_shop_name String XXX门店开卡门店名称 └ open_time Date 2019-01-01 11:11:11 开卡时间 └ operator_id String 342352 操作人ID └ opt_plan_id String 2342 运营计划ID physical_cards PhysicalCardOpenInfo [] 关联的物理卡列表 └ bind_operator_id String 43532 绑定操作人ID └ bind_shop_id String 3453234 绑定门店ID └ bind_time Date 2019-01-01 11:11:11 绑定时间 └ card_id String 34321342 卡实例ID └ card_template_id String 234213 卡模板ID └ card_type String MEMBER 卡类型 └ create_by String 小刘创建人 └ deleted Boolean false 逻辑删除 ext_info Extinfo 扩展信息 └ empty Boolean Map └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 └ operator_id String 2345214 操作人ID └ physical_card_id String 324434232 物理卡号 └ plan_id String 32435324 会员计划ID └ publish_id String 43532 发行记录ID └ status String WAIT_MAKE 物理卡状态 └ update_by String 小李子修改人 └ plan_id String 3213232 会员计划ID └ status String WAIT_MAKE 物理卡状态 └ update_by String XXX 修改人 └ result_code String 200 结果码 └ 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);
AlibabaAlscCrmCardSearchcardRequest req = new AlibabaAlscCrmCardSearchcardRequest();
AlibabaAlscCrmCardSearchcardRequest.SearchCardOpenReq obj1 = new AlibabaAlscCrmCardSearchcardRequest.SearchCardOpenReq();
obj1.setBrandId("33959");
obj1.setCardTemplateIds("111,222,333");
obj1.setCardType("MEMBER");
obj1.setNeedCount(true);
obj1.setNo("4352124");
obj1.setOpenCardShopIds("111,222,333");
obj1.setOpenTimeEnd("2019-11-11");
obj1.setOpenTimeStart("2019-11-11");
obj1.setOutBrandId("33959");
obj1.setOutShopId("123424");
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setShopId("324532");
obj1.setStatuses("SOLD,ACTIVED,STOP");
req.setParamSearchCardOpenReq(obj1);
AlibabaAlscCrmCardSearchcardResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_alsc_crm_card_searchcard_response>
    <result>
        <biz_success>true</biz_success>
        <current_page>123</current_page>
        <has_next_page>true</has_next_page>
        <page_size>123</page_size>
        <result_list>
            <card_open_info>
                <accounts>
                    <account_open_info>
                        <account_id>1232433</account_id>
                        <account_type></account_type>
                        <balance>22</balance>
                        <create_by>小李</create_by>
                        <currency>RMB</currency>
                        <deleted>false</deleted>
                        <ext_info>
                            <empty></empty>
                        </ext_info>
                        <gift>20</gift>
                        <gmt_create>2019-01-01 11:11:11</gmt_create>
                        <gmt_modified>2019-01-01 11:11:11</gmt_modified>
                        <pre>20</pre>
                        <real>100</real>
                        <status></status>
                        <total_gift>200</total_gift>
                        <total_pre>20</total_pre>
                        <total_real>200</total_real>
                        <update_by>小王</update_by>
                    </account_open_info>
                </accounts>
                <active_operator_id>435422134</active_operator_id>
                <active_operator_name>小李</active_operator_name>
                <active_shop_id>3243432</active_shop_id>
                <active_time>2019-01-01 11:11:11</active_time>
                <buy>true</buy>
                <card_id>32456432</card_id>
                <card_template_id>324532</card_template_id>
                <card_type>MEMBER</card_type>
                <create_by>小刘</create_by>
                <customer_id>54363231</customer_id>
                <deleted>false</deleted>
                <expire_end></expire_end>
                <expire_start></expire_start>
                <ext_info>
                    <empty></empty>
                </ext_info>
                <gmt_create></gmt_create>
                <gmt_modified></gmt_modified>
                <open_operator_id>23452134</open_operator_id>
                <open_operator_name>小李子</open_operator_name>
                <open_shop_id>32453</open_shop_id>
                <open_shop_name>XXX门店</open_shop_name>
                <open_time>2019-01-01 11:11:11</open_time>
                <operator_id>342352</operator_id>
                <opt_plan_id>2342</opt_plan_id>
                <physical_cards>
                    <physical_card_open_info>
                        <bind_operator_id>43532</bind_operator_id>
                        <bind_shop_id>3453234</bind_shop_id>
                        <bind_time>2019-01-01 11:11:11</bind_time>
                        <card_id>34321342</card_id>
                        <card_template_id>234213</card_template_id>
                        <card_type>MEMBER</card_type>
                        <create_by>小刘</create_by>
                        <deleted>false</deleted>
                        <ext_info>
                            <empty></empty>
                        </ext_info>
                        <gmt_create>2019-01-01 11:11:11</gmt_create>
                        <gmt_modified>2019-01-01 11:11:11</gmt_modified>
                        <operator_id>2345214</operator_id>
                        <physical_card_id>324434232</physical_card_id>
                        <plan_id>32435324</plan_id>
                        <publish_id>43532</publish_id>
                        <status>WAIT_MAKE</status>
                        <update_by>小李子</update_by>
                    </physical_card_open_info>
                </physical_cards>
                <plan_id>3213232</plan_id>
                <status>WAIT_MAKE</status>
                <update_by>XXX</update_by>
            </card_open_info>
        </result_list>
        <result_code>200</result_code>
        <result_desc>成功</result_desc>
        <result_view>&quot;&quot;</result_view>
        <total_page>10</total_page>
        <total_size>123</total_size>
    </result>
</alibaba_alsc_crm_card_searchcard_response>

{
    "alibaba_alsc_crm_card_searchcard_response":{
        "result":{
            "biz_success":true,
            "current_page":123,
            "has_next_page":true,
            "page_size":123,
            "result_list":{
                "card_open_info":[
                    {
                        "accounts":{
                            "account_open_info":[
                                {
                                    "account_id":"1232433",
                                    "account_type":"",
                                    "balance":22,
                                    "create_by":"小李",
                                    "currency":"RMB",
                                    "deleted":false,
                                    "ext_info":{
                                        "empty":
                                    },
                                    "gift":20,
                                    "gmt_create":"2019-01-01 11:11:11",
                                    "gmt_modified":"2019-01-01 11:11:11",
                                    "pre":20,
                                    "real":100,
                                    "status":"",
                                    "total_gift":200,
                                    "total_pre":20,
                                    "total_real":200,
                                    "update_by":"小王"
                                }
                            ]
                        },
                        "active_operator_id":"435422134",
                        "active_operator_name":"小李",
                        "active_shop_id":"3243432",
                        "active_time":"2019-01-01 11:11:11",
                        "buy":true,
                        "card_id":"32456432",
                        "card_template_id":"324532",
                        "card_type":"MEMBER",
                        "create_by":"小刘",
                        "customer_id":"54363231",
                        "deleted":false,
                        "expire_end":"",
                        "expire_start":"",
                        "ext_info":{
                            "empty":
                        },
                        "gmt_create":"",
                        "gmt_modified":"",
                        "open_operator_id":"23452134",
                        "open_operator_name":"小李子",
                        "open_shop_id":"32453",
                        "open_shop_name":"XXX门店",
                        "open_time":"2019-01-01 11:11:11",
                        "operator_id":"342352",
                        "opt_plan_id":"2342",
                        "physical_cards":{
                            "physical_card_open_info":[
                                {
                                    "bind_operator_id":"43532",
                                    "bind_shop_id":"3453234",
                                    "bind_time":"2019-01-01 11:11:11",
                                    "card_id":"34321342",
                                    "card_template_id":"234213",
                                    "card_type":"MEMBER",
                                    "create_by":"小刘",
                                    "deleted":false,
                                    "ext_info":{
                                        "empty":
                                    },
                                    "gmt_create":"2019-01-01 11:11:11",
                                    "gmt_modified":"2019-01-01 11:11:11",
                                    "operator_id":"2345214",
                                    "physical_card_id":"324434232",
                                    "plan_id":"32435324",
                                    "publish_id":"43532",
                                    "status":"WAIT_MAKE",
                                    "update_by":"小李子"
                                }
                            ]
                        },
                        "plan_id":"3213232",
                        "status":"WAIT_MAKE",
                        "update_by":"XXX"
                    }
                ]
            },
            "result_code":"200",
            "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>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部