最新更新時(shí)間:2020.07.24 版本說(shuō)明
服務(wù)商可通過(guò)該接口查詢(xún)微信用戶(hù)卡包中某一張商家券的詳情信息。
適用對(duì)象:直連商戶(hù) 服務(wù)商 渠道商
請(qǐng)求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons/{coupon_code}/appids/{appid}
請(qǐng)求方式:GET
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請(qǐng)求URL傳參
body 指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
券code | coupon_code | string[1,32] | 是 | path 券的唯一標(biāo)識(shí)。 示例值:123446565767 |
公眾賬號(hào)ID | appid | string[1,32] | 是 | path 支持傳入與當(dāng)前調(diào)用接口商戶(hù)號(hào)有綁定關(guān)系的appid。支持小程序appid與公眾號(hào)appid。 示例值:wx233544546545989 |
用戶(hù)標(biāo)識(shí) | openid | string[1,128] | 是 | path Openid信息,用戶(hù)在appid下的唯一標(biāo)識(shí)。 示例值:2323dfsdf342342 |
https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/2323dfsdf342342/coupons/123446565767/appids/wx233544546545989
參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
批次歸屬商戶(hù)號(hào) | belong_merchant | string[8,15] | 是 | 批次歸屬于哪個(gè)商戶(hù)。 示例值:10000022 |
商家券批次名稱(chēng) | stock_name | string[1,21] | 是 | 批次名稱(chēng),字?jǐn)?shù)上限為21個(gè),一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值:商家券 |
批次備注 | comment | string[1,20] | 否 | 僅配置商戶(hù)可見(jiàn),用于自定義信息。字?jǐn)?shù)上限為20個(gè),一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值:xxx可用 |
適用商品范圍 | goods_name | string[1,15] | 是 | 適用商品范圍,字?jǐn)?shù)上限為15個(gè),一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值:xxx商品可用 |
批次類(lèi)型 | stock_type | string[1,128] | 是 | 批次類(lèi)型 NORMAL:固定面額滿(mǎn)減券批次 DISCOUNT:折扣券批次 EXCHANGE:換購(gòu)券批次 示例值:NORMAL |
是否允許轉(zhuǎn)贈(zèng) | transferable | bool | 否 | 不填默認(rèn)否,枚舉值: true:是 false:否 該字段暫未開(kāi)放 示例值:false |
是否允許分享領(lǐng)券鏈接 | shareable | bool | 否 | 不填默認(rèn)否,枚舉值: true:是 false:否 該字段暫未開(kāi)放 示例值:false |
券狀態(tài) | coupon_state | string[1,16] | 否 | 商家券狀態(tài) 枚舉值: |
+樣式信息 | display_pattern_info | object | 否 | 商家券詳細(xì)信息 |
+券核銷(xiāo)規(guī)則 | coupon_use_rule | 券核銷(xiāo)規(guī)則 | 是 | 券核銷(xiāo)相關(guān)規(guī)則 |
+自定義入口 | custom_entrance | object | 否 | 卡詳情頁(yè)面,可選擇多種入口引導(dǎo)用戶(hù)。 |
券code | coupon_code | string[1,32] | 否 | 券的唯一標(biāo)識(shí)。 示例值:123446565767 |
批次號(hào) | stock_id | string[1,20] | 否 | 微信為每個(gè)商家券批次分配的唯一ID,是否指定批次號(hào)查詢(xún)。 示例值:1002323 |
券可使用開(kāi)始時(shí)間 | available_start_time | string[1,32] | 是 | 1、用戶(hù)領(lǐng)取到該張券實(shí)際可使用的開(kāi)始時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 2、若券批次設(shè)置為領(lǐng)取后可用,則開(kāi)始時(shí)間即為券的領(lǐng)取時(shí)間;若券批次設(shè)置為領(lǐng)取后第X天可用,則開(kāi)始時(shí)間為券領(lǐng)取時(shí)間后第X天00:00:00可用。 示例值:2019-12-30T13:29:35+08:00 |
券過(guò)期時(shí)間 | expire_time | string[1,32] | 是 | 用戶(hù)領(lǐng)取到該張券的過(guò)期時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
券領(lǐng)券時(shí)間 | receive_time | string[1,32] | 是 | 用戶(hù)領(lǐng)取到該張券的時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
發(fā)券請(qǐng)求單號(hào) | send_request_no | string[1,32] | 是 | 發(fā)券時(shí)傳入的唯一憑證 示例值: MCHSEND202003101234 |
核銷(xiāo)請(qǐng)求單號(hào) | use_request_no | string[1,32] | 否 | 核銷(xiāo)時(shí)傳入的唯一憑證(如券已被核銷(xiāo),將返回此字段) 示例值: MCHUSE202003101234 |
券核銷(xiāo)時(shí)間 | use_time | string[1,32] | 否 | 券被核銷(xiāo)的時(shí)間(如券已被核銷(xiāo),將返回此字段);遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
{
"belong_merchant": "100000222",
"stock_name": "商家券",
"comment": "xxx可用",
"goods_name": "xxx商品可用",
"stock_type": "NORMAL",
"transferable": "false",
"shareable": "false",
"coupon_state": "SENDED",
"display_pattern_info": {
"description": "xxx門(mén)店可用",
"merchant_logo_url": "https://xxx",
"merchant_name": "微信支付",
"background_color": "xxxxx",
"coupon_image_url": "圖片cdn地址"
},
"coupon_use_rule": {
"coupon_available_time": {
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"available_day_after_receive": 3,
"available_week": {
"week_day": [
"1",
"2"
],
"available_day_time": [
{
"begin_time": 3600,
"end_time": 86399
}
]
},
"irregulary_avaliable_time": [
{
"begin_time": "2015-05-20T13:29:35+08:00",
"end_time": "2015-05-20T13:29:35+08:00"
}
]
},
"fixed_normal_coupon": {
"discount_amount": 5,
"transaction_minimum": 100
},
"discount_coupon": {
"discount_percent": 88,
"transaction_minimum": 100
},
"exchange_coupon": {
"exchange_price": 100,
"transaction_minimum": 100
},
"use_method": "OFF_LINE",
"mini_programs_appid": "wx23232232323",
"mini_programs_path": "/path/index/index"
},
"custom_entrance": {
"mini_programs_info": {
"mini_programs_appid": "wx234545656765876",
"mini_programs_path": "/path/index/index",
"entrance_words": "歡迎選購(gòu)",
"guiding_words": "獲取更多優(yōu)惠"
},
"appid": "wx324345hgfhfghfg",
"hall_id": "233455656",
"store_id": "233554655"
},
"coupon_code": "123446565767",
"stock_id": "1002323",
"available_start_time": "2019-12-30T13:29:35+08:00",
"expire_time": "2019-12-31T13:29:35+08:00",
"receive_time": "2019-12-30T13:29:35+08:00"
"send_request_no": "MCHSEND202003101234"
"use_request_no": "MCHSEND202003101234"
"use_time": "2019-12-30T13:29:35+08:00"
}
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 查看具體錯(cuò)誤信息,調(diào)整參數(shù) |
400 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重復(fù)使用 |
券已被其他訂單核銷(xiāo) | 請(qǐng)通過(guò)查詢(xún)?nèi)疉PI確認(rèn)券是否已被其他訂單核銷(xiāo) | ||
404 | RESOURCE_NOT_EXISTS | 查詢(xún)的資源不存在 | 請(qǐng)檢查查詢(xún)資源的對(duì)應(yīng)id是否填寫(xiě)正確 |
403 | NOAUTH | 無(wú)權(quán)限 | 查看具體錯(cuò)誤信息,確認(rèn)是否有權(quán)限 |
400 | APPID_MCHID_NOT_MATCH | appid與請(qǐng)求方商戶(hù)無(wú)關(guān)聯(lián)關(guān)系 | appid與請(qǐng)求方商戶(hù)不匹配,請(qǐng)確認(rèn)appid與請(qǐng)求方商戶(hù)是否有關(guān)聯(lián)關(guān)系 |
400 | MCH_NOT_EXISTS | 商戶(hù)號(hào)不存在 | 請(qǐng)確認(rèn)傳入的商戶(hù)號(hào)是否正確 |
404 | USER_NOT_EXISTS | openid不正確 | 請(qǐng)確認(rèn)傳入的openid是否正確 |
500 | SYSTEM_ERROR | 系統(tǒng)失敗 | 多為網(wǎng)絡(luò)超時(shí)引起,重試 |
429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁,請(qǐng)降低調(diào)用接口頻率 |
403 | RULELIMIT | 券不在有效期 | 請(qǐng)確認(rèn)券是否能在當(dāng)前時(shí)間核銷(xiāo) |
400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請(qǐng)更換支持預(yù)上傳code的批次后重試 |
上傳的自定義code已達(dá)上限 | 請(qǐng)更換一個(gè)新的批次后重試 |