一、創建卡券
1、步驟一:上傳卡券圖片素材
https://api.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN
使用到微信的 CDN
2、步驟二:設置卡券適用門店
location_id_list
3、步驟三:選取卡券背景顏色
color
固定有十四種
4、步驟四:創建卡券
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
base_info(卡券基礎信息)字段 **- **必填字段
base_info(卡券基礎信息)字段 - 非必填字段
Advanced_info(卡券高級信息)字段
填入時間限制字段(time_limit),只控制顯示,不控制實際使用邏輯,不填默認不顯示。
創建成功后該卡券會自動提交審核,審核結果將通過事件通知商戶。開發者可調用設置白名單接口設置用戶白名單,領取未通過審核的卡券,測試整個卡券的使用流程。
https://api.weixin.qq.com/card/testwhitelist/set?access_token=TOKEN
1.同時支持“openid”、“username”兩種字段設置白名單,總數上限為10個。
2.設置測試白名單接口為全量設置,即測試名單發生變化時需調用該接口重新傳入所有測試人員的ID。
(1)厘清概念
卡券分card_id
與Code碼
,前者相當於 java 的類,后者相當於 實例化對象。
(2)卡券類型
卡券類型有基本的四種:(還有其他的,如會員卡和電影票等等,見文章后面)
團購券 "card_type": "GROUPON",
代金券 "card_type": "CASH",
折扣券 "card_type": "DISCOUNT",
兌換券 "card_type": "GIFT",
(3)code碼類型
use_custom_code
、 get_custom_code_mode
code碼類型有三種:
非自定義code碼 (微信后台隨機分配 - 默認)
自定義code碼
導入code模式
(4)卡券的展示碼型
code_type
卡券的展示碼型有四種:
二維碼/一維碼顯示code
二維碼不顯示code
僅code類型
無code類型
(5)卡券詳情頁支持有三個入口做自定義跳轉
使用場景入口
服務場景入口
營銷場景入口
跳轉外鏈會自動帶參數:http://www.qq.com?encrypt_code=ENCRYPT_CODE&card_id=CARDID
其中 encrypt_code
為加密碼,需調用解碼接口獲取真實Code碼。
5、快速買單(可自助核銷)
略
二、投放卡券
"outer_str" : "12b"
當用戶領取卡券時會將相應設值的outer_id帶入領取事件中,推送至開發者服務器。
1、創建二維碼接口
https://api.weixin.qq.com/card/qrcode/create?access_token=TOKEN
掃碼領一張 or 多張 (最多支持同時領5張)
2、H5 線上發券(JS-SDK 接口)
需要獲取api_ticket
:
https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=wx_card
注意跟JS-SDK 里的
jsapi_ticket
不一樣,后者這樣獲取:https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi
(1)拉取適用卡券列表並獲取用戶選擇信息 chooseCard
(2)批量添加卡券接口 addCard
(3)查看微信卡包中的卡券接口 openCard
3、卡券貨架
卡券貨架支持開發者通過調用接口生成一個卡券領取H5頁面(微信幫你生成),並獲取頁面鏈接,進行卡券投放動作。
4、群發卡券(僅支持非自定義code的卡券)
圖文消息群發
根據用戶分組群發
根據OpenID列表群發
客服消息下發
三、核銷卡券
在用戶使用券之后讓卡券從用戶的微信客戶端消失的過程,這個步驟稱為核銷。
1、線下
(1)查詢Code接口
https://api.weixin.qq.com/card/code/get?access_token=TOKEN
我們強烈建議開發者在調用核銷code接口之前調用查詢code接口,並在核銷之前對非法狀態的code(如轉贈中、已刪除、已核銷等)做出處理。
(2)核銷Code接口
https://api.weixin.qq.com/card/code/consume?access_token=TOKEN
此操作不可逆。
2、線上
(1)拉取卡券列表接口(JS-SDK)
獲取到前端用戶要核銷哪張券,只不過把 code 加密成了encrypt_code
(2)Code解碼接口
后台把從前端獲取的encrypt_code
解碼成明文的 code:
https://api.weixin.qq.com/card/code/decrypt?access_token=TOKEN
然后接下來的第(3)(4)對應着上面1、線下
的(1)(2)兩步
四、管理卡券
1、獲取用戶已領取的卡券
可查所有的,可查某個卡下的:
https://api.weixin.qq.com/card/user/getcardlist?access_token=TOKEN
2、查看卡券詳情
查看一張:https://api.weixin.qq.com/card/get?access_token=TOKEN
查看多張: https://api.weixin.qq.com/card/batchget?access_token=TOKEN
3、更改卡券信息
https://api.weixin.qq.com/card/update?access_token=TOKEN
只支持部分字段的更新,詳細看文檔
有的字段更新后會重新進入審核狀態
若開發者置空某些字段,可直接在更新時傳“”(空)
4、修改卡券庫存
https://api.weixin.qq.com/card/modifystock?access_token=TOKEN
5、更改卡券Code(只針對自定義Code的卡券)
https://api.weixin.qq.com/card/code/update?access_token=TOKEN
為避免用戶疑惑,建議僅在發生轉贈行為后更改。
6、刪除卡券接口
針對 card_id
刪除卡券不能刪除已被用戶領取,保存在微信客戶端中的卡券。
https://api.weixin.qq.com/card/delete?access_token=TOKEN
7、設置卡券失效接口
針對 card_id 和 code (都必填)
https://api.weixin.qq.com/card/code/unavailable?access_token=TOKEN
操作不可逆,小心客訴.
8、統計卡券數據
(1)拉取所有卡券概況數據
https://api.weixin.qq.com/datacube/getcardbizuininfo?access_token=ACCESS_TOKEN
范圍的話只能拉取非當天之前的數據
(2)獲取具體券數據
https://api.weixin.qq.com/datacube/getcardcardinfo?access_token=ACCESS_TOKEN
(3)拉取會員概況數據
https://api.weixin.qq.com/datacube/getcardmembercardinfo?access_token=ACCESS_TOKEN
(4)拉取單張會員卡數據
https://api.weixin.qq.com/datacube/getcardmembercarddetail?access_token=ACCESS_TOKEN
五、卡券事件推送
1、針對卡券
審核事件推送
領取事件推送
轉贈事件推送
刪除事件推送
核銷事件推送
買單事件推送
從卡券進入公眾號會話事件推送
庫存報警事件(當某個card_id的初始庫存數大於200且當前庫存小於等於100時,用戶嘗試領券會觸發發送事件給商戶,事件每隔12h發送一次。)
2、針對會員卡
會員卡激活事件推送
進入會員卡事件推送
會員卡內容更新事件(如會員卡積分余額發生變動)
3、其他
券點流水詳情事件(如當商戶朋友的券券點發生變動時)
六、卡券-小程序打通
1、小程序內領取卡券
wx.addcard
2、小程序內查看卡券
wx.opencard
3、卡券內跳轉小程序
略
4、小程序開(會員)卡組件
見下文
六、朋友的券(朋友共享的優惠券)
“一人領取多人共享”
略
七、立減金
小程序社交立減金是一款幫助商家快速生成具備裂變傳播屬性的小程序經營工具,用戶通過支付、掃碼等場景可以參與社交立減金活動,將社交立減金禮包分享至朋友后自己可獲取一份,朋友在會話中可隨機獲取社交立減金,並直達商家小程序使用。
略
八、特殊票券
1、會議/演出門票
(1)創建會議門票
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
"card_type": "MEETING_TICKET"
(2)更新會議門票
https://api.weixin.qq.com/card/meetingticket/updateuser?access_token=TOKEN
2、景區門票
(1)創建景區門票
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
"card_type": "SCENIC_TICKET"
3、電影票
(1)創建電影票
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
"card_type": "MOVIE_TICKET"
(2)更新電影票
https://api.weixin.qq.com/card/meetingticket/updateuser?access_token=TOKEN
4、飛機票
飛機票與其他卡券相比具有更強的時效性和特殊性,故機票生成后無需經過微信審核,即時生效。
(1)創建飛機票接口
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
"card_type": "BOARDING_PASS"
(2)更新飛機票信息接口
https://api.weixin.qq.com/card/boardingpass/checkin?access_token=TOKEN
九、會員卡
1、創建會員卡
https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN
"card_type": "MEMBER_CARD"
2、激活會員卡
需要用到小程序開(會員)卡組件
,分跳轉型和非跳轉型。
通過創建會員卡時傳的activate_url
、auto_activate
和wx_activate
決定。
(1)方法一:自動激活(非跳轉型)
"auto_activate": true
(2)方法二:普通一鍵激活(非跳轉型)
步驟一:在創建卡券接口時填入字段
"wx_activate": true
步驟二:設置開卡字段
設置用戶激活時需要填寫的選項:
https://api.weixin.qq.com/card/membercard/activateuserform/set?access_token=TOKEN
步驟三:接收推送通知
步驟四:調用接口激活會員卡
https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN
(3)方法三:跳轉型一鍵激活(跳轉型)
支持用戶在提交會員開卡資料后跳轉至商戶自定義的網頁。
步驟一:在創建卡券接口時填入字段
"wx_activate": true,
"wx_activate_after_submit" : true,
"wx_activate_after_submit_url" : "https://qq.com"
步驟二:設置開卡字段
步驟三:獲取用戶提交資料
微信會在跳轉url后拼接獲取用戶填寫信息的參數,或者通過接口拿到:
https://api.weixin.qq.com/card/membercard/activatetempinfo/get?access_token=TOKEN
步驟四:調用接口激活會員卡
https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN
3、更新會員信息
https://api.weixin.qq.com/card/membercard/updateuser?access_token=TOKEN
參考資料
微信官方文檔
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141229