創(chuàng)建商家券API
最新更新時(shí)間：2020.11.12 版本說(shuō)明
商戶可以通過(guò)該接口創(chuàng)建商家券。
商家券滿減券預(yù)算控制從“金額”調(diào)整為“個(gè)數(shù)”周知
為更好的方便開(kāi)發(fā)者創(chuàng)建管理商家券的滿減券，微信支付將對(duì)滿減券發(fā)放預(yù)算庫(kù)存控制進(jìn)行優(yōu)化調(diào)整，即 從“總預(yù)算（單位元）”調(diào)整為“最大發(fā)放個(gè)數(shù)（單位個(gè)）” 具體如下：
調(diào)整前：
滿減券（券類(lèi)型為NORMAL）
| 參數(shù)名 | 變量 | 類(lèi)型 | 必填 | 描述 |
|---|---|---|---|---|
| 批次總預(yù)算 | max_amount | int | 是 | 總預(yù)算金額，單位：分。 |
| 批次最大發(fā)放個(gè)數(shù) | max_coupons | int | 否 | 特殊規(guī)則：取值范圍 1 ≤ value ≤ 1000000000 |
| 單天發(fā)放上限金額 | max_amount_by_day | int | 否 | 單天發(fā)放上限金額，單位：分（stock_type為NORMAL時(shí)可傳入此字段控制單天發(fā)放上限）。 |
| 單天發(fā)放上限個(gè)數(shù) | max_coupons_by_day | int | 否 | 特殊規(guī)則：取值范圍 1 ≤ value ≤ 1000000000 |
滿減券最大可發(fā)放個(gè)數(shù) = （批次總預(yù)算 max_amount）/ （優(yōu)惠金額 discount_amount）
調(diào)整后：
滿減券（券類(lèi)型為NORMAL）
| 參數(shù)名 | 變量 | 類(lèi)型 | 必填 | 描述 |
|---|---|---|---|---|
| 批次總預(yù)算 | max_amount | int | 是 | 總預(yù)算金額，單位：分。 |
| 批次最大發(fā)放個(gè)數(shù) | max_coupons | int | 是 | 特殊規(guī)則：取值范圍 1 ≤ value ≤ 1000000000 |
| 單天發(fā)放上限金額 | max_amount_by_day | int | 否 | 單天發(fā)放上限金額，單位：分（stock_type為NORMAL時(shí)可傳入此字段控制單天發(fā)放上限）。 |
| 單天發(fā)放上限個(gè)數(shù) | max_coupons_by_day | int | 否 | 特殊規(guī)則：取值范圍 1 ≤ value ≤ 1000000000 |
滿減券最大可發(fā)放個(gè)數(shù) = 批次最大發(fā)放個(gè)數(shù) max_coupons
策略正式上線時(shí)間： 11/2 中午12點(diǎn)
1）策略上線后，僅支持滿減券傳入max_coupons（批次最大發(fā)放個(gè)數(shù)）與max_coupons_by_day（單天發(fā)放上限個(gè)數(shù)）
2）原金額類(lèi)控制字段：max_amount（批次總預(yù)算）與max_amount_by_day（單天發(fā)放上限金額）將不再生效；
3）策略僅對(duì)11/2中午2點(diǎn)上線后的新創(chuàng)建批次生效，在此時(shí)間點(diǎn)前創(chuàng)建的存量滿減券批次不受影響。
策略灰度時(shí)間：10/15 18:00:00 至 11/2 11:59:59
在灰度期間，會(huì)做預(yù)算控制字段做兼容處理，即在此期間新創(chuàng)建的批次：
1）如滿減券同時(shí)傳入“max_amount（批次總預(yù)算）”與“max_coupons（批次最大發(fā)放個(gè)數(shù)）”時(shí)，則用“max_coupons（批次最大發(fā)放個(gè)數(shù)）”做滿減券實(shí)際可發(fā)放庫(kù)存控制；
2）如滿減券僅傳入“max_amount（批次總預(yù)算）”，則用“max_amount（批次總預(yù)算）”來(lái)做發(fā)放實(shí)際可發(fā)放庫(kù)存控制；（即最大可發(fā)放個(gè)數(shù) = （批次總預(yù)算 max_amount）/ （優(yōu)惠金額 discount_amount））
3）如滿減券單天發(fā)放控制同時(shí)傳入“max_amount_by_day
（單天發(fā)放上限金額）”與“max_coupons_by_day（單天發(fā)放上限個(gè)數(shù)）”，則使用“max_coupons_by_day（單天發(fā)放上限個(gè)數(shù)）”做滿減券單天發(fā)放庫(kù)存控制；4）如滿減券單天發(fā)放控制僅傳入“max_amount_by_day
（單天發(fā)放上限金額）”，則使用“max_amount_by_day
（單天發(fā)放上限金額）”做滿減券單天發(fā)放庫(kù)存控制；（即單天最大可發(fā)放個(gè)數(shù)=（單天發(fā)放上限金額max_amount_by_day）/ （優(yōu)惠金額 discount_amount））
新策略上線后，為確保存量批次正常使用，批次查詢接口保留返回max_amount（批次總預(yù)算）與max_amount_by_day（單天發(fā)放上限金額）字段返回。
說(shuō)明：折扣券與換購(gòu)券不做調(diào)整， 依然保持為
折扣券&換購(gòu)券最大可發(fā)放個(gè)數(shù) = 批次最大發(fā)放個(gè)數(shù) max_coupons
接口說(shuō)明
適用對(duì)象：直連商戶 服務(wù)商 渠道商
請(qǐng)求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks
請(qǐng)求方式：POST
接口規(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傳參
請(qǐng)求參數(shù)
| 參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商家券批次名稱(chēng) | stock_name | string[1,21] | 是 | body 批次名稱(chēng)，字?jǐn)?shù)上限為21個(gè)，一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值：8月1日活動(dòng)券 |
| 批次歸屬商戶號(hào) | belong_merchant | string[8,15] | 是 | body 批次歸屬于哪個(gè)商戶。 示例值：10000022 |
| 批次備注 | comment | string[1,20] | 否 | body 僅配置商戶可見(jiàn)，用于自定義信息。字?jǐn)?shù)上限為20個(gè)，一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值：活動(dòng)使用 |
| 適用商品范圍 | goods_name | string[1,15] | 是 | body 用來(lái)描述批次在哪些商品可用，會(huì)顯示在微信卡包中。字?jǐn)?shù)上限為15個(gè)，一個(gè)中文漢字/英文字母/數(shù)字均占用一個(gè)字?jǐn)?shù)。 示例值：xxx商品使用 |
| 批次類(lèi)型 | stock_type | string[1,32] | 是 | body 批次類(lèi)型 NORMAL：固定面額滿減券批次 DISCOUNT：折扣券批次 EXCHANGE：換購(gòu)券批次 示例值：NORMAL |
| +核銷(xiāo)規(guī)則 | coupon_use_rule | object | 是 | body 券核銷(xiāo)相關(guān)規(guī)則 |
| +發(fā)放規(guī)則 | stock_send_rule | object | 是 | body 券發(fā)放相關(guān)規(guī)則 |
| 商戶請(qǐng)求單號(hào) | out_request_no | string[1,128] | 是 | body 商戶創(chuàng)建批次憑據(jù)號(hào)（格式：商戶id+日期+流水號(hào)），商戶側(cè)需保持唯一性。 示例值：100002322019090134234sfdf |
| +自定義入口 | custom_entrance | object | 否 | body 卡詳情頁(yè)面，可選擇多種入口引導(dǎo)用戶。 |
| +樣式信息 | display_pattern_info | object | 否 | body 創(chuàng)建批次時(shí)的樣式信息。 |
| 券code模式 | coupon_code_mode | string[1,128] | 是 | body 枚舉值： WECHATPAY_MODE：系統(tǒng)分配券code。（固定22位純數(shù)字） MERCHANT_API：商戶發(fā)放時(shí)接口指定券code。 MERCHANT_UPLOAD：商戶上傳自定義code，發(fā)券時(shí)系統(tǒng)隨機(jī)選取上傳的券code。 示例值：WECHATPAY_MODE |
| +事件通知配置 | notify_config | object | 否 | body 事件回調(diào)通知商戶的配置。 |
卡券背景顏色圖
請(qǐng)求示例
{
"stock_name":"8月1日活動(dòng)券",
"belong_merchant":"10000098",
"comment": "活動(dòng)使用",
"goods_name": "填寫(xiě)代金券可適用的商品或服務(wù)",
"stock_type": "NORMAL",
"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,
"wait_days_after_receive":7,
"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"
},
"stock_send_rule": {
"max_coupons": 100,
"max_coupons_per_user": 5,
"max_coupons_by_day": 100,
"natural_person_limit": "false",
"prevent_api_abuse": "false",
"transferable": "false",
"shareable": "false"
},
"out_request_no": "100002322019090134234sfdf",
"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"
},
"display_pattern_info": {
"description": "xxx門(mén)店可用",
"merchant_logo_url": "https://xxx",
"merchant_name": "微信支付",
"background_color": "xxxxx",
"coupon_image_url": "圖片cdn地址"
},
"coupon_code_mode": "WECHATPAY_MODE"
}
返回參數(shù)
| 參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次號(hào) | stock_id | string[1,20] | 是 | 微信為每個(gè)商家券批次分配的唯一ID。 示例值：98065001 |
| 創(chuàng)建時(shí)間 | create_time | string[1,32] | 是 | 創(chuà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 |
返回示例
{
"stock_id": "98065001",
"create_time": "2015-05-20T13:29:35+08:00"
}
跳轉(zhuǎn)小程序帶參數(shù)說(shuō)明
如果商家券配置了跳轉(zhuǎn)小程序的入口（包括立即使用以及自定義入口），跳轉(zhuǎn)鏈接會(huì)帶有批次號(hào)、openid以及加密的code，解密方式可參考解密說(shuō)明。
/path/index/index.html?stock_id=128695000000007&openid=o7tgX0RiTlJo9IXVVfemjFSlFMo4&nonce=B9Jr9gtzMSs7&associate=COUPON_CODE&ciphertext=nmARA5zbjlL%2FaCiKN7S3h1z%2FGhmCfNW9IGQHX6XqTR3zYzQ43sQ%3D
錯(cuò)誤碼公共錯(cuò)誤碼
| 狀態(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ò)查詢?nèi)疉PI確認(rèn)券是否已被其他訂單核銷(xiāo) | ||
| 404 | RESOURCE_NOT_EXISTS | 查詢的資源不存在 | 請(qǐng)檢查查詢資源的對(duì)應(yīng)id是否填寫(xiě)正確 |
| 403 | NOAUTH | 無(wú)權(quán)限 | 查看具體錯(cuò)誤信息，確認(rèn)是否有權(quán)限 |
| 400 | APPID_MCHID_NOT_MATCH | appid與請(qǐng)求方商戶無(wú)關(guān)聯(lián)關(guān)系 | appid與請(qǐng)求方商戶不匹配，請(qǐng)確認(rèn)appid與請(qǐng)求方商戶是否有關(guān)聯(lián)關(guān)系 |
| 400 | MCH_NOT_EXISTS | 商戶號(hào)不存在 | 請(qǐng)確認(rèn)傳入的商戶號(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è)新的批次后重試 |