會員卡專區(二)
8 管理會員卡
8.1 拉取會員資訊(積分查詢)介面
#介面說明
支援開發者根據card_id和Code查詢會員資訊,包括啟動資料、積分資訊以及餘額等資訊。
介面呼叫請求說明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN
參數說明
| | POST資料 |
是 JSON資料 # | 呼叫介面憑證 | |
POST資料{ "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8", "code": "916679873278"} | | |
#POST資料
{
"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"
}
參數名 | ## 參數名必填 | 說明 |
cardid ##cardid | | #code |
是 所詢問使用者所領取的code值 | | |
##################################################################################################################################################################
回傳資料
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN
參數名稱 | 說明 |
errcode碼,0為正常 | | errmsg
| #lmsg 內部唯一識別碼 |
nickname | #使用者暱稱 # | #使用者稱為
| balance | 餘額資訊
| sex # user_info | 會員資訊
| #custom_field_list 1 |
name | 會員資訊類別目名稱 |
##value 1例如等級值等 | user_card_status |
#user_card_status | #user_card_status |
#user_card_status OUT》使用 | |
8.2 更改會員卡資訊介面 | 介面說明 |
支援變更會員卡卡麵資訊以及卡券屬性資訊。 介面呼叫請求說明 | {
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
"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":""
}
}
參數說明 |
POST資料
是
Json資料 #
呼叫介面憑證
#POST資料
{ "errcode":0, "errmsg":"ok", "send_check":true}
支援修改欄位:
base_info欄位:
參數名稱 | 是否已提審 | 類型 | 範例值 | 說明 | ##n##n##)吧# #
---|
string( 128) | http://mmbiz | ##http://mmbiz | .q . 00。 notice | 是 |
string(48) #碼核銷卡券。 | #使用提醒,字數上限為16個漢字。 | | description 是 string(3072) # | ##他優惠同享受 # | 使用說明。 。 |
客服電話。 | color | | ##color | |
color 卡券顏色。 | | location_id_list | ##location_id_list | ##location_id_list |
為「 #支援更新適用門市列表。 | | use_all_locations | ## | #bool |
true支援全部門店,填入後卡券門市追蹤商家門市更新更新 | | center_title | | #center_title |
#center_title | #center_title 時使用 | ##會員卡中間的跳轉按鈕名稱 | ,建議使用用途 |
center_sub_title | #center_sub_title | ##center_sub_title | | center_sub_title 中( | #會員卡中間按鈕解釋wording
| center_url | | center_url | #會員卡中部按鈕對應跳躍的url |
custom_url_name | # # | #自訂跳轉入口的名字。 | | custom_url | 否
string(128) # #自訂跳轉的URL。 | | custom_url_sub_title | 否 | string(18) # 顯示在入口右側的提示語。 |
promotion_url_name | promotion_url_name | 1 與 | #行銷情境的自訂入口名稱。 | |
promotion_url 否 | string(128) | 入口跳轉外鏈的地址連結。 | | #promotion_url_sub_title |
| | | | ) | 否 | string(18) | #賣場皆佳優惠。 | #顯示在行銷入口右側的提示語。 |
code_type | | ##code_type | #「16) _TEXT。 | Code碼展示類型, "CODE_TYPE_TEXT" 文本 "CODE_TYPE_BARCODE"一維碼 "CODE_TYPE_QRCODE 二維碼 "CODE_TYPE_ONLY_QRCODE" 只顯示二維碼 "CODE_TYPE_ONLY_BARCODE" ##ONEODE_顯示任何碼型 |
get_limit | 否 | int # | | can_share |
否 bool | ## | | #can_give_friend | 否 | bool
## 刪除 | #date_info | 否 | Json結構 的擴大 | |
type ##時間戳,不支援填入2 | | begin_timestamp | # # | # 00000 | 固定日期區間專用,表示起用時間。 (單位為秒)
| end_timestamp | | 1 00 | 固定日期區間專用,表示結束時間。結束時間僅支援往後延長。 |
#會員卡專屬欄位修改:
特別注意,以下支援更新的欄位不在基本資訊base_info的結構中。
參數名稱 | 是否提審 | # #background_pic_url | #否 |
string(128) bonus_cleared 是 | string(3072) | #積分清除規則。 | |
bonus_rules #是 | | balance_rules | #是 |
prerogative | #為 | | wx_activate |
##wx_activate ##wx_activate | ##wx_activate 中1 | ##wx_activate中true時,該卡將支援一鍵開卡詳情請見 | 一鍵開卡。 |
此選項與activate_url互斥。 | | auto_activate | ##auto_activate | ##auto_activate
##auto_activate 中 | ##auto_activate中設定為true時用戶領取會員卡自動設定為激活, | 詳情請見自動激活 | 。 # |
activate_url | #否 | #string(128)
| 啟動連結 |
#custom_field1 | #否 | Json結構 | ##Json結構 |
custom_field2 | 否 | Json結構 | 自定義會員信息類目,會員卡激活後顯示。 |
custom_field3 | 否 | Json結構 | 自定義會員信息類目,會員卡激活後顯示。 |
name_type | | ##name_type | FIELD_NAME_TYPE_LEVEL 等級FIELD_NAME_TYPE_COUPON 券DISCOUNT 折扣FIELD_NAME_TYPE_ACHIEVEMEN 成就 FIELD_NAME_TYPE_MILEAGE 里程 # 里程 # |
url | | custom_cell1 | 否 |
#JSON結構# ## 選擇##bonus_rule | #否 | JSON結構 | 鍵# ##cost_money_unit | #否
#int #否 | 否 | int | #根據上述消費金額對應的積分 |
單一取得的積分上限 | | init_increase_bonus | ## 1# 所得的初始積分 |
cost_bonus_unit | 否 | int # | | reduce_money
否 | int | 抵扣xx元,(這里以分為單位) | |
least_money_to_use_bonus 否 | int | 「扣環條件,滿xx元(這裡分為單位)可用 # | #否
int | 抵扣條件,單一筆使用最多xx | int | 折扣,該會員卡享受的折扣優惠 |
返回數據說明 | 數據示例: | http请求方式: POSThttps://api.weixin.qq.com/card/update?access_token=TOKEN
| | 參數名稱
說明
errcode
##愛 | errmsg |
#錯誤訊息中。 | send_check |
#此更新是否需提審,true為需要,false為則不需要。 | # 開發者註意事項註 1. 更改卡券的部分欄位後會重新提交審核,詳情請見欄位說明,更新成功後可透過呼叫查看卡券詳情介面核查更新結果; 2. 僅填入需要更新的字段,許多開發者在呼叫該介面時會填入brandname等不支援修改的字段,導致更新不成功。 3. 呼叫該介面後更改卡券資訊後,請務必呼叫查看卡券詳情介面是否已成功變更。 8.3 設定跟隨建議功能介紹 支援開發者在積分變動訊息底部,設定卡券或設定跳轉外鏈URL,具體形式如下圖,可以是URL也可以是一張卡券。
開發者註意事項 一、支援兩種類型的跟隨建議組態 1. 廣告詞URL,支援商家配置16個漢字長度的文案,及點擊跳轉的連結。 2. 推薦卡券,支持商家配置一個本公眾號下的卡券。 二、推薦位元有效期限控制 #1. 廣告語 URL類型,支援商家依據活動期限自訂顯示時間。 2. 推薦卡券類型,由微信後台判斷卡券的有效性,當卡券已過期、已被領完、已被置為失效會自動下架展示。
8.3.1 設定跟隨建議介面 介面說明 呼叫更新卡券資訊介面將會增加推薦位元欄位update到已成功通過審核的卡券。同時支援在建立卡券時填入對應欄位。 介面詳情
介面呼叫請求說明 {
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"modify_msg_operation": {
"card_cell": {
"end_time": 1452724561,
"card_id": "p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
}
}
} 參數說明 參數 | 是否必須 | 說明 |
---|
access_token 與 | | POST數據 | 是 Json數據 | | 使用訊息設定卡券 {
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"modify_msg_operation": {
"url_cell": {
"end_time": 1452724561,
"text": "更多优惠",
"url": "www.qq.com"
}
}
}
} 使用訊息設定URL
{ "errcode":0, "errmsg":"ok" } 欄位說明 ##欄位名稱 | 說明 | #card_id | #卡券ID。 | modify_msg_operation | ##modify_msg_operation | ##mod #卡券類型的推薦位。 Json結構參考範例。 | url_cell | #連結類型中使用中的建議位元。 Json結構參考範例。 | card_id | 開放營運位元的卡券id #end_time | | ##end_time的截止時間。 | text | 文字內容時。 | url ##即可開放連結連結。 | | 回傳資料 | HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/paygiftmembercard/add?access_token=TOKEN 欄位說明
欄位名稱 #說明 #錯誤碼 | 錯誤碼,0為正常;43008為商家沒有開通微信支付權限; #errmsg | 錯誤訊息 | #8.4 設定付款即會員8.4.1 增加付款即會員規則介面 開通微信支付的商家可以設置,用戶在微信付款後自動為用戶發送一條領卡訊息,用戶點擊訊息即可領取會員卡。 介面說明 支援商家設定付款即會員的規則,可區分時段與金額區間發會員卡。 介面呼叫請求說明 {
"card_id": "xxxxxxxxa",
"jump_url": "mp.weixin.qq.com/wiki",
"mchid_list": [
"123",
"1234",
"12345"
],
"begin_time": 146324567,
"end_time": 147234567,
"min_cost": 1000,
"max_cost": 10000000,
"is_locked": true
} 參數說明 | | POST資料 | 是 Json資料 # | 呼叫介面憑證 | | #POST資料{
"errcode": 0,
"errmsg": "ok",
"succ_list":[
"134xxxxxx"
],
"fail_list":[
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
},
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
}
]
} | 欄位說明 | | #HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/paygiftmembercard/delete?access_token=TOKEN 欄位說明#」名 #說明 | | card_id ##card_id 中使用 | jump_url | 範本訊息跳轉的url,可以是商家自訂的領卡網頁連結 list#list#n _ | ##支援贈券規則的商家號碼清單 | begin_time | | ## end_time | 規則結束時間
| min_cost 111111116 月 加值# ##max_cost | 這次規則生效付款金額上限,與分為單位 | 此規則生效付款金額上限,且與分類為單位為內# 設定過的商家號碼,預設為true | #回傳資料說明 資料範例: {
"card_id": "xxxxxxxxa",
"mchid_list": [
123,
1234,
12345
]
} #############################################################################' ##errcode ######錯誤碼,0為正常。 ############errmsg #######錯誤訊息中。 ############succ_list ######設定成功的mchid清單 #############list ## ##########mchid ######支付的商家號碼 ############occupy_appid c ###########)cupy_appid # 目前被佔用的appid,商家須使用該appid解除綁定後重新設定。 #############開發者註意事項註 1. 會員卡領卡訊息針對單一新使用者僅發送一次,若該使用者已接收或已領取會員卡則不會重複發送; 2. 透過此規則設定的card_id的製券appid必須和目前mch_id的主體appid一致,否則報錯72001; 3.僅支援會員卡類型的卡券,否則報錯:72003; 4.設定付款即會員時,須確認呼叫介面的appid和目前card_id主體一致,以及appid與mchid有綁定關係,否則報錯:72002; 5.須保證mchid之前沒有被其他appid設定過,否則報錯72004; # 6.單次僅限設定100個mchid,若超過100個請多次呼叫本介面。 8.4.2 刪除付款即會員規則介面 刪除先前已設定的付款即會員規則。 介面說明 支援商家設定付款即會員的規則,可以區分時段和金額區間發會員卡。 介面呼叫請求說明 {
"errcode": 0,
"errmsg": "ok",
"succ_list":[
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
},
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
}
],
"fail_list":[
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
},
{
"mchid": "xxxxx",
"errcode": 0,
"errmsg": "ok",
"occupy_appid": "wxxxxxxxxxxx"
}
]
} 參數說明 | | POST資料 | 是 Json資料 # | 呼叫介面憑證 | | #POST資料HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/paygiftmembercard/get?access_token=TOKEN | 欄位說明 | | #{"mchid":"xxxxxxxx"} 欄位說明#」名 #說明 | | card_id ##card_id 中 ##中卡券ID中。 。 回傳資料說明 資料範例: {
"errcode": 0,
"errmsg": ok,
"card_id": "xxxxxxxxxxxxxxxxxx",
"occupy_appid": "wxxxxxxxxxxx",
"is_locked": true
} 參數名稱 | #說明 | ##說明 時##errcode 錯誤碼,0為正常。 | | errmsg #錯誤訊息中。 | | succ_list 設定成功的mchid清單 | | #list | mchid | 支付的商家號碼 | occupy_appid c | ##)cupy_appid # 目前被佔用的appid,商家須使用該appid解除綁定後重新設定。 |
| 8.4.3 查詢商家號碼付款即會員規則介面 可以查詢某個商家號碼是否支援付款即會員功能 介面呼叫請求說明 {
"card": {
"card_type": "MEMBER_CARD",
"member_card": {
"base_info": {
"pay_info":
{
"swipe_card":
{
"is_swipe_card":true
}
}
}
}
}
} 參數說明 參數 是否必須 | 說明 | | POST資料 | access_token | 是 | #呼叫介面憑證 | #欄位名稱 | 說明 | mchid # #回傳資料說明 資料範例: {
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"base_info": {
"pay_info":
{
"swipe_card":
{
"is_swipe_card":true
}
}
}
}
} #8.5 設定會員卡拉出微信付款刷卡介面透過介面建立支援刷卡類型的會員卡,使用者點擊快速買單後即可拉出刷卡介面進行付款。以下為示意圖:
#8.5.1 建立會員卡支援微信支付刷卡#商家可以建立一張會員卡支援微信支付刷卡,須在建立會員卡介面的JSON中加入以下欄位: rrreee8.5.2 更新會員卡支援微信支付刷卡商家可以更新已有會員卡支援微信支付刷卡,須在更新會員卡介面的JSON中加入以下欄位: rrreee
# | |
|
|