商戶可以通過該接口創(chuàng)建商家券。微信支付生成商家券批次后并返回商家券批次號給到商戶,商戶可調(diào)用發(fā)券接口【小程序發(fā)券】 (opens new window)、【H5發(fā)券】 (opens new window)發(fā)放該批次商家券。
頻率限制:接口級限制1000/min
# 接口說明
支持商戶:
【普通服務(wù)商】【渠道商】
請求方式:
【POST】/v3/marketing/busifavor/stocks
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設(shè)置為
application/json
- Content-Type 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- stock_name 必填 string(21)【商家券批次名稱】 批次名稱,字數(shù)上限為21個,一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。
- belong_merchant 必填 string(15)【批次歸屬商戶號】 批次歸屬于哪個商戶。
注:
普通直連模式,該參數(shù)為直連商戶號;
服務(wù)商模式,該參數(shù)為子商戶號;
間連模式,該參數(shù)為子商戶號。 - comment 選填 string(20)【批次備注】 僅配置商戶可見,用于自定義信息。字數(shù)上限為20個,一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。
- goods_name 必填 string(15)【適用商品范圍】 用來描述批次在哪些商品可用,會顯示在微信卡包中。字數(shù)上限為15個,一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。
- stock_type 必填 string【批次類型】 批次類型
可選取值:NORMAL
: 固定面額滿減券批次DISCOUNT
: 折扣券批次EXCHANGE
: 換購券批次
- coupon_use_rule 必填 CouponUseRule【核銷規(guī)則】 券核銷相關(guān)規(guī)則
- 屬性
- stock_send_rule 必填 StockSendRule【發(fā)放規(guī)則】 券發(fā)放相關(guān)規(guī)則
- 屬性
- out_request_no 必填 string(128)【商戶請求單號】 商戶創(chuàng)建批次憑據(jù)號(格式:商戶ID+日期+流水號),商戶側(cè)需保持唯一性
- custom_entrance 選填 CustomEntrance【自定義入口】 卡詳情頁面,可選擇多種入口引導用戶
- 屬性
- display_pattern_info 選填 DisplayPatternInfo【樣式信息】 創(chuàng)建批次時的樣式信息。
- 屬性
- coupon_code_mode 必填 string【券code模式】 特殊規(guī)則:
1、券code模式為WECHATPAY_MODE時,是微信自動分配券code,商戶不需要預存code;適用于多種場景
2、券code模式為MERCHANT_API時,無需調(diào)用上傳預存code接口,調(diào)用發(fā)券接口時需指定券code;更多用在商家自有流量場景(例如:商家自有小程序、H5網(wǎng)頁等)
3、券code模式為MERCHANT_UPLOAD,需要調(diào)用上傳預存code接口上傳code,調(diào)用發(fā)券接口時無需指定code;更多適用在微信支付平臺流量場景(例如:支付有禮、支付有優(yōu)惠等)
可選取值:WECHATPAY_MODE
: 系統(tǒng)分配code,商戶無需額外操作MERCHANT_API
: 商戶發(fā)放時接口指定券codeMERCHANT_UPLOAD
: 商戶上傳自定義code,發(fā)券時系統(tǒng)隨機選取上傳的券code
- notify_config 選填 NotifyConfig【事件通知配置】 事件回調(diào)通知商戶的配置
- 屬性
- subsidy 選填 boolean【是否允許營銷補差】 該批次發(fā)放的券是否允許進行補差,默認為false
注:該字段暫未開放
Body 包體參數(shù)
請求示例
POST
# 應答參數(shù)
- stock_id 必填 string【批次號】 批次號
- create_time 必填 string【創(chuàng)建時間】 創(chuàng)建時間,遵循rfc3339
標準格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時分秒,TIMEZONE表示時區(qū)(+08:00表示東八區(qū)時間,領(lǐng)先UTC 8小時,即北京時間)。例如:2015-05-20T13:29:35+08:00表示,北京時間2015年5月20日 13點29分35秒。
200OK
應答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | AppID與請求方商戶無關(guān)聯(lián)關(guān)系 | AppID與請求方商戶不匹配,請確認AppID與請求方商戶是否有關(guān)聯(lián)關(guān)系 |
400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請更換支持預上傳code的批次后重試 |
400 | MCH_NOT_EXISTS | 商戶號不存在 | 請確認傳入的商戶號是否正確 |
400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重復使用 |
400 | RESOURCE_ALREADY_EXISTS | 券已被其他訂單核銷 | 請通過查詢?nèi)疉PI確認券是否已被其他訂單核銷 |
400 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請使用相同參數(shù)稍后重新調(diào)用 |
403 | NOAUTH | 無權(quán)限 | 查看具體錯誤信息,確認是否有權(quán)限 |
403 | RULELIMIT | 券不在有效期 | 請確認券是否能在當前時間核銷 |
404 | RESOURCE_NOT_EXISTS | 查詢的資源不存在 | 請檢查查詢資源的對應ID是否填寫正確 |
404 | USER_NOT_EXISTS | OpenID不正確 | 請確認傳入的OpenID是否正確 |
429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁,請降低調(diào)用接口頻率 |
500 | SYSTEM_ERROR | 系統(tǒng)失敗 | 多為網(wǎng)絡(luò)超時引起,重試 |