微信小店
微信门店
微信智能接口
微信设备功能

会员卡专区

出自微信公众平台开发者文档
跳转到: 导航, 搜索

目录

更新日志

版本号 更新内容 更新时间
V1.2 支持直接传入积分、余额的全量值 2015-8-17
V1.2.1 支持在创建和更新接口填入auto_activate字段将会员卡设置为自动激活 2015-8-25
V1.2.2 1.新增会员一键激活接口,用户领卡后用微信原生激活页面。

2.新增设置微信买单接口,支持开发者将已有会员更新为支持买单的会员卡。 3.新增设置消息跟随推荐接口,允许开发者在积分变动消息上推荐卡券或者url。

2015-9-8
V1.2.3 开发者可以对会员卡传入积分规则、抵扣规则和会员卡折扣属性,在会员卡买单时生效。 2015-9-21

接入会员卡

支持开发者调用接口创建会员卡接口,获取会员卡cardid,该cardid通过审核后即可调用投放接口进行会员卡投放。当用户领取到未激活的会员卡后,开发者调用接口将会员信息同步至该会员卡上(激活/绑定会员卡接口)。用户使用会员卡时,通过调用接口(会员卡交易接口)进行积分、余额、等级等信息的更新。

值得注意的是,会员卡接口支持开发者将date_type设置为DATE_TYPE_PERMANENT,表示该会员卡永久有效。

会员接口调用流程.png

步骤一:创建会员卡

支持开发者调用该接口创建会员卡,获取cardid。审核结果可通过审核事件通知获取,同时支持调用查看卡券详情接口查看卡券状态。

开发者注意事项

创建会员卡时需设置会员卡激活后呈现的会员信息类目,目前支持积分、余额、等级、优惠券、里程、印花、成就、折扣等类型,微信6.2版本显示会员信息类目的上限为3个,即创建时类目字段supply_bonus 、supply_balance、 custom_field1、custom_field2 、custom_field3最多选择三项填写。


会员卡详细字段1.png

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据

POST数据示例:

{
   "card": {
       "card_type": "MEMBER_CARD",
       "member_card": {
           "base_info": {
               "logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
               "brand_name": "海底捞",
               "code_type": "CODE_TYPE_TEXT",
               "title": "海底捞会员卡",
               "color": "Color010",
               "notice": "使用时向服务员出示此券",
               "service_phone": "020-88888888",
               "description": "不可与其他优惠同享",
               "date_info": {
                   "type": "DATE_TYPE_PERMANENT"
               },
               "sku": {
                   "quantity": 50000000
               },
               "get_limit": 3,
               "use_custom_code": false,
               "can_give_friend": true,
               "location_id_list": [
                   123,
                   12321,
                   345345
               ],
               "custom_url_name": "立即使用",
               "custom_url": "http://www.xxx.com",
               "custom_url_sub_title": "6个汉字tips",
               "promotion_url_name": "营销入口1",
               "promotion_url": "http://www.xxx.com",
               "need_push_on_view": true
           },
           "supply_bonus": true,
           "supply_balance": false,
           "prerogative": "test_prerogative",
           "auto_activate": true,
           "custom_field1": {
               "name_type": "FIELD_NAME_TYPE_LEVEL",
               "url": "http://www.xxx.com"
           },
           "activate_url": "http://www.xxx.com",
           "custom_cell1": {
               "name": "使用入口2",
               "tips": "激活后显示",
               "url": "http://www.xxx.com"
           },
           "bonus_rule": {
              "cost_money_unit": 100,
              "increase_bonus": 1,
              "max_increase_bonus": 200,
              "init_increase_bonus": 10,
              "cost_bonus_unit": 5,          
              "reduce_money":  100,            
              "least_money_to_use_bonus": 1000, 
              "max_reduce_bonus": 50
           },
           "discount": 10
       }
   }
}
参数名 必填 类型 示例值 描述
card_type string(24) MEMBER_CARD 会员卡类型。
base_info Json结构 见上述示例。 基本的卡券数据,见下表,所有卡券类型通用。
prerogative string(3072) 持白金会员卡到店消费,可享8折优惠。 会员卡特权说明。
auto_activate bool true 设置为true时用户领取会员卡后系统自动将其激活,无需调用激活接口,详情见自动激活
wx_activate bool true 设置为true时会员卡支持一键开卡,不允许同时传入activate_url字段,否则设置wx_activate失效。填入该字段后仍需调用接口设置开卡项方可生效,详情见一键开卡
supply_bonus bool true 显示积分,填写true或false,如填写true,积分相关字段均为必填。
bonus_url string(32) xxxx.com 设置跳转外链查看积分详情。仅适用于积分无法通过激活接口同步的情况下使用该字段。
supply_balance bool true 是否支持储值,填写true或false。如填写true,储值相关字段均为必填。
balance_url string(32) xxxx.com 设置跳转外链查看余额详情。仅适用于余额无法通过激活接口同步的情况下使用该字段。
custom_field1 Json结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
custom_field2 Json结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
custom_field3 Json结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
name_type string(24) FIELD_NAME_TYPE_LEVEL 会员信息类目名称。FIELD_NAME_TYPE_LEVEL等级;FIELD_NAME_TYPE_COUPON优惠券;FIELD_NAME_TYPE_STAMP印花;FIELD_NAME_TYPE_DISCOUNT折扣;FIELD_NAME_TYPE_ACHIEVEMEN成就;FIELD_NAME_TYPE_MILEAGE里程。
url string(128) xxx.com 点击类目跳转外链url
bonus_cleared string(128) 每年年底12月30号积分清0。 积分清零规则。
bonus_rules string(128) 每消费一元获取1点积分。 积分规则。
balance_rules string(128) xxx.com 储值说明。
activate_url string(128) xxx.com 激活会员卡的url。
custom_cell1 Json结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
name string(15) 见上述示例。 入口名称。
tips string(18) 立即查看 入口右侧提示语,6个汉字内。
url string(128) xxx.com 入口跳转链接。
bonus_rule json结构 见上述示例 积分规则。用于微信买单功能
cost_money_unit int 100 消费金额。以分为单位。
increase_bonus int 100 对应增加的积分。
max_increase_bonus int 10000 用户单次可获取的积分上限。
init_increase_bonus int 10 初始设置积分。
cost_bonus_unit int 10 每使用5积分。
reduce_money int 10 抵扣xx元,(这里以分为单位)
least_money_to_use_bonus int 100 抵扣条件,满xx元(这里以分为单位)可用。
max_reduce_bonus int 10 抵扣条件,单笔最多使用xx积分。
discount int 10 折扣,该会员卡享受的折扣优惠,填10就是九折。

base_info字段:

参数名 必填 类型 示例值 描述
logo_url string(128) http://mmbiz.qpic.cn/ 卡券的商户logo,建议像素为300*300。
code_type string(16) CODE_TYPE_TEXT Code展示类型,"CODE_TYPE_TEXT",文本;"CODE_TYPE_BARCODE",一维码 ;"CODE_TYPE_QRCODE",二维码;"CODE_TYPE_ONLY_QRCODE",二维码无code显示;"CODE_TYPE_ONLY_BARCODE",一维码无code显示;
brand_name string(36) 海底捞 商户名字,字数上限为12个汉字。
title string(27) 双人套餐100元兑换券 卡券名,字数上限为9个汉字。(建议涵盖卡券属性、服务及金额)。
color string(16) Color010 券颜色。按色彩规范标注填写Color010-Color100。详情见获取颜色列表接口
notice string(48) 请出示二维码核销卡券 卡券使用提醒,字数上限为16个汉字。
description string(3072) 不可与其他优惠同享/n如需团购券发票,请向店员提出要求。 卡券使用说明,字数上限为1024个汉字。
sku Json结构 见上述示例。 商品信息。
quantity int 100000 卡券库存的数量,不支持填写0,上限为100000000。
date_info Json结构 见上述示例。 使用日期,有效期的信息。
type string DATE_TYPE_FIX_TIME_RANGE 表示固定日期区间,DATE_TYPE_FIX_TERM表示固定时长(自领取后按天算),DATE_TYPE_PERMANENT 表示永久有效。 使用时间的类型,旧文档采用的1和2依然生效。
begin_timestamp unsigned int 14300000 type为DATE_TYPE_FIX_TIME_RANGE时专用,表示起用时间。从1970年1月1日00:00:00至起用时间的秒数,最终需转换为字符串形态传入。(东八区时间,单位为秒)
end_timestamp unsigned int 15300000 type为DATE_TYPE_FIX_TERM_RANGE时专用,表示结束时间,建议设置为截止日期的23:59:59过期。(东八区时间,单位为秒)
fixed_term int 0 type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天内有效,领取后当天有效填写0。(单位为天)
fixed_begin_term int 15 type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天开始生效。(单位为天)
use_custom_code bool true 是否自定义Code码。填写true或false,默认为false。通常自有优惠码系统的开发者选择自定义Code码,在卡券投放时带入。
bind_openid bool true 是否指定用户领取,填写true或false。默认为false。
service_phone string(24) 40012234 客服电话。
location_id_list array 1234,2312 门店位置ID。调用POI门店管理接口获取门店位置ID。
source string(36) 大众点评 第三方来源名,例如同程旅游、大众点评。
custom_url_name string(15) 立即使用 自定义跳转外链的入口名字。
custom_url string(128) "xxxx.com" 自定义跳转的URL。
custom_url_sub_title string(18) 更多惊喜 显示在入口右侧的提示语。
promotion_url_name string(15) 产品介绍 营销场景的自定义入口名称。
promotion_url string(128) XXXX.com 入口跳转外链的地址链接。
promotion_url_sub_title string(18) 卖场大优惠。 显示在营销入口右侧的提示语。
get_limit int 1 每人可领券的数量限制。默认值为50。
can_share bool false 卡券领取页面是否可分享。
can_give_friend bool false 卡券是否可转赠。
need_push_on_view bool false 填写true为用户点击进入会员卡时推送事件,默认为false。详情见进入会员卡事件推送

