管理卡券
mmbiz.qpic.cn/
卡券的商户logo，建议像素为300*300。
notice
是
string（48）
请出示二维码核销卡券。
使用提醒，字数上限为16个汉字。
description
是
string（3072）
不可与其他优惠同享
使用说明。
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
支持更新适用门店列表
，清空门店更新时传“0”
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_FI
X_TIME_RANGE
有效期类型，仅支持更改type为DATE_TYPE_FIX_TIME_RANGE 的时间戳，不支持填入DATE_TYPE_FIX_TERM。
begin_timestamp
否
unsigned int
14300000
固定日期区间专用，表示起用时间。（单位为秒）
end_timestamp
否
unsigned int
15300000
固定日期区间专用，表示结束时间。结束时间仅支持往后延长。
支持更新适用门店列表
，清空门店更新时传“0”
promotion_url
_sub_title
CODE_TYPE
_TEXT
Code码展示类型，
"CODE_TYPE_TEXT"
文本；
"CODE_TYPE_BARCODE"，
一维码 ；"CODE_TYPE_QRCODE"，
二位码；"CODE_TYPE_ONLY_
QRCODE",二维码无code显示；
"CODE_TYPE_ONLY_BARCODE",一维码无code显示；
DATE_TYPE_FI
X_TIME_RANGE
不同类型卡券专属字段修改：
特别注意，以下支持更新的字段不在基本信息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) | www.qq.com | 景区门票的导览图URL。 |
| map_url | 否 | string(128) | xxx.com。 | 会场导览图。 |
返回数据说明
{
"errcode":0,
"errmsg":"ok",
"send_check":false
}
| 参数名 | 描述 |
|---|---|
| errcode | 错误码，0为正常。 |
| errmsg | 错误信息。 |
| send_check | 是否提交审核，false为修改后不会重新提审，true为修改字段后重新提审，该卡券的状态变为审核中。 |
开发者注意事项注
1. 请开发者注意需要重新提审的字段，开发者调用更新接口时，若传入了提审字段则卡券需要重新进入审核状态；
2. 接口更新方式为覆盖更新：即开发者只需传入需要更改的字段，其他字段无需填入，否则可能导致卡券重新提审；
3. 若开发者置空某些字段，可直接在更新时传“”（空）；
4. 调用该接口后更改卡券信息后，请务必调用查看卡券详情接口验证是否已成功更改，
5.未列出的字段不支持修改更新。
《微信运营处罚规则》进行处罚。
统计卡券数据
为支持开发者调用API查看卡券相关数据，微信卡券团队封装数据接口并面向具备卡券功能权限的开发者开放使用。
开发者调用该接口可获取本商户下的所有卡券相关的总数据以及指定卡券的相关数据。
拉取卡券概况数据接口
接口说明
支持调用该接口拉取本商户的总体数据情况，包括时间区间内的各指标总量。
接口调用请求说明
HTTP请求方式: POST
URL: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. 查询时间区间需<=62天，否则报错{errcode: 61501，errmsg: "date range error"}；
2. 传入时间格式需严格参照示例填写”2015-06-15”，否则报错{errcode":61500,"errmsg":"date format error"}
3. 该接口只能拉取非当天的数据，不能拉取当天的卡券数据，否则报错。
获取免费券数据接口
接口说明
支持开发者调用该接口拉取免费券（优惠券、团购券、折扣券、礼品券）在固定时间区间内的相关数据。
接口调用请求说明
http请求方式: POSThttps://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
过期人数
特别注意：
1. 该接口目前仅支持拉取免费券（优惠券、团购券、折扣券、礼品券）的卡券相关数据，暂不支持特殊票券（电影票、会议门票、景区门票、飞机票）数据。
2. 查询时间区间需<=62天，否则报错{"errcode:" 61501，errmsg: "date range error"}；
3. 传入时间格式需严格参照示例填写如”2015-06-15”，否则报错｛"errcode":"date format error"｝
4. 该接口只能拉取非当天的数据，不能拉取当天的卡券数据，否则报错。
拉取会员卡概况数据接口
接口说明
支持开发者调用该接口拉取公众平台创建的会员卡相关数据。
接口调用请求说明
HTTP请求方式: POST
URL: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
历史领取会员卡总人数
拉取单张会员卡数据接口
接口说明
支持开发者调用该接口拉取API创建的会员卡数据情况
接口调用请求说明
HTTP请求方式: POST
URL:https://api.weixin.qq.com/datacube/getcardmembercarddetail?access_token=ACCESS_TOKEN
参数说明
参数
是否必须
说明
POST数据
是
Json数据
access_token
是
调用接口凭证
POST数据
｛
"begin_date":"2015-06-15",
"end_date":"2015-06-30",
"card_id":"xxxxxxxxxxxxxxxx"
｝
参数说明：
字段
说明
是否必填
类型
示例值
begin_date
查询数据的起始时间。
是
string(16)
2015-06-15
end_date
查询数据的截至时间。
是
string(16)
2015-06-30
card_id
卡券id
是
string(32)
p4WkzwieuDBzzn7Jed6SBO0-ZgaU
返回数据说明 ：
{
"list": [
{
"ref_date": "2016-07-06",
"merchanttype": 2,
"cardid": "p4WkzwieuDBzzn7Jed6SBO0-ZgaU",
"submerchantid": 0,
"view_cnt": 2,
"view_user": 1,
"receive_cnt": 1,
"receive_user": 1,
"verify_cnt": 0,
"verify_user": 0,
"active_cnt": 1,
"active_user": 1,
"total_user": 249,
"new_user": 0,
"payOriginalFee": 0,
"fee": 0
}
]
}
字段说明：
字段
说明
ref_date
日期信息
merchanttype
子商户类型
submerchantid
子商户ID
view_cnt
浏览次数
view_user
浏览人数
receive_cnt
领取次数
receive_user
领取人数
verify_cnt
使用次数
verify_user
使用人数
active_user
激活人数
total_user
有效会员总人数
total_receive_user
历史领取会员卡总人数
new_user
新用户数
payOriginalFee
应收金额（仅限使用快速买单的会员卡）
fee
实收金额（仅限使用快速买单的会员卡）
参数说明：
卡券来源，0为公众平台创建的卡券数据
、1是API创建的卡券数据
字段说明：
1：代金券，2：礼品券，3：优惠券，4：团购券（暂不支持拉取特殊票券类型数据，电影票、飞机票、会议门票、景区门票）
接口调用请求说明
接口调用请求说明
p4WkzwieuDBzzn7Jed6SBO0-ZgaU