更新日志
版本号 | 更新内容 | 更新时间 |
---|---|---|
V1.8 | 普通券支持图文详情,对齐朋友的券; | 2015-2-16 |
V1.9 |
普通券支持使用条件字段,开发者创建卡券时须注意使用条件字段,商户填入对应字段 时,系统将在卡面拼出使用的条件;若不填写时,将拼接“无最低消费限制,全场通用,不限品类” 并在使用条件中拼写“可与其他优惠共享”,详情请见:普通券支持使用条件的通知 |
2016-5-26 |
V2.0 | 创建/更新卡券支持设置卡券支持“全部门店”字段,商户门店变更自动同步到卡券上 | 2016-6-27 |
1 更新通知
2016年5月15日起,微信卡券团队对会员卡能力进行全面升级。在原有能力基础上进行以下能力升级,旨在帮助商家更好地进行会员管理。
-强化客户端一级入口:会员到店即用,快速定位商户会员卡;
-自定义卡面能力:开发者可以根据会员身份设置不同的卡面背景;
-门店扫码方案:新用户到店扫码领卡,老用户到店扫码快速打开会员卡,实现会员点餐、买单等多种功能
-支付即会员:支持开发者设置微信支付后为用户下发领卡消息,顾客支付即会员,快速拉新;
-运营策略调整:会员卡新增开放类目限制,自4月20日起,仅限会员卡类目内的商户新建会员卡,原有会员卡不受影响,详情请见:《会员卡公告》
导入自定义code接口将非定义code导入到微信服务器,若仅在h5投放则无须导入,导入code后code由微信随机下发,不可指定。
卡券事件通知。
2. 调用查询Code接口获取该Code码的状态(是否被领取、核销、删除),若Code码被用户领取且处于有效状态,可获取领券人OpenID。
3. 从卡券详情页跳转外部链接时,微信后台会自动带上卡券ID、Code码等信息,详情见跳转外链带参数说明。
4. 在卡券投放接口中加入场景字段outer_str,该字段值会在用户领取时伴随事件通知商户。
例如:创建二维码接口时设置outer_str为1,添加卡券JS-SDK时设置为2,则可通过对领取事件的分析得出两个不同投放渠道带来的领券效果,及时调整投放策略。
微信门店接口文档,获取门店 ID 后填入创建卡券接口中的相应字段 location_id_list,即可设置该卡券的适用门店。
设置白名单接口设置用户白名单,领取未通过审核的卡券,测试整个卡券的使用流程。
接口调用请求说明
HTTP请求方式: POST
URL: https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
json数据
POST数据示例
{
"card": {
"card_type": "GROUPON",
"groupon": {
"base_info": {
"logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
"brand_name": "微信餐厅",
"code_type": "CODE_TYPE_TEXT",
"title": "132元双人火锅套餐",
"color": "Color010",
"notice": "使用时向服务员出示此券",
"service_phone": "020-88888888",
"description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
"date_info": {
"type": "DATE_TYPE_FIX_TIME_RANGE",
"begin_timestamp": 1397577600,
"end_timestamp": 1472724261
},
"sku": {
"quAntity": 500000
},
"get_limit": 3,
"use_custom_code": false,
"bind_openid": false,
"can_share": true,
"can_give_friend": true,
"location_id_list": [
123,
12321,
345345
],
"center_title": "顶部居中按钮",
"center_sub_title": "按钮下方的wording",
"center_url": "www.qq.com",
"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": "大众点评"
},
"advanced_info": {
"use_condition": {
"accept_category": "鞋类",
"reject_category": "阿迪达斯",
"can_use_with_other_discount": true
},
"abstract": {
"abstract": "微信餐厅推出多种新季菜品,期待您的光临",
"icon_url_list": [
"http://mmbiz.qpic.cn/mmbiz/p98FjXy8LacgHxp3sJ3vn97bGLz0ib0Sfz1bjiaoOYA027iasqSG0sj piby4vce3AtaPu6cIhBHkt6IjlkY9YnDsfw/0"
]
},
"text_image_list": [
{
"image_url": "http://mmbiz.qpic.cn/mmbiz/p98FjXy8LacgHxp3sJ3vn97bGLz0ib0Sfz1bjiaoOYA027iasqSG0sjpiby4vce3AtaPu6cIhBHkt6IjlkY9YnDsfw/0",
"text": "此菜品精选食材,以独特的烹饪方法,最大程度地刺激食 客的味蕾"
},
{
"image_url": "http://mmbiz.qpic.cn/mmbiz/p98FjXy8LacgHxp3sJ3vn97bGLz0ib0Sfz1bjiaoOYA027iasqSG0sj piby4vce3AtaPu6cIhBHkt6IjlkY9YnDsfw/0",
"text": "此菜品迎合大众口味,老少皆宜,营养均衡"
}
],
"time_limit": [
{
"type": "MONDAY",
"begin_hour":0,
"end_hour":10,
"begin_minute":10,
"end_minute":59
},
{
"type": "HOLIDAY"
}
],
"business_service": [
"BIZ_SERVICE_FREE_WIFI",
"BIZ_SERVICE_WITH_PET",
"BIZ_SERVICE_FREE_PARK",
"BIZ_SERVICE_DELIVER"
]
},
"deal_detail": "以下锅底2选1(有菌王锅、麻辣锅、大骨锅、番茄锅、清补 凉锅、酸菜鱼锅可选):\n大锅1份 12元\n小锅2份 16元 "
}
}
}
字段示图
http://mmbiz.qpic.cn/
卡券的商户logo,建议像素为300*300。
code_type
是
string(16)
CODE_TYPE_TEXT
码型:
"CODE_TYPE_TEXT"文本;
"CODE_TYPE_BARCODE"一维码
"CODE_TYPE_QRCODE"二维码
"CODE_TYPE_ONLY_QRCODE",二维码无code显示;
"CODE_TYPE_ONLY_BARCODE",一维码无code显示;CODE_TYPE_NONE,
不显示code和条形码类型
brand_name
是
string(36)
海底捞
商户名字,字数上限为12个汉字。
title
是
string(27)
双人套餐100元兑换券
卡券名,字数上限为9个汉字。(建议涵盖卡券属性、服务及金额)。
color
是
string(16)
Color010
券颜色。按色彩规范标注填写Color010-Color100。
notice
是
string(48)
请出示二维码
卡券使用提醒,字数上限为16个汉字。
description
是
string
(3072)
不可与其他优惠同享
卡券使用说明,字数上限为1024个汉字。
sku
是
JSON结构
见上述示例。
商品信息。
quantity
是
int
100000
卡券库存的数量,上限为100000000。
date_info
是
JSON结构
见上述示例。
使用日期,有效期的信息。
type
是
string
DATE_TYPE_FIX
_TIME_RANGE
表示固定日期区间,DATE_TYPE_FIX_TERM
表示固定时长
(自领取后按天算。
使用时间的类型,旧文档采用的1和2依然生效。
begin_time
stamp
是
unsigned int
14300000
type为DATE_TYPE_FIX_TIME_RANGE时专用,表示起用时间。从1970年1月1日00:00:00至起用时间的秒数,最终需转换为字符串形态传入。(东八区时间,单位为秒)
end_time
stamp
是
unsigned int
15300000
表示结束时间,建议设置为截止日期的23:59:59过期。(东八区时间,单位为秒)
fixed_term
是
int
15
type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天内有效,不支持填写0。
fixed_begin
_term
是
int
0
type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天开始生效,领取后当天生效填写0。(单位为天)
end_time
stamp
否
unsigned int
15300000
可用于DATE_TYPE_FIX_TERM时间类型,表示卡券统一过期时间,建议设置为截止日期的23:59:59过期。(东八区时间,单位为秒),设置了fixed_term卡券,当时间达到end_timestamp时卡券统一过期
码型:
"CODE_TYPE_TEXT"文本;
"CODE_TYPE_BARCODE"一维码
"CODE_TYPE_QRCODE"二维码
"CODE_TYPE_ONLY_QRCODE",二维码无code显示;
"CODE_TYPE_ONLY_BARCODE",一维码无code显示;CODE_TYPE_NONE,
不显示code和条形码类型
string
(3072)
DATE_TYPE_FIX
_TIME_RANGE
表示固定日期区间,DATE_TYPE_FIX_TERM
表示固定时长
(自领取后按天算。
begin_time
stamp
end_time
stamp
fixed_begin
_term
end_time
stamp
base_info(卡券基础信息)字段-非必填字段
参数名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
use_custom_code | 否 | bool | true |
是否自定义Code码 。填写true或false,默认为false。 通常自有优惠码系统的开发者选择 自定义Code码,并在卡券投放时带入 Code码,详情见是否自定义Code码。 |
get_custom_code_mode | 否 | string(32) |
GET_CUSTOM_COD E_MODE_DEPOSIT |
填入 GET_CUSTOM_CODE_MODE_DEPOSIT 表示该卡券为预存code模式卡券, 须导入超过库存数目的自定义code后方可投放, 填入该字段后,quantity字段须为0,须导入code 后再增加库存 |
bind_openid | 否 | bool | true |
是否指定用户领取,填写true或false 。默认为false。通常指定特殊用户群体 投放卡券或防止刷券时选择指定用户领取。 |
service_phone | 否 | string(24) | 40012234 | 客服电话。 |
location_id_list | 否 | array | 1234,2312 |
门店位置poiid。调用POI门店管理接 口获取门店位置poiid。具备线下门店 的商户为必填。 |
use_all_locations |
否 | bool | true | 设置本卡券支持全部门店,与location_id_list互斥 |
source | 否 | string(36) | 大众点评 | 第三方来源名,例如同程旅游、大众点评。 |
custom_url_name | 否 | string(15) | 立即使用 |
自定义跳转外链的入口名字 。详情见活用自定义入口 |
center_title | 否 | string(18) | 立即使用 |
卡券顶部居中的按钮,仅在卡券状 态正常(可以核销)时显示 |
center_sub_title | 否 | string(24) | 立即享受优惠 |
显示在入口下方的提示语 ,仅在卡券状态正常(可以核销)时显示。 |
center_url | 否 | string(128) | www.qq.com |
顶部居中的url ,仅在卡券状态正常(可以核销)时显示。 |
custom_url | 否 | string(128) | www.qq.com | 自定义跳转的URL。 |
custom_url_sub_title | 否 | string(18) | 更多惊喜 | 显示在入口右侧的提示语。 |
promotion_url_name | 否 | string(15) | 产品介绍 | 营销场景的自定义入口名称。 |
promotion_url | 否 | string(128) | www.qq.com | 入口跳转外链的地址链接。 |
promotion_url_sub_title | 否 | string(18) | 卖场大优惠。 | 显示在营销入口右侧的提示语。 |
get_limit | 否 | int | 1 | 每人可领券的数量限制,不填写默认为50。 |
can_share | 否 | bool | false | 卡券领取页面是否可分享。 |
can_give_friend | 否 | bool | false | 卡券是否可转赠。 |
Advanced_info(卡券高级信息)字段
字段 |
是否 必填 |
类型 | 说明 |
---|---|---|---|
advanced_info | 否 | JSON结构 | 创建优惠券特有的高级字段 |
use_condition | 否 | JSON结构 | 使用门槛(条件)字段,若不填写使用条件则在券面拼写 |
accept_category | 否 | string(512) |
指定可用的商品类目,仅用于代金券类型 ,填入后将在券面拼写适用于xxx |
reject_category | 否 | string(512) |
指定不可用的商品类目,仅用于代金券类型 ,填入后将在券面拼写不适用于xxxx |
least_cost | 否 | int |
满减门槛字段,可用于兑换券和代金券 ,填入后将在全面拼写消费满xx元可用。 |
object_use_for | 否 | string(512) |
购买xx可用类型门槛,仅用于兑换 ,填入后自动拼写购买xxx可用。 |
can_use_with_other_discount | 否 | bool |
不可以与其他类型共享门槛 ,填写false时系统将在使用须知里 拼写“不可与其他优惠共享”, 填写true时系统将在使用须知里 拼写“可与其他优惠共享”, 默认为true |
abstract | 否 | JSON结构 | 封面摘要结构体名称 |
abstract | 否 | string(24) | 封面摘要简介。 |
icon_url_list | 否 | string(128) |
封面图片列表,仅支持填入一 个封面图片链接,上传获取图片获得链接,填写 非CDN链接会报错,并在此填入。 建议图片尺寸像素850*350 |
text_image_list | 否 | JSON结构 |
图文列表,显示在详情内页 ,优惠券券开发者须至少传入 一组图文列表 |
image_url | 否 | string(128) |
图片链接,必须调用上传图片获得链接,并在此填入, 否则报错 |
text | 否 | string(512) | 图文描述 |
business_service | 否 | arry |
商家服务类型: BIZ_SERVICE_DELIVER 外卖服务; BIZ_SERVICE_FREE_PARK 停车位; BIZ_SERVICE_WITH_PET 可带宠物; BIZ_SERVICE_FREE_WIFI 免费wifi, 可多选 |
time_limit | 否 | JSON结构 | 使用时段限制,包含以下字段 |
type | 否 | string(24) |
限制类型枚举值:支持填入 MONDAY 周一 TUESDAY 周二 WEDNESDAY 周三 THURSDAY 周四 FRIDAY 周五 SATURDAY 周六 SUNDAY 周日 此处只控制显示, 不控制实际使用逻辑,不填默认不显示 |
begin_hour | 否 | int |
当前type类型下的起始时间(小时) ,如当前结构体内填写了MONDAY, 此处填写了10,则此处表示周一 10:00可用 |
begin_minute | 否 | int |
当前type类型下的起始时间(分钟) ,如当前结构体内填写了MONDAY, begin_hour填写10,此处填写了59, 则此处表示周一 10:59可用 |
end_hour | 否 | int |
当前type类型下的结束时间(小时) ,如当前结构体内填写了MONDAY, 此处填写了20,则此处表示周一 10:00-20:00可用 |
end_minute | 否 | int |
当前type类型下的结束时间(分钟) ,如当前结构体内填写了MONDAY, begin_hour填写10,此处填写了59, 则此处表示周一 10:59-00:59可用 |
注意事项:
1.高级字段为商户额外展示信息字段,非必填,但是填入某些结构体后,须填充完整方可显示:如填入text_image_list结构体
时,须同时传入image_url和text,否则也会报错;
2.填入时间限制字段(time_limit),只控制显示,不控制实际使用逻辑,不填默认不显示
3.创建卡券时,开发者填入的时间戳须注意时间戳溢出时间,设置的时间戳须早于2038年1月19日
4.预存code模式的卡券须设置quantity为0,导入code后方可增加库存
返回说明
数据示例:
{
"errcode":0,
"errmsg":"ok",
"card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
参数名 | 描述 |
---|---|
errcode | 错误码,0为正常。 |
errmsg | 错误信息。 |
card_id | 卡券ID。 |
http://www.qq.com?encrypt_code=ENCRYPT_CODE&card_id=CARDID
卡券创建接口在线调试工具进行卡券创建HelloWorld。获取到access_token后,开发者可以将要POST的JSON数据贴至接口调试工具中,获得Card_id以进行下一步投放动作。