返回说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok",
   "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。
card_id 卡券ID。

步骤二:获取会员卡审核结果

调用接口成功创建会员卡后,会由系统自动提交审核,审核结果将在三个工作日内以事件形式告知开发者,同时支持调用接口主动查询卡券状态。

审核事件推送

生成的卡券通过审核时,微信会把这个事件推送到开发者填写的URL。

<xml> <ToUserName><![CDATA[toUser]]></ToUserName> 
<FromUserName><![CDATA[FromUser]]></FromUserName> 
<CreateTime>123456789</CreateTime> 
<MsgType><![CDATA[event]]></MsgType> 
<Event><![CDATA[card_pass_check]]></Event>  //不通过为card_not_pass_check
<CardId><![CDATA[cardid]]></CardId> 
</xml>

参数说明:

参数 说明
ToUserName 开发者微信号
FromUserName 发送方帐号(一个OpenID)
CreateTime 消息创建时间 (整型)
MsgType 消息类型,event
Event 事件类型,card_pass_check(卡券通过审核)、card_not_pass_check(卡券未通过审核)
CardId 卡券ID

查看卡券详情接口

调用该接口可查询卡券字段详情及卡券所处状态。通过查看返回值中status字段可判断该卡券是否通过审核。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/get?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
  "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
参数名 必填 类型 示例值 描述
cardid string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。

返回数据

数据示例:

