接口說明
適用對象：直連商戶 服務(wù)商 渠道商
請求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
請求方式：GET
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求URL傳參
body 指該參數(shù)需在請求JSON傳參
請求參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次號 | stock_id | string[1,20] | 是 | path 微信為每個商家券批次分配的唯一ID 示例值：1212 |
請求示例
https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/1212
返回參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商家券批次名稱 | stock_name | string[1,21] | 是 | 批次名稱，字數(shù)上限為21個，一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。 示例值：8月1日活動券 |
| 批次歸屬商戶號 | belong_merchant | string[8,15] | 是 | 批次歸屬于哪個商戶。 示例值：10000022 |
| 批次備注 | comment | string[1,20] | 否 | 僅配置商戶可見，用于自定義信息。字數(shù)上限為20個，一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。 示例值：活動使用 |
| 適用商品范圍 | goods_name | string[1,15] | 是 | 用來描述批次在哪些商品可用，會顯示在微信卡包中。字數(shù)上限為15個，一個中文漢字/英文字母/數(shù)字均占用一個字數(shù)。 示例值：xxx商品使用 |
| 批次類型 | stock_type | string[1,16] | 是 | 批次類型 NORMAL：固定面額滿減券批次 DISCOUNT：折扣券批次 EXCHANGE：換購券批次 示例值：NORMAL |
| +核銷規(guī)則 | coupon_use_rule | object | 是 | 券核銷相關(guān)規(guī)則 |
| +發(fā)放規(guī)則 | stock_send_rule | object | 是 | 券發(fā)放相關(guān)規(guī)則 |
| +自定義入口 | custom_entrance | object | 否 | 卡詳情頁面，可選擇多種入口引導(dǎo)用戶。 |
| +樣式信息 | display_pattern_info | object | 否 | 創(chuàng)建批次時的樣式信息。 |
| 批次狀態(tài) | stock_state | string[1,128] | 是 | 批次狀態(tài)
示例值：RUNNING |
| 券code模式 | coupon_code_mode | string[1,128] | 是 | 枚舉值： WECHATPAY_MODE：系統(tǒng)分配券code。 MERCHANT_API：商戶發(fā)放時接口指定券code。 MERCHANT_UPLOAD：商戶上傳自定義code，發(fā)券時系統(tǒng)隨機選取上傳的券code。 示例值：WECHATPAY_MODE |
| 批次號 | stock_id | string[1,20] | 是 | 微信為每個商家券批次分配的唯一ID。 示例值：1212 |
| +券code數(shù)量 | coupon_code_count | object | 否 | 當且僅當coupon_code_mode（券code模式）為MERCHANT_UPLOAD（商戶上傳自定義code）模式時，返回該字段，返回內(nèi)容為商戶上傳code的數(shù)量信息。 |
| +事件通知配置 | notify_config | object | 否 | query事件回調(diào)通知商戶的配置。 |
| +批次發(fā)放情況 | send_count_information | object | 否 | query批次發(fā)放情況 |
卡券背景顏色圖
返回示例
{
"stock_name": "8月1日活動券",
"belong_merchant": "10000022",
"comment": "xxx店使用",
"goods_name": "xxx商品使用",
"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,
"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_amount": 100000,
"max_coupons": 100,
"max_coupons_per_user": 5,
"max_amount_by_day": 1000,
"max_coupons_by_day": 100,
"natural_person_limit": "false",
"prevent_api_abuse": "false",
"transferable": "false",
"shareable": "false"
},
"custom_entrance": {
"mini_programs_info": {
"mini_programs_appid": "wx234545656765876",
"mini_programs_path": "/path/index/index",
"entrance_words": "歡迎選購",
"guiding_words": "獲取更多優(yōu)惠"
},
"appid": "wx324345hgfhfghfg",
"hall_id": "233455656",
"store_id": "233554655"
},
"display_pattern_info": {
"description": "xxx門店可用",
"merchant_logo_url": "https://xxx",
"merchant_name": "微信支付",
"background_color": "xxxxx",
"coupon_image_url": "圖片cdn地址"
},
"stock_state": "RUNNING",
"coupon_code_mode": "MERCHANT_UPLOAD",
"stock_id": "1212",
"coupon_code_count": {
"total_count": 100,
"available_count": 50
}
}
錯誤碼公共錯誤碼
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 參數(shù)錯誤 | 查看具體錯誤信息，調(diào)整參數(shù) |
| 400 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請使用相同參數(shù)稍后重新調(diào)用 |
| 400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重復(fù)使用 |
| 券已被其他訂單核銷 | 請通過查詢?nèi)疉PI確認券是否已被其他訂單核銷 | ||
| 404 | RESOURCE_NOT_EXISTS | 查詢的資源不存在 | 請檢查查詢資源的對應(yīng)id是否填寫正確 |
| 403 | NOAUTH | 無權(quán)限 | 查看具體錯誤信息，確認是否有權(quán)限 |
| 400 | APPID_MCHID_NOT_MATCH | appid與請求方商戶無關(guān)聯(lián)關(guān)系 | appid與請求方商戶不匹配，請確認appid與請求方商戶是否有關(guān)聯(lián)關(guān)系 |
| 400 | MCH_NOT_EXISTS | 商戶號不存在 | 請確認傳入的商戶號是否正確 |
| 404 | USER_NOT_EXISTS | openid不正確 | 請確認傳入的openid是否正確 |
| 500 | SYSTEM_ERROR | 系統(tǒng)失敗 | 多為網(wǎng)絡(luò)超時引起，重試 |
| 429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁，請降低調(diào)用接口頻率 |
| 403 | RULELIMIT | 券不在有效期 | 請確認券是否能在當前時間核銷 |
| 400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請更換支持預(yù)上傳code的批次后重試 |
| 上傳的自定義code已達上限 | 請更換一個新的批次后重試 |