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

管理卡券

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

目录

更新日志

版本号 更新内容 更新时间
V1.0 优化查询code接口,返回信息中增加can_consume字段,告知开发者该卡券是否可以被核销,同时可以支持返回code状态的查询方式。 2015-8-31
V1.1 新增拉取卡券数据接口 2015-9-7

查询Code接口

查询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代表一类卡券。自定义code卡券必填。
check_consume bool true 是否校验code核销状态,填入true和false时的code异常状态返回数据不同。


当check_consume为true时返回数据

卡券状态正常:

 {
"errcode":0,
"errmsg":"ok",
"card":{
"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"begin_time": 1404205036,
"end_time": 1404205036
 },
"openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"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",
   "card": {
       "card_id": "p3CHashpj08qLVPODu-F6_S-Eol4",
       "begin_time": 1446134400,
       "end_time": 1448899199
   },
   "openid": "o3CHasuz0eVxVAbl8JwHiOI0WCwM",
   "can_consume": true,
   "user_card_status": "NORMAL"
  }

卡券状态异常:

 {
"errcode":0,
"errmsg":"ok",
"card":{
"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"begin_time": 1404205036,
"end_time": 1404205036,
 },
"openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"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_SUCC 转赠成功 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 卡券列表

查看卡券详情

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

开发者注意事项

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

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

接口调用请求说明

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

参数说明

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

POST数据

{
  "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
参数名 必填 类型 示例值 描述
card_id 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_TYPE_FIX_TIME_RANGE",
               "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
                   "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。
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 卡券全部库存的数量,上限为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_FAIL”,审核失败;“CARD_STATUS_VERIFY_OK”,通过审核;“CARD_STATUS_DELETE”,卡券被商户删除;“CARD_STATUS_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 string 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": ""
       }
}


通用字段修改:

参数名 是否提审 类型 示例值 描述
base_info - Json接口 见上述示例 卡券基础信息字段。
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 支持更新适用门店列表。
center_title string(18) 快速使用 顶部居中的自定义cell。
center_sub_title string(24) 点击快速核销卡券 顶部居中的自定义cell说明。
center_url string(128) www.xxx.com 顶部居中的自定义cell的跳转链接。
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 string DATE_TYPE_FIX_TIME_RANGE 有效期类型,仅支持更改type为DATE_TYPE_FIX_TIME_RANGE 的时间戳,不支持填入DATE_TYPE_FIX_TERM。
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折优惠。 特权说明。
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结构 见上述示例。 自定义会员信息类目,会员卡激活后显示。
detail string(3072) 电影名:复仇者联盟2。/n放映时间:2015年5月12日23:00。/n票类型:3D。 电影票详情。
departure_time unsigned int 1431271351 起飞时间。
landing_time unsigned int 1441271351 降落时间。
gate string(12) 3号 登机口。如发生登机口变更,建议商家实时调用该接口变更。
boarding_time unsigned int 1431271351 登机时间,只显示“时分”不显示日期,按Unix时间戳格式填写。如发生登机时间变更,建议商家实时调用该接口变更。
guide_url string(128) 景区门票的导览图URL。
map_url string(128) xxx.com。 会场导览图。

返回数据说明

数据示例:

{
   "errcode":0,
   "errmsg":"ok",
   "send_check":false
}
参数名 描述
errcode 错误码,0为正常。
errmsg 错误信息。
send_check 是否提交审核,false为修改后不会重新提审,true为修改字段后重新提审,该卡券的状态变为审核中。

设置微信买单接口

支持开发者调用此接口将已有卡券更新为支持微信买单。

值得注意的是,在调用买单接口之前,请开发者务必确认是否已经开通了微信支付以及对相应的cardid设置了门店,否则会报错

接口详情

接口调用请求说明

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 错误信息

修改库存接口

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

接口调用请求说明

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 错误信息

更改Code接口

为确保转赠后的安全性,微信允许自定义Code的商户对已下发的code进行更改。 注:为避免用户疑惑,建议仅在发生转赠行为后(发生转赠后,微信会通过事件推送的方式告知商户被转赠的卡券Code)对用户的Code进行更改。

接口调用请求说明

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

参数说明

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

POST数据

{
  "code": "12345678",
  "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
  "new_code": "3495739475"
}
参数名 必填 类型 示例值 描述
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。自定义Code码卡券为必填。
code string(16) 110201201245 需变更的Code码。
new_code string(64) 1231231 变更后的有效Code码。

返回数据

数据示例:

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

删除卡券接口

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

接口调用请求说明

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. 需在获取卡券相关数据前区分卡券创建渠道:公众平台创建、调用卡券接口创建。

拉取卡券概况数据接口

接口说明

支持调用该接口拉取本商户的总体数据情况,包括时间区间内的各指标总量。

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

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


接口调用请求说明

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

请求参数说明

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

POST数据

{
 "begin_date":"2015-06-15",  //请开发者按示例格式填写日期,否则会报错date format error
 "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": 1,
           "view_user": 1,
           "receive_cnt": 1,
           "receive_user": 1,
           "verify_cnt": 0,
           "verify_user": 0,
           "given_cnt": 0,
           "given_user": 0,
           "expire_cnt": 0,
           "expire_user": 0
       }
   ] 
}


字段说明:

字段 说明
ref_date 日期信息
view_cnt 浏览次数
view_user 浏览人数
receive_cnt 领取次数
receive_user 领取人数
verify_cnt 使用次数
verify_user 使用人数
given_cnt 转赠次数
given_user 转赠人数
expire_cnt 过期次数
expire_user 过期人数

获取免费券数据接口

接口说明

支持开发者调用该接口拉取免费券(优惠券、团购券、折扣券、礼品券)在固定时间区间内的相关数据。

特别注意:

1. 该接口目前仅支持拉取免费券(优惠券、团购券、折扣券、礼品券)的卡券相关数据,暂不支持特殊票券(电影票、会议门票、景区门票、飞机票)数据。

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

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

接口调用请求说明

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

请求参数说明

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

POST数据

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


参数说明:

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


返回数据说明 数据示例:

{
    "list": [
       {
           "ref_date": "2015-06-23",
           "card_id": "po8pktyDLmakNY2fn2VyhkiEPqGE",
           "card_type":3,
           "view_cnt": 1,
           "view_user": 1,
           "receive_cnt": 1,
           "receive_user": 1,
           "verify_cnt": 0,
           "verify_user": 0,
           "given_cnt": 0,
           "given_user": 0,
           "expire_cnt": 0,
           "expire_user": 0
       }
   ]
}


字段说明:

字段 说明
ref_date 日期信息
card_id 卡券ID
card_type cardtype:0:折扣券,1:代金券,2:礼品券,3:优惠券,4:团购券(暂不支持拉取特殊票券类型数据,电影票、飞机票、会议门票、景区门票)
view_cnt 浏览次数
view_user 浏览人数
receive_cnt 领取次数
receive_user 领取人数
verify_cnt 使用次数
verify_user 使用人数
given_cnt 转赠次数
given_user 转赠人数
expire_cnt 过期次数
expire_user 过期人数

拉取会员卡数据接口

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

为支持开发者调用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 历史领取会员卡总人数