{
   "errcode": 0,
   "errmsg": "ok",
   "card": {
       "card_type":  "GROUPON",
           "groupon": {
           "base_info": {
               "status": 1,
               "id": "p1Pj9jr90_SQRaVqYI239Ka1erkI",
               "logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
               "appid": "wx588def6b0089dd48",
               "code_type": "CODE_TYPE_TEXT",
               "brand_name": "海底捞",
               "title": "132元双人火锅套餐",
               "sub_title": "",
               "date_info": {
                   "type": DATE_TYPE_FIX_TIME_RANGE,
                   "begin_timestamp": 1397577600,
                   "end_timestamp": 1399910400
               },
               "color": "#3373bb",
               "notice": "使用时向服务员出示此券",
               "service_phone": "020-88888888",
               "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食\n餐前不可打包,餐后未吃完,可打包\n本团购券不限人数,建议2人使用,超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料",
               "use_limit": 1,
               "get_limit": 3,
               "can_share": true,
               "location_id_list" : [123, 12321, 345345]
               "custom_url_name": "立即使用",
               "custom_url": "http://www.qq.com",
               "custom_url_sub_title": "6个汉字tips",
               "promotion_url_name": "更多优惠",
               "promotion_url": "http://www.qq.com",
               "source": "大众点评"   
               "sku": {
                   "quantity": 0
               }
           },
           "deal_detail": "以下锅底2选1(有菌王锅、麻辣锅、大骨锅、番茄锅、清补凉锅、酸菜鱼锅可选):\n大锅1份 12元\n小锅2份 16元\n以下菜品2选1\n特级肥牛1份 30元\n洞庭鮰鱼卷1份 20元\n其他\n鲜菇猪肉滑1份 18元\n金针菇1份 16元\n黑木耳1份 9元\n娃娃菜1份 8元\n冬瓜1份 6元\n火锅面2个 6元\n欢乐畅饮2位 12元\n自助酱料2位 10元",
       }
参数名 描述
card_type 卡券类型。

团购券:GROUPON; 折扣券:DISCOUNT; 礼品券:GIFT; 代金券:CASH; 通用券:GENERAL_COUPON; 会员卡:MEMBER_CARD; 景点门票:SCENIC_TICKET; 电影票:MOVIE_TICKET; 飞机票:BOARDING_PASS; 会议门票:MEETING_TICKET; 汽车票:BUS_TICKET;

base_info 基本的卡券数据,见下表,所有卡券通用。
supply_balance 会员卡专属字段,表示是否支持积分,填写true或false,如填写true,积分相关字段均为必填。
supply_bonus 会员卡专属字段,表示否支持储值,填写true或false,如填写true,储值相关字段均为必填。
bonus_cleared 积分清零规则。
bonus_rules 积分规则。
balance_rules 储值规则。
prerogative 会员卡专属字段,表示特权说明。
bind_old_card_url 绑定旧卡的url。
activate_url 激活会员卡。
need_push_on_view 进入会员卡时是否推送事件,填写true或false。
from 飞机票的起点,上限为18个汉字。
to 飞机票的终点,上限为18个汉字。
flight 航班。
departure_time 起飞时间。(Unix时间戳格式)
landing_time 降落时间。(Unix时间戳格式)
check_in_url 在线值机的链接。
gate 登机口。如发生登机口变更,建议商家实时调用该接口变更。
boarding_time 登机时间,只显示“时分”不显示日期。(Unix时间戳格式)
meeting_detail 会议详情。
map_url 会场导览图。

base_info字段:

参数名 描述
logo_url 卡券的商户logo,建议像素为300*300。
code_type "CODE_TYPE_TEXT",文本;"CODE_TYPE_BARCODE",一维码 ;"CODE_TYPE_QRCODE",二维码;"CODE_TYPE_ONLY_QRCODE",二维码无code显示;"CODE_TYPE_ONLY_BARCODE",一维码无code显示;
brand_name 商户名字(填写直接提供服务的商户名,第三方商户名填写在source字段)。
title 卡券名。
sub_title 卡券名的副标题。
color 卡券的背景颜色。
notice 使用提醒,字数上限为16个汉字。
description 使用说明。长文本描述。
date_info 使用日期,有效期的信息。
type 使用时间的类型。DATE_TYPE_FIX_TIME_RANGE为固定日期区间,DATE_TYPE_FIX_TERM为固定时长(自领取后按天算),DATE_TYPE_PERMANENT 表示永久有效。
begin_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示起用时间。从1970年1月1日00:00:00至起用时间的秒数,最终需转换为字符串形态传入,下同。(单位为秒)
end_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示结束时间。(单位为秒)
fixed_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天内有效,领取后当天有效填写0。(单位为天)
fixed_begin_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天开始生效。(单位为天)
sku 商品信息
quantity 卡券库存的数量,不支持填写0。(上限为100000000)
location_id_list 门店位置ID。
use_custom_code 是否自定义Code码。填写true或false,默认为false。
bind_openid 是否指定用户领取,填写true或false。默认为否。
can_share 卡券是否可转赠,填写true或false,true代表可转赠。默认为true。
service_phone 客服电话。
source 第三方来源名,例如同程旅游、大众点评。
custom_url_name 商户自定义入口名称。
custom_url 商户自定义入口跳转外链的地址链接,跳转页面内容需与自定义cell名称保持匹配。
custom_url_sub_title 显示在入口右侧的tips,长度限制在6个汉字内。
promotion_url_name 营销场景的自定义入口。
promotion_url 入口跳转外链的地址链接。
promotion_url_sub_title 显示在营销入口右侧的提示语。
custom_url_name 商户自定义入口名称。
status “CARD_STATUS_NOT_VERIFY”,待审核;“CARD_STATUS_VERIFY_FALL”,审核失败;“CARD_STATUS_VERIFY_OK”,通过审核;“CARD_STATUS_USER_DELETE”,卡券被用户删除;“CARD_STATUS_USER_DISPATCH”,在公众平台投放过的卡券

设置测试白名单

接口说明

由于卡券有审核要求,为方便公众号调试,可以设置十个测试帐号,这些帐号可领取未通过审核的卡券,体验整个流程。

开发者注意事项

1.同时支持“openid”、“username”两种字段设置白名单,总数上限为10个。

2.设置测试白名单接口为全量设置,即测试名单发生变化时需调用该接口重新传入所有测试人员的ID.

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/testwhitelist/set?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据
{
  "openid": [
      "o1Pj9jmZvwSyyyyyyBa4aULW2mA", 
      "o1Pj9jmZvxxxxxxxxxULW2mA"
               ],
  "username": [
      "afdvvf",
      "abcd"
                ]
 }

参数名 必填 类型 示例值 描述
openid string(20) o1Pj9jmZvwSyyyyyyBa4aULW2mA 测试的openid列表。
username string(32) eddy 测试的微信号列表。

返回说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok"
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。

步骤三:投放会员卡

支持开发者调用接口通过二维码、JS-SDK、群发消息等多种方式投放会员卡。

特别注意

开发者调用接口投放的会员卡为无会员信息的“卡套”,会员卡编号、积分、余额等信息需在用户领取会员卡后调用激活/绑定会员卡接口更新上。

调用激活/绑定会员卡接口的凭证为Code码及卡券ID,开发者需在调用投放会员卡时通过接口或领取卡券事件记录Code码与会员的关系。

创建二维码接口

开发者可调用该接口生成一张卡券二维码供用户扫码后添加卡券到卡包。

自定义Code码的卡券调用接口时,post数据中需指定code,非自定义code不需指定,指定openid同理。指定后的二维码只能被用户扫描领取一次。

注:该接口仅支持卡券功能,供已开通卡券功能权限的商户(订阅号、服务号)调用。 已认证服务号的商户也可使用高级接口中生成带参数的二维码接口生成卡券二维码。

获取二维码ticket后,开发者可用通过ticket换取二维码接口换取二维码图片详情。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/qrcode/create?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据 开发者可以设置扫描二维码领取单张卡券,此时POST数据为:

 {
"action_name": "QR_CARD", 
"expire_seconds": 1800,
"action_info": {
"card": {
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc", 
"code": "198374613512",
"openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"is_unique_code": false ,
"outer_id" : 1
  }
 }
}

当开发者设置扫描二维码领取多张卡券,此时POST数据为:

{
"action_name": "QR_MULTIPLE_CARD", 
"action_info": {
"multiple_card": {
"card_list": [
{
"card_id": "p1Pj9jgj3BcomSgtuW8B1wl-wo88",
"code":"2392583481"
}, 
{
"card_id": "p1Pj9jgj3BcomSgtuW8B1wl-wo98",
"code":"2392583482"
}
]
}
}
}
参数名 必填 类型 示例值 描述
code string(20) 110201201245 卡券Code码,use_custom_code字段为true的卡券必须填写,非自定义code不必填写。。
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。
openid string(32) oXch-jkrxp42VQu8ldweCwDt97qo 指定领取者的openid,只有该用户能领取。bind_openid字段为true的卡券必须填写,非指定openid不必填写。
expire_seconds unsigned int 60 指定二维码的有效时间,范围是60 ~ 1800秒。不填默认为永久有效。
is_unique_code bool false 指定下发二维码,生成的二维码随机分配一个code,领取后不可再次扫描。填写true或false。默认false。
outer_id int 12 领取场景值,用于领取渠道的数据统计,默认值为0,字段类型为整型,长度限制为60位数字。用户领取卡券后触发的事件推送中会带上此自定义场景值。

返回数据

数据示例:

{
 "errcode": 0,
 "errmsg": "ok",
 "ticket":      "gQHB8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0JIV3lhX3psZmlvSDZmWGVMMTZvAAIEsNnKVQMEIAMAAA==",//获取ticket后需调用换取二维码接口获取二维码图片,详情见字段说明。
 "expire_seconds": 1800,
 "url": "http://weixin.qq.com/q/BHWya_zlfioH6fXeL16o ",
 "show_qrcode_url": " https://mp.weixin.qq.com/cgi-bin/showqrcode?  ticket=gQH98DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0czVzRlSWpsamlyM2plWTNKVktvAAIE6SfgVQMEgDPhAQ%3D%3D"
 }
参数名 描述
errcode 错误码
errmsg 错误信息
ticket 获取的二维码ticket,凭借此ticket调用通过ticket换取二维码接口可以在有效时间内换取二维码。
url 二维码图片解析后的地址,开发者可根据该地址自行生成需要的二维码图片
show_qrcode_url 二维码显示地址,点击后跳转二维码页面

添加卡券JS-SDK

微信 JS-SDK 仅支持在微信内置浏览器中使用,其他浏览器调用无效。微信提供addCard接口供商户前端网页调用,用于将一张或多张卡券添加到用户卡包。详情见批量添加卡券接口

添加JS-SDK.png

通过卡券货架投放卡券

卡券货架简介

卡券货架支持开发者通过调用接口生成一个卡券领取H5页面,并获取页面链接,进行卡券投放动作。接口详情见创建卡券货架接口

卡券货架.png

群发卡券

请开发者特别注意,目前群发卡券接口仅支持投放非自定义Code码的卡券,非自定义code的开发者可以选择提前用导入code接口将code导入至微信服务器,从而获得和非自定义code相同的群发能力。


图文消息群发卡券

支持开发者调用该接口获取卡券嵌入图文消息的标准格式代码,将返回代码填入上传图文素材接口中content字段,即可获取嵌入卡券的图文消息素材。

特别注意:目前该接口仅支持填入非自定义code的卡券,非自定义code的开发者可以选择提前用导入code接口将code导入至微信服务器。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/mpnews/gethtml?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
  "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
参数名 必填 类型 示例值 描述
cardid string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。

返回数据

数据示例:

 {
"errcode":0,
"errmsg":"ok",
"content":"<iframeclass=\"res_iframecard_iframejs_editor_card\"data-src=\"http: \/\/mp.weixin.qq.com\/bizmall\/appmsgcard?action=show&biz=MjM5OTAwODk4MA%3D%3D&cardid=p1Pj9jnXTLf2nF7lccYScFUYqJ0&wechat_card_js=1#wechat_redirect\">"
}
参数名 描述
errcode 错误码
errmsg 错误信息
content 返回一段html代码,可以直接嵌入到图文消息的正文里。即可以把这段代码嵌入到上传图文消息素材接口中的content字段里。


根据分组群发卡券消息

支持调用该接口向指定分组的用户群发卡券消息。详情见根据分组进行群发接口

特别注意:目前该接口仅支持填入非自定义code的卡券,非自定义code的开发者可以选择提前用导入code接口将code导入至微信服务器。

根据OpenID列表群发卡券消息

支持根据OpenID群发原生卡券。订阅号不可用,服务号认证后具备接口权限。详情见根据OpenID列表群发接口

特别注意:目前该接口仅支持填入非自定义code的卡券,非自定义code的开发者可以选择提前用导入code接口将code导入至微信服务器。

客服消息下发卡券

支持开发者调用该接口下发卡券。订阅号不可用,服务号认证后可用。详情见客服接口-发消息

特别注意:目前该接口仅支持填入非自定义code的卡券,非自定义code的开发者可以选择提前用导入code接口将code导入至微信服务器。

预览接口

支持开发者调用该接口下发卡券。订阅号不可用,服务号认证后可用。详情见客服接口-发消息

领取事件推送

用户在领取卡券时,微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例:

<xml> <ToUserName><![CDATA[toUser]]></ToUserName> 
<FromUserName><![CDATA[FromUser]]></FromUserName> 
<FriendUserName><![CDATA[FriendUser]]></FriendUserName> 
<CreateTime>123456789</CreateTime> 
<MsgType><![CDATA[event]]></MsgType> 
<Event><![CDATA[user_get_card]]></Event> 
<CardId><![CDATA[cardid]]></CardId> 
<IsGiveByFriend>1</IsGiveByFriend>
<UserCardCode><![CDATA[12312312]]></UserCardCode>
<OuterId>0</OuterId>
</xml>

参数说明:

参数 说明
ToUserName 开发者微信号。
FromUserName 领券方帐号(一个OpenID)。
FriendUserName 赠送方账号(一个OpenID),"IsGiveByFriend”为1时填写该参数。
CreateTime 消息创建时间 (整型)。
MsgType 消息类型,event
Event 事件类型,user_get_card(用户领取卡券)。
CardId 卡券ID。
IsGiveByFriend 是否为转赠,1代表是,0代表否。
UserCardCode code序列号。自定义code及非自定义code的卡券被领取后都支持事件推送。
OldUserCardCode 转赠前的code序列号。
OuterId 领取场景值,用于领取渠道数据统计。可在生成二维码接口及添加JS API接口中自定义该字段的整型值。

投放渠道数据统计

为方便开发者统计各渠道的卡券投放数据,新增字段outer_id。将不同设值的outer_id填入card_ext的json结构中,当用户领取卡券时会将相应设值的outer_id带入领取事件中,推送至开发者服务器。

示例: 在二维码投放方式中设置outer_id为1

{
"action_name": "QR_CARD", 
"action_info": {
"card": {
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc", 
"code": "198374613512",
"openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"expire_seconds": "1800",
"is_unique_code": false ,
"outer_id" : 1
  }
 }
}


领取事件XML文件

<xml> <ToUserName><![CDATA[toUser]]></ToUserName> 
<FromUserName><![CDATA[FromUser]]></FromUserName> 
<FriendUserName><![CDATA[FriendUser]]></FriendUserName> 
<CreateTime>123456789</CreateTime> 
<MsgType><![CDATA[event]]></MsgType> 
<Event><![CDATA[user_get_card]]></Event> 
<CardId><![CDATA[cardid]]></CardId> 
<IsGiveByFriend>1</IsGiveByFriend>
<UserCardCode><![CDATA[12312312]]></UserCardCode>
<OuterId>1</OuterId>
</xml>

步骤四:激活/绑定会员卡

当用户领取会员卡“卡套”后,支持调用该接口对会员卡进行激活或绑定,并设置会员信息的初始值,如积分、余额、会员卡编号。

目前,微信会员卡支持三种激活方式,分别是接口激活、一键激活和自动激活。

开发者注意事项

1.创建会员卡时需设置会员卡被领取后呈现的激活/绑定入口名称,并支持跳转外链填写用户信息,当用户完成激活信息填写后调用激活/绑定会员接口完成会员信息的更新。若无需用户填写会员信息,可在接收到领取事件通知时直接调用该接口完成激活。

2.激活/绑定会员卡需传入用户领取时获取的Code码,将该Code码对应设置会员卡编号membership_number。特别注意,用户领取时获取的Code码不显示,会员卡页面仅显示开发者调用该接口传入的会员卡编号membership_number。(membership_number可与Code码等值)

会员卡激活流程.png

接口激活

激活方式说明

接口激活通常需要开发者开发一个用于用户填写资料的H5页面。通常有两种激活流程,第一种是用户必须填写资料后才能领卡,领卡后开发者调用激活接口为用户激活会员卡; 另一种是用户可以先领取会员卡,点击激活会员卡跳转至开发者设置的资料填写页面,填写完成后开发者调用激活接口为用户激活会员卡。


接口详情

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据
{
  "init_bonus": 100,
  "init_balance": 200,
  "membership_number": "AAA00000001",
  "code": "12312313",
  "card_id": "xxxx_card_id",
  "init_custom_field_value1": "xxxxx"
 }
参数名 必填 类型 示例值 描述
membership_number string(20) 357898858 会员卡编号,由开发者填入,作为序列号显示在用户的卡包里。可与Code码保持等值。
code string(20) 1231123 创建会员卡时获取的初始code。
activate_begin_time unsigned int 1397577600 激活后的有效起始时间。若不填写默认以创建时的 data_info 为准。Unix时间戳格式。
activate_end_time unsigned int 1422724261 激活后的有效截至时间。若不填写默认以创建时的 data_info 为准。Unix时间戳格式。
init_bonus string(3072) 持白金会员卡到店消费,可享8折优惠。 初始积分,不填为0。
init_balance string(3072) 持白金会员卡到店消费,可享8折优惠。 初始余额,不填为0。
init_custom_field_value1 string(12) 白银 创建时字段custom_field1定义类型的初始值,限制为4个汉字,12字节。
init_custom_field_value2 string(12) 9折 创建时字段custom_field1定义类型的初始值,限制为4个汉字,12字节。
init_custom_field_value3 string(12) 200 创建时字段custom_field1定义类型的初始值,限制为4个汉字,12字节。

返回说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok"
 }
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。

一键开卡

一键激活是微信提供的快速便捷的激活方案,用该种激活方式的会员卡,用户领取时点击“激活会员卡”会跳转至微信原生的资料填写页面,微信会自动拉取该用户之前填写过的开卡信息,用户无需重复填写, 同时避免了手机号验证的过程,从而实现一键激活的目的,提高了开卡率。具体流程如下图:

一键激活.png

步骤一:在创建接口填入wx_activate字段

开发者注意事项

1.填入了自动激活auto_activate字段,激活链接activate_url和一键开卡接口设置都会失效;

2.若同时传入了activate_url,则一键开卡接口设置会失效;

3.建议开发者activate_url auto_activate和wx_activate只填写一项。

接口说明

设置微信一键开卡功能,现支持在创建会员卡时填入指定字段指定要一键开卡,member_card中增加"wx_activate": true。 详情请见创建会员卡接口

参数说明

参数 是否必须 说明
member_card
wx_activate 填写true or false

POST数据示例:

{
      "card_id":"pbLatjl-h7zjEq-Pljma29yXGNCU",
      "member_card": {        
                 "wx_activate" : true
      }
}


步骤二:设置开卡字段接口

支持开发者自定义开卡字段,具体说明如下:

一键激活字段设置.png

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/membercard/activateuserform/set?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据
{
   "card_id": "pbLatjpFZHzA0mv6FINEg6M9i2x0",
   "required_form": {
       "common_field_id_list": [
           "USER_FORM_INFO_FLAG_MOBILE",
           "USER_FORM_INFO_FLAG_LOCATION",
           "USER_FORM_INFO_FLAG_BIRTHDAY"
       ],
       "custom_field_list": [
           "喜欢的食物"
       ]
   },
   "optional_form": {
       "common_field_id_list": [
           "USER_FORM_INFO_FLAG_EMAIL"
       ],
       "custom_field_list": [
           "喜欢的电影"
       ]
   }
}


参数名 必填 类型 示例值 描述
card_id string(32) pfK3QtyBapdxunUQfLRYMJqPrtII 卡券ID。
required_form Json结构 见上述示例。 会员卡激活时的必填选项。
optional_form Json结构,见上述示例。 见上述示例 会员卡激活时的选填项。
common_field_id_list string(32) USER_FORM_INFO_FLAG_MOBILE 微信格式化的选项类型。见以下列表。
custom_field_list string(24) 喜欢的家具风格 自定义选项名称。

common_field_id_list,支持开发者使用以下选项类型


字段值 描述
USER_FORM_INFO_FLAG_MOBILE 手机号
USER_FORM_INFO_FLAG_NAME 姓名
USER_FORM_INFO_FLAG_BIRTHDAY 生日
USER_FORM_INFO_FLAG_IDCARD 身份证
USER_FORM_INFO_FLAG_EMAIL 邮箱
USER_FORM_INFO_FLAG_DETAIL_LOCATION 详细地址
USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND 教育背景
USER_FORM_INFO_FLAG_CAREER 职业
USER_FORM_INFO_FLAG_INDUSTRY 行业
USER_FORM_INFO_FLAG_INCOME 收入
USER_FORM_INFO_FLAG_HABIT 兴趣爱好


步骤三:接收会员信息事件通知

用户填写、提交资料后,会有事件推送给商家,开发者可以在接收到事件通知后调用激活接口,传入会员卡号、初始积分等信息或者调用拉取会员信息接口获取会员信息,进行会员管理。

推送XML数据包示例

  </xml>
  <ToUserName> <![CDATA[gh_3fcea188bf78]]></ToUserName>
  <FromUserName><![CDATA[obLatjlaNQKb8FqOvt1M1x1lIBFE]]></FromUserName>
  <CreateTime>1432668700</CreateTime>
  <MsgType><![CDATA[event]]></MsgType>
  <Event><![CDATA[submit_membercard_user_info]]></Event>
  <CardId><![CDATA[pbLatjtZ7v1BG_ZnTjbW85GYc_E8]]></CardId>
  <UserCardCode><![CDATA[018255396048]]></UserCardCode>
  </xml>


参数说明

参数 说明
ToUserName 开发者微信号
FromUserName 发送方帐号(一个OpenID)
CreateTime 消息创建时间 (整型)
MsgType 消息类型,event
CardId 卡券ID
UserCardCode 卡券Code码


步骤四:激活会员卡接口

开发者可以在接收到事件通知后调用激活接口,传入会员卡号、初始积分等信息或者调用拉取会员信息接口获取会员信息,详情请见:激活会员卡接口


步骤五:拉取会员信息接口

接口说明

支持开发者根据CardID和Code查询会员信息。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
   "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",
   "code": "916679873278"
}

返回数据

{
 "errcode": 0,
 "errmsg": "ok",
 "openid": "obLatjjwDolFj******wNqRXw",
 "nickname": "*******",
 "membership_number": "658*****445",
 "bonus": 995,
 "sex": "MALE",
 "user_info": {
   "common_field_list": [
     {
       "name": "USER_FORM_INFO_FLAG_MOBILE",
       "value": "15*****518"
     },
     {
       "name": "USER_FORM_INFO_FLAG_NAME",
       "value": "HK"
     },
     {
       "name": "USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND",
       "value": "研究生"
     }
   ],
   "custom_field_list": []
 },
 "user_card_status": "NORMAL"
}
参数名 说明
errcode 错误码,0为正常
errmsg 错误信息
openid 用户在本公众号内唯一识别码
nickname 用户昵称
bonus 积分信息
balance 余额信息
sex 用户性别
user_info 会员信息
custom_field_list 开发者设置的会员卡会员信息类目,如等级。
name 会员信息类目名称
value 会员卡信息类目值,比如等级值等
user_card_status 当前用户的会员卡状态,NORMAL 正常 EXPIRE 已过期 GIFTING 转赠中 GIFT_SUCC 转赠成功 GIFT_TIMEOUT 转赠超时 DELETE 已删除,UNAVAILABLE 已失效

自动激活

接口说明

设置会员卡自动激活功能,需在创建会员卡时填入指定字段,base_info中增加"auto_activate": true,获取cardid。 详情请见创建会员卡接口

值得注意的是,传入自动激活字段auto_activate之后,一键激活设置和接口激活设置的激活url均不再显示,用户领取卡片之后,系统自动帮用户激活,积分、储值等自定义显示信息均为0,开发者可以通过更新会员信息接口更新用户会员数据。

参数说明

参数 是否必须 说明
member_card
auto_activate 填写true or false

步骤五:更新会员信息

当会员持卡消费后,支持开发者调用该接口更新会员信息。会员卡交易后的每次信息变更需通过该接口通知微信,便于后续消息通知及其他扩展功能。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/membercard/updateuser?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据

可以传入积分、余额的差值

{
 "code": "12312313",
 "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI",
 "record_bonus": "消费30元,获得3积分",
 "add_bonus": 3,//可以传入积分增减的差值
 "add_balance": -3000,//可以传入余额本次增减的差值
 "record_balance": "购买焦糖玛琪朵一杯,扣除金额30元。",
 "custom_field_value1": "xxxxx",
}

或者直接传入积分、余额的全量值

{
 "code": "12312313",
 "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI",
 "record_bonus": "消费30元,获得3积分",
 "bonus": 3000,//可以传入第三方系统记录的积分全量值
 "balance": 3000,//可以传入第三方系统记录的余额全量值
 "record_balance": "购买焦糖玛琪朵一杯,扣除金额30元。",
 "custom_field_value1": "xxxxx",
}

值得注意的是,如果开发者做不到实时同步积分、余额至微信端,我们强烈建议开发者可以在每天的固定时间点变更积分,一天不超过三次。当传入的积分值与之前无变化时(add_bonus=0或者传入的bonus=原来的bonus),不会有积分变动通知。

参数说明:

参数名 必填 类型 示例值 描述
code string(20) 1231123 卡券Code码。
card_id string(32) p1Pj9jr90_SQRaVqYI239Ka1erkI 卡券ID。
add_bonus int 100 需要变更的积分,扣除积分用“-“表示。
bonus int 100 需要设置的积分全量值,传入的数值会直接显示,如果同时传入add_bonus和bonus,则前者无效。
record_bonus string(42) 消费30元,获得3积分 商家自定义积分消耗记录,不超过14个汉字。
add_balance int 100 需要变更的余额,扣除金额用“-”表示。单位为分。
balance int 100 需要设置的余额全量值,传入的数值会直接显示,如果同时传入add_balance和balance,则前者无效。
record_balance string(42) 购买焦糖玛琪朵一杯,扣除金额30元。 商家自定义金额消耗记录,不超过14个汉字。
custom_field_value1 string(12) 白金 创建时字段custom_field1定义类型的最新数值,限制为4个汉字,12字节。
custom_field_value2 string(12) 8折 创建时字段custom_field2定义类型的最新数值,限制为4个汉字,12字节。
custom_field_value3 string(12) 500 创建时字段custom_field3定义类型的最新数值,限制为4个汉字,12字节。

返回说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok",
   "result_bonus": 100,
   "result_balance": 200,
   "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA"
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。
result_bonus 当前用户积分总额。
result_balance 当前用户预存总金额。
openid 用户openid。

管理会员卡

查询Code接口

查询code接口可以查询当前code是否可以被核销并检查code状态。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/code/get?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
   "card_id" : "card_id_123+",
   "code" : "123456789",
   "check_consume" : true
}


参数名 必填 类型 示例值 描述
code string(20) 110201201245 单张卡券的唯一标准。
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID代表一类卡券。
check_consume bool true 是否校验code核销状态,填入true和false时的code异常状态返回数据不同。


当check_consume为true时返回数据

卡券状态正常:

 {
"errcode":0,
"errmsg":"ok",
"openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"card":{
"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"begin_time": 1404205036,
"end_time": 1404205036,
"user_card_status": "NORMAL",
"can_consume":"true"
  }
}

卡券状态异常:

{
 "errcode": 40127,
 "errmsg": "invalid user-card status! Hint: the card was given to user, but may be    deleted or set unavailable ! hint: [iHBD40040ent3]"
}

当check_consume为false时返回数据

卡券状态正常:

 {
"errcode":0,
"errmsg":"ok",
"openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"card":{
"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"begin_time": 1404205036,
"end_time": 1404205036
"can_consume":"true"
  }
}

卡券状态异常:

 {
"errcode":0,
"errmsg":"ok",
"openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"card":{
"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"begin_time": 1404205036,
"end_time": 1404205036,
"user_card_status": "GIFTING",
"can_consume":"false"
  }
}


参数名 描述
errcode 错误码
errmsg 错误信息
openid 用户openid
card_id 卡券ID
begin_time 起始使用时间
end_time 结束时间
user_card_status 当前code对应卡券的状态, NORMAL 正常 CONSUMED 已核销 EXPIRE 已过期 GIFTING 转赠中

GIFT_TIMEOUT 转赠超时 DELETE 已删除,UNAVAILABLE 已失效 code未被添加或被转赠领取的情况则统一报错:invalid serial code

can_consume 是否可以核销,true为可以核销,false为不可核销

注: 1.固定时长有效期会根据用户实际领取时间转换,如用户2013年10月1日领取,固定时长有效期为90天,即有效时间为2013年10月1日-12月29日有效。

2.无论书check_consume填写的是true还是false,当code未被添加或者code被转赠领取是统一报错:invalid serial code

获取用户已领取的卡券

支持开发者调用该接口获取指定用户卡包中属于该appid下的卡券。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/user/getcardlist?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
  "openid": "12312313",
  "card_id": "xxxxxxxxxx"
}
参数名 必填 类型 示例值 描述
openid string(64) 1231231 需要查询的用户openid
card_id string(32) pFS7Fjg8kV1IdDz01xxxxx 卡券ID。不填写时默认查询当前appid下的卡券。

返回数据

数据示例:

 {
"errcode":0,
"errmsg":"ok",
"card_list": [
      {"code": "xxx1434079154", "card_id": "xxxxxxxxxx"},
      {"code": "xxx1434079155", "card_id": "xxxxxxxxxx"}
      ]
}
参数名 描述
errcode 错误码
errmsg 错误信息
card_list 卡券列表

拉取会员信息(积分查询)接口

接口说明

支持开发者根据CardID和Code查询会员信息

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
   "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",
   "code": "916679873278"
}
参数名 是否必填 说明
cardid 查询会员卡的cardid
code 所查询用户领取到的code值

返回数据

{
 "errcode": 0,
 "errmsg": "ok",
 "openid": "obLatjjwDolFjRRd3doGIdwNqRXw",
 "nickname": "Fourier",
 "membership_number": "316510891298",
 "bonus": 460,
 "sex": "MALE",
 "user_info": {
   "common_field_list": [
     {
       "name": "USER_FORM_INFO_FLAG_MOBILE",
       "value": "15521328888"
     },
     {
       "name": "USER_FORM_INFO_FLAG_NAME",
       "value": "微信"
     }
   ],
   "custom_field_list": []
 },
 "user_card_status": "NORMAL"
}
参数名 说明
errcode 错误码,0为正常
errmsg 错误信息
openid 用户在本公众号内唯一识别码
nickname 用户昵称
bonus 积分信息
balance 余额信息
sex 用户性别
user_info 会员信息
custom_field_list 开发者设置的会员卡会员信息类目,如等级。
name 会员信息类目名称
value 会员卡信息类目值,比如等级值等
user_card_status 当前用户会员卡状态,NORMAL 正常 EXPIRE 已过期 GIFTING 转赠中 GIFT_SUCC 转赠成功 GIFT_TIMEOUT 转赠超时 DELETE 已删除,UNAVAILABLE 已失效

查看卡券详情

调用该接口可查询卡券字段详情及卡券所处状态。建议开发者调用卡券更新信息接口后调用该接口验证是否更新成功。

开发者注意事项

1.对于部分有特殊权限的商家,查询卡券详情得到的返回可能含特殊接口的字段。

2.由于卡券字段会持续更新,实际返回字段包含但不限于文档中的字段,建议开发者开发时对于不理解的字段不做处理,以免出错。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/get?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
  "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
参数名 必填 类型 示例值 描述
cardid string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。

返回数据

数据示例:

{
   "errcode": 0,
   "errmsg": "ok",
   "card": {
       "card_type":  "GROUPON",
           "groupon": {
           "base_info": {
               "status": 1,
               "id": "p1Pj9jr90_SQRaVqYI239Ka1erkI",
               "logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
               "appid": "wx588def6b0089dd48",
               "code_type": "CODE_TYPE_TEXT",
               "brand_name": "海底捞",
               "title": "132元双人火锅套餐",
               "sub_title": "",
               "date_info": {
                   "type": 1,
                   "begin_timestamp": 1397577600,
                   "end_timestamp": 1399910400
               },
               "color": "#3373bb",
               "notice": "使用时向服务员出示此券",
               "service_phone": "020-88888888",
               "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食\n餐前不可打包,餐后未吃完,可打包\n本团购券不限人数,建议2人使用,超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料",
               "use_limit": 1,
               "get_limit": 3,
               "can_share": true,
               "location_id_list" : [123, 12321, 345345]
               "custom_url_name": "立即使用",
               "custom_url": "http://www.qq.com",
               "custom_url_sub_title": "6个汉字tips",
               "promotion_url_name": "更多优惠",
               "promotion_url": "http://www.qq.com",
               "source": "大众点评"   
               "sku": {
                   "quantity": 0
                   "total_quantity":1000
               }
           },
           "deal_detail": "以下锅底2选1(有菌王锅、麻辣锅、大骨锅、番茄锅、清补凉锅、酸菜鱼锅可选):\n大锅1份 12元\n小锅2份 16元\n以下菜品2选1\n特级肥牛1份 30元\n洞庭鮰鱼卷1份 20元\n其他\n鲜菇猪肉滑1份 18元\n金针菇1份 16元\n黑木耳1份 9元\n娃娃菜1份 8元\n冬瓜1份 6元\n火锅面2个 6元\n欢乐畅饮2位 12元\n自助酱料2位 10元",
       }
参数名 描述
card_type 卡券类型。

团购券:GROUPON; 折扣券:DISCOUNT; 礼品券:GIFT; 代金券:CASH; 通用券:GENERAL_COUPON; 会员卡:MEMBER_CARD; 景点门票:SCENIC_TICKET; 电影票:MOVIE_TICKET; 飞机票:BOARDING_PASS; 会议门票:MEETING_TICKET; 汽车票:BUS_TICKET;

base_info 基本的卡券数据,见下表,所有卡券通用。
deal_detail 团购券专用字段,团购详情。
gift 礼品券专用,表示礼品名字。
least_cost least_cost字段为代金券专用,表示起用金额(单位为分)。
reduce_cost 代金券专用,表示减免金额(单位为分)
discount 折扣券专用字段,表示打折额度(百分比),例:填30为七折团购详情。
supply_balance 会员卡专属字段,表示是否支持积分,填写true或false,如填写true,积分相关字段均为必填。
supply_bonus 会员卡专属字段,表示否支持储值,填写true或false,如填写true,储值相关字段均为必填。
bonus_cleared 积分清零规则。
bonus_rules 积分规则。
balance_rules 储值规则。
prerogative 会员卡专属字段,表示特权说明。
bind_old_card_url 绑定旧卡的url。
activate_url 激活会员卡。
need_push_on_view 进入会员卡时是否推送事件,填写true或false。
bonus_rule 积分规则。用于微信买单功能
cost_money_unit 消费金额。以分为单位。
increase_bonus 对应增加的积分。
max_increase_bonus 积分上限。
init_increase_bonus 初始设置积分。
discount 折扣,该会员卡享受的折扣优惠。
from 飞机票的起点,上限为18个汉字。
to 飞机票的终点,上限为18个汉字。
flight 航班。
departure_time 起飞时间。(Unix时间戳格式)
landing_time 降落时间。(Unix时间戳格式)
check_in_url 在线值机的链接。
gate 登机口。如发生登机口变更,建议商家实时调用该接口变更。
boarding_time 登机时间,只显示“时分”不显示日期。(Unix时间戳格式)
meeting_detail 会议详情。
map_url 会场导览图。

base_info字段:

参数名 描述
logo_url 卡券的商户logo,建议像素为300*300。
code_type "CODE_TYPE_TEXT",文本;"CODE_TYPE_BARCODE",一维码 ;"CODE_TYPE_QRCODE",二维码;"CODE_TYPE_ONLY_QRCODE",二维码无code显示;"CODE_TYPE_ONLY_BARCODE",一维码无code显示;
brand_name 商户名字(填写直接提供服务的商户名,第三方商户名填写在source字段)。
title 卡券名。
sub_title 卡券名的副标题。
color 卡券的背景颜色。
notice 使用提醒,字数上限为16个汉字。
description 使用说明。长文本描述。
date_info 使用日期,有效期的信息。
type 使用时间的类型。DATE_TYPE_FIX_TIME_RANGE 表示固定日期区间,DATE_TYPE_FIX_TERM表示固定时长(自领取后按天算),DATE_TYPE_PERMANENT 表示永久有效(会员卡专用时间类型)。
begin_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示起用时间。从1970年1月1日00:00:00至起用时间的秒数,最终需转换为字符串形态传入,下同。(单位为秒)
end_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示结束时间。(单位为秒)
fixed_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天内有效,领取后当天有效填写0。(单位为天)
fixed_begin_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天开始生效。(单位为天)
sku 商品信息
quantity 卡券现有库存的数量。
total_quantity 卡券全部库存的数量。
location_id_list 门店位置ID。
use_custom_code 是否自定义Code码。填写true或false,默认为false。
bind_openid 是否指定用户领取,填写true或false。默认为否。
can_share 卡券是否可转赠,填写true或false,true代表可转赠。默认为true。
service_phone 客服电话。
source 第三方来源名,例如同程旅游、大众点评。
custom_url_name 商户自定义入口名称。
custom_url 商户自定义入口跳转外链的地址链接,跳转页面内容需与自定义cell名称保持匹配。
custom_url_sub_title 显示在入口右侧的tips,长度限制在6个汉字内。
promotion_url_name 营销场景的自定义入口。
promotion_url 入口跳转外链的地址链接。
promotion_url_sub_title 显示在营销入口右侧的提示语。
custom_url_name 商户自定义入口名称。
status “CARD_STATUS_NOT_VERIFY”,待审核;“CARD_STATUS_VERIFY_FAIL”,审核失败;“CARD_STATUS_VERIFY_OK”,通过审核;“CARD_STATUS_DELETE”,卡券被用户删除;“CARD_STATUS_USER_DISPATCH”,在公众平台投放过的卡券

批量查询卡列表

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/batchget?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
  "offset": 0,
  "count": 10, 
  "status_list": ["CARD_STATUS_VERIFY_OK", "CARD_STATUS_DISPATCH"]
}
参数名 必填 类型 示例值 描述
offset int 0 查询卡列表的起始偏移量,从0开始,即offset: 5是指从从列表里的第六个开始读取。
count int 10 需要查询的卡片的数量(数量最大50)。
status_list int CARD_STATUS_VERIFY_OK 支持开发者拉出指定状态的卡券列表,例:仅拉出通过审核的卡券。

返回数据

数据示例:

{
  "errcode":0,
  "errmsg":"ok",
  "card_id_list":["ph_gmt7cUVrlRk8swPwx7aDyF-pg"],
  "total_num":1
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。
card_id_list 卡券ID列表。
total_num 该商户名下卡券ID总数。


更改卡券信息接口

接口说明

支持更新所有卡券类型的部分通用字段及特殊卡券(会员卡、飞机票、电影票、会议门票)中特定字段的信息。

开发者注意事项注

1. 更改卡券的部分字段后会重新提交审核,详情见字段说明,更新成功后可通过调用查看卡券详情接口核查更新结果;

2. 仅填入需要更新的字段,许多开发者在调用该接口时会填入brandname等不支持修改的字段,导致更新不成功。

3. 调用该接口后更改卡券信息后,请务必调用查看卡券详情接口验证是否已成功更改。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/update?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
       "card_id":"ph_gmt7cUVrlRk8swPwx7aDyF-pg",
       "member_card": {        //填写该cardid相应的卡券类型(小写)。
               "base_info": {
                   "logo_url": "http:\/\/www.supadmin.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
                   "color": "Color010",
                   "notice": "使用时向服务员出示此券",
                   "service_phone": "020-88888888",
                   "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食\n餐前不可打包,餐后未吃完,可打包\n本团购券不限人数,建议2人使用,超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料"
                   "location_id_list" : [123, 12321, 345345]
               },
                  "bonus_cleared": "aaaaaaaaaaaaaa",
                  "bonus_rules": "aaaaaaaaaaaaaa",
                  "prerogative": "",
                  "auto_activate" : true,//也可以填写wx_activate
                  "activate_url":""
       }
}


支持修改字段: base_info字段:

参数名 是否提审 类型 示例值 描述
logo_url string(128) http://mmbiz.qpic.cn/ 卡券的商户logo,建议像素为300*300。
notice string(48) 请出示二维码核销卡券。 使用提醒,字数上限为16个汉字。
description string(3072) 不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食。 使用说明。
service_phone string(24) 40012234 客服电话。
color string(3072) Color010 卡券颜色。
location_id_list string(3072) 1234,2314 支持更新适用门店列表。
custom_url_name string(16) 立即使用 自定义跳转入口的名字。
custom_url string(128) "xxxx.com"。 自定义跳转的URL。
custom_url_sub_title string(18) 更多惊喜 显示在入口右侧的提示语。
promotion_url_name string(16) 产品介绍。 营销场景的自定义入口名称。
promotion_url string(128) XXXX.com; 入口跳转外链的地址链接。
promotion_url_sub_title string(18) 卖场大优惠。 显示在营销入口右侧的提示语。
code_type string(16) CODE_TYPE_TEXT。 Code码展示类型,"CODE_TYPE_TEXT",文本;"CODE_TYPE_BARCODE",一维码 ;"CODE_TYPE_QRCODE",二维码;"CODE_TYPE_ONLY_QRCODE",二维码无code显示;"CODE_TYPE_ONLY_BARCODE",一维码无code显示;
get_limit int 1 每人可领券的数量限制。
can_share bool false 卡券原生领取页面是否可分享。
can_give_friend bool false 卡券是否可转赠。
date_info Json结构 见上述示例 使用日期,有效期的信息,有效期时间修改仅支持有效区间的扩大。
type int 1 有效期类型,仅支持更改type为1的时间戳,不支持填入2。
begin_timestamp unsigned int 14300000 固定日期区间专用,表示起用时间。(单位为秒)
end_timestamp unsigned int 15300000 固定日期区间专用,表示结束时间。结束时间仅支持往后延长。

会员卡专属字段修改:

特别注意,以下支持更新的字段不在基本信息base_info的结构中。

参数名 是否提审 类型 示例值 描述
bonus_cleared string(3072) 每年12月30号积分清0。 积分清零规则。
bonus_rules string(3072) 每消费1元增加1积分。 积分规则。
balance_rules string(3072) 支持在线充入余额。 储值说明。
prerogative string(3072) XX会员可享有全场商品8折优惠。 特权说明。
wx_activate bool true 是否开通一键开卡,设置为true时用户领取会员卡点击激活进入原生激活页面,若填入之前设置了activate_url,则更新时须将activate_url传空值,并设置开卡项详情见一键开卡
auto_activate bool true 是否开通自动激活,设置为true时用户领取会员卡自动设置为激活,详情见自动激活
custom_field1 Json结构 创建会员卡示例 自定义会员信息类目,会员卡激活后显示。
custom_field2 Json结构 创建会员卡示例 自定义会员信息类目,会员卡激活后显示。
custom_field3 Json结构 创建会员卡示例 自定义会员信息类目,会员卡激活后显示。
name_type string(24) FIELD_NAME_TYPE_LEVEL 会员信息类目名称。FIELD_NAME_TYPE_LEVEL等级;FIELD_NAME_TYPE_COUPON优惠券;FIELD_NAME_TYPE_STAMP印花;FIELD_NAME_TYPE_DISCOUNT折扣;FIELD_NAME_TYPE_ACHIEVEMEN成就;FIELD_NAME_TYPE_MILEAGE里程。
url string(128) xxx.com 点击类目跳转外链url
custom_cell1 Json结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
bonus_rule json结构 见上述示例 积分规则。用于微信买单功能
cost_money_unit int 100 消费金额。以分为单位。
increase_bonus int 100 对应增加的积分。
max_increase_bonus int 10000 单次获取的积分上限。
init_increase_bonus int 10 初始设置积分。
cost_bonus_unit int 10 每使用5积分。
reduce_money int 10 抵扣xx元,(这里以分为单位)
least_money_to_use_bonus int 100 抵扣条件,满xx元(这里以分为单位)可用。
max_reduce_bonus int 10 抵扣条件,单笔最多使用xx积分。
discount int 10 折扣,该会员卡享受的折扣优惠。

返回数据说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok",
  "send_check":true
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。
send_check 此次更新是否需要提审,true为需要,false为不需要。

修改库存接口

调用修改库存接口增减某张卡券的库存。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/modifystock?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"increase_stock_value": 1231231,
"reduce_stock_value": 1231231
}
参数名 必填 类型 示例值 描述
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。
increase_stock_value int 1231231 增加多少库存,支持不填或填0。
reduce_stock_value int 1231231 减少多少库存,可以不填或填0。

返回数据

数据示例:

 {
"errcode":0,
"errmsg":"ok"
}
参数名 描述
errcode 错误码
errmsg 错误信息


设置跟随推荐

功能介绍

支持开发者在积分变动消息底部,配置卡券或设置跳转外链URL,具体形式如下图,可以是URL也可以是一张卡券。

跟随推荐.png

开发者注意事项

一、支持两种类型的跟随推荐配置

1. Wording+URL,支持商户配置16个汉字长度的文案,及点击跳转的链接。

2. 推荐卡券,支持商户配置一个本公众号下的卡券。

二、推荐位有效期控制

1. Wording+URL类型,支持商户根据活动期限自定义展示时间。

2. 推荐卡券类型,由微信后台判断卡券的有效性,当卡券已过期、已被领完、已被置为失效会自动下架展示。

三、配置规则 支持商户针对指定cardid的不同消息类型配置不同的推荐位内容。(前期仅以会员卡积分变动、卡券核销消息试点)


设置跟随推荐接口

接口说明

调用更新卡券信息接口将增推荐位字段 update到已成功通过审核的卡券。 同时支持在创建卡券时填入相应字段。


接口详情

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/update?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据

使用消息配置卡券

{
  "card_id":"ph_gmt7cUVrlRk8swPwx7aDyF-pg",
   "member_card":{
          "modify_msg_operation":{
             "card_cell":{
                "end_time":1452724561,
                "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
         }  
       }
     }
   }
 


使用消息配置URL

{
  "card_id":"ph_gmt7cUVrlRk8swPwx7aDyF-pg",
   "member_card":{
          "modify_msg_operation":{
             "url_cell":{
                "end_time":1452724561,
                "text":"更多优惠",
                "url":"www.qq.com"
         }  
       }
     }
   }
 

字段说明

字段名 说明
card_id 卡券ID。
modify_msg_operation 积分余额变动消息类型
card_cell 卡券类型的推荐位。Json结构参考示例。
url_cell 链接类型的推荐位。Json结构参考示例。
card_id 需要在运营位投放的卡券id
end_time 推荐位展示的截止时间。
text 文本内容。
url 跳转链接。



返回数据

{
   "errcode":0,
   "errmsg":"ok"
 }


字段说明

字段名 说明
错误码 错误码,0为正常;43008为商户没有开通微信支付权限;
errmsg 错误信息

设置微信买单接口

微信卡券买单功能是微信卡券的一项新的能力,可以方便消费者买单时,直接录入消费金额,自动使用领到的优惠(券或卡)抵扣,并拉起微信支付快速完成付款。支持开发者将会员卡设置为支持买单功能的会员卡。

微信买单(以下统称微信买单)的好处:

1、无需商户具备微信支付开发能力,即可完成订单生成,与微信支付打通。

2、可以通过手机公众号、电脑商户后台,轻松操作收款并查看核销记录,交易对账,并支持离线下载。

3、支持会员营销,二次营销,如会员卡交易送积分,抵扣积分,买单后赠券等。


开通指引

步骤一:申请开通内测白名单权限后,开发者可以登录微信公众平台mp.weixin.qq.com,进入【卡券功能】-【卡券概况】,点击查看资料和权限

步骤二:在高级权限区,有标注微信买单的权限状态,商户先需要开通微信支付,并为收款门店配置收款员,才能激活申请权限。未获得权限时,点击“申请“,开通买单权限

步骤三:为收款门店配置收款员“或直接点击”卡券核销“,可前往添加门店核销员,便于后续接收结算通知。


设置买单接口

买单接口说明 创建卡券之后,开发者可以通过设置微信买单接口设置该card_id支持微信买单功能。值得开发者注意的是,设置买单的card_id必须已经配置了门店,否则会报错。 接口详情

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/paycell/set?access_token=TOKEN

参数说明

参数 是否必须 说明
access_token 调用接口凭证
POST数据 Json数据

POST数据

{
  “card_id”:“ph_gmt7cUVrlRk8swPwx7aDyF-pg“,
  “is_open”: true
}

字段说明

字段名 说明
cardid 卡券ID。
is_open 是否开启买单功能,填true/false

返回数据

 {
   "errcode":0,
   "errmsg":"ok"
 }

字段说明

字段名 说明
错误码 错误码,0为正常;43008为商户没有开通微信支付权限或者没有在商户后台申请微信买单功能;
errmsg 错误信息


买单事件推送

微信买单完成时,微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例:

<xml>
<ToUserName><![CDATA[gh_e2243xxxxxxx]]></ToUserName>
<FromUserName><![CDATA[oo2VNuOUuZGMxxxxxxxx]]></FromUserName>
<CreateTime>1442390947</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[user_pay_from_pay_cell]]></Event>
<CardId><![CDATA[po2VNuCuRo-8sxxxxxxxxxxx]]></CardId>
<UserCardCode><![CDATA[38050000000]]></UserCardCode>
<TransId><![CDATA[10022403432015000000000]]></TransId>
<LocationId>291710000</LocationId>
<Fee><![CDATA[10000]]></Fee>
<OriginalFee><![CDATA[10000]]> </OriginalFee>
</xml>
参数 说明
ToUserName 开发者微信号。
FromUserName 发送方帐号(一个OpenID)。
CreateTime 消息创建时间 (整型)。
MsgType 消息类型,event。
Event 事件类型,User_pay_from_pay_cell(微信买单事件)
CardId 卡券ID。
UserCardCode 卡券Code码。
TransId 微信支付交易订单号(只有使用买单功能核销的卡券才会出现)
LocationName 门店名称,当前卡券核销的门店名称(只有通过卡券商户助手和买单核销时才会出现)
Fee 实付金额,单位为分
OriginalFee 应付金额,单位为分

删除卡券

删除卡券接口允许商户删除任意一类卡券。删除卡券后,该卡券对应已生成的领取用二维码、添加到卡包JS-SDK均会失效。 注意:如用户在商家删除卡券前已领取一张或多张该卡券依旧有效。即删除卡券不能删除已被用户领取,保存在微信客户端中的卡券。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/delete?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
   "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
参数名 必填 类型 示例值 描述
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。

返回数据

数据示例:

 {
"errcode":0,
"errmsg":"ok"
}
参数名 描述
errcode 错误码
errmsg 错误信息


设置卡券失效接口

为满足改票、退款等异常情况,可调用卡券失效接口将用户的卡券设置为失效状态。 注:设置卡券失效的操作不可逆,即无法将设置为失效的卡券调回有效状态,商家须慎重调用该接口。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/card/code/unavailable?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

非自定义卡券的请求
{
  "code": "12312313"
}
或自定义code卡券的请求。
{
  "code": "12312313",
  "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
参数名 必填 类型 示例值 描述
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。
code string(20) 1231231 设置失效的Code码。

返回数据

数据示例:

 {
"errcode":0,
"errmsg":"ok",
}
参数名 描述
errcode 错误码
errmsg 错误信息

统计会员卡数据

拉取会员卡数据接口

接口简介及开发者注意事项

为支持开发者调用API查看卡券相关数据,微信卡券团队封装数据接口并面向具备卡券功能权限的开发者开放使用。开发者调用该接口可获取本商户下的所有卡券相关的总数据以及指定卡券的相关数据。开发过程请务必注意以下事项:

1.查询时间区间需<=62天,否则报错{errcode: 61501,errmsg: "date range error"};

2.传入时间格式需严格参照示例填写”2015-06-15”,否则报错{errcode":61500,"errmsg":"date format error"};

3.需在获取卡券相关数据前区分卡券创建渠道:公众平台创建、调用卡券接口创建。

接口说明

支持开发者调用该接口拉取公众平台创建的会员卡相关数据。


接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/datacube/getcardmembercardinfo?access_token=ACCESS_TOKEN

参数说明

参数 是否必须 说明
POST数据 Json数据
access_token 调用接口凭证

POST数据

{
 "begin_date":"2015-06-15",
 "end_date":"2015-06-30",
 "cond_source": 0
}

参数说明:

字段 说明 是否必填 类型 示例值
begin_date 查询数据的起始时间。 string(16) 2015-06-15
end_date 查询数据的截至时间。 string(16) 2015-06-30
cond_source 卡券来源,0为公众平台创建的卡券数据、1是API创建的卡券数据 unsigned int 0

返回数据说明

{
   "list": [
       {
           "ref_date": "2015-06-23",
           "view_cnt": 0,
              "view_user": 0,
              "receive_cnt": 0,
              "receive_user": 0,
              "active_user": 0,
              "verify_cnt": 0,
              "verify_user": 0,
              "total_user": 86,
              "total_receive_user": 95
   ]
}

字段说明:

字段 说明
ref_date 日期信息
view_cnt 浏览次数
view_user 浏览人数
receive_cnt 领取次数
receive_user 领取人数
verify_cnt 使用次数
verify_user 使用人数
active_user 激活人数
total_user 有效会员总人数
total_receive_user 历史领取会员卡总人数