接口說明
適用對象：直連商戶 服務(wù)商 渠道商
請求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/coupon-stocks
請求方式：POST
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
接口頻率：單個(gè)商戶號調(diào)用頻率60/min，所有商戶號調(diào)用頻率為1000/min
接口耗時(shí)：80ms
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求URL傳參
body 指該參數(shù)需在請求JSON傳參
請求參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次名稱 | stock_name | string[1,20] | 是 | body 批次名稱 校驗(yàn)規(guī)則： 1、批次名稱最多9個(gè)中文漢字 2、批次名稱最多20個(gè)字母 3、批次名稱中不能包含不當(dāng)內(nèi)容和特殊字符 _ , ; | 示例值：微信支付代金券批次 |
| 批次備注 | comment | string[1,60] | 否 | body 僅制券商戶可見，用于自定義信息。 校驗(yàn)規(guī)則：批次備注最多60個(gè)UTF8字符數(shù) 示例值：零售批次 |
| 歸屬商戶號 | belong_merchant | string[1,20] | 是 | body 批次歸屬商戶號 該字段暫未開放 示例值：98568865 |
| 可用時(shí)間-開始時(shí)間 | available_begin_time | string[1,32] | 是 | body 批次開始時(shí)間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時(shí)分秒毫秒，TIMEZONE表示時(shí)區(qū)（+08:00表示東八區(qū)時(shí)間，領(lǐng)先UTC 8小時(shí)，即北京時(shí)間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 校驗(yàn)規(guī)則： 1、開始時(shí)間不可早于當(dāng)前時(shí)間 2、不能創(chuàng)建365天后開始的批次 示例值：2015-05-20T13:29:35.120+08:00 |
| 可用時(shí)間-結(jié)束時(shí)間 | available_end_time | string[1,32] | 是 | body 批次結(jié)束時(shí)間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時(shí)分秒毫秒，TIMEZONE表示時(shí)區(qū)（+08:00表示東八區(qū)時(shí)間，領(lǐng)先UTC 8小時(shí)，即北京時(shí)間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 校驗(yàn)規(guī)則： 1、結(jié)束時(shí)間需晚于開始時(shí)間 2、可用時(shí)間最長為90天 3、有效時(shí)間間隔最短為1s 示例值：2015-05-20T13:29:35.120+08:00 |
| +發(fā)放規(guī)則 | stock_use_rule | object | 是 | body 批次使用規(guī)則 |
| +樣式設(shè)置 | pattern_info | object | 否 | body 代金券詳情頁 |
| +核銷規(guī)則 | coupon_use_rule | object | 是 | body 核銷規(guī)則 |
| 營銷經(jīng)費(fèi) | no_cash | bool | 是 | body 營銷經(jīng)費(fèi)。枚舉值： |
| 批次類型 | stock_type | string[1,16] | 是 | body 批次類型，僅支持： |
| 商戶單據(jù)號 | out_request_no | string[1,128] | 是 | body 商戶創(chuàng)建批次憑據(jù)號（格式：商戶id+日期+流水號），可包含英文字母，數(shù)字，|，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號，商戶側(cè)需保持商戶單據(jù)號全局唯一。 |
| 擴(kuò)展屬性 | ext_info | string[1,128] | 否 | body 擴(kuò)展屬性字段，按json格式，如無需要?jiǎng)t不填寫。 示例值：{'exinfo1':'1234','exinfo2':'3456'} |
卡券背景顏色圖
請求示例
{
"stock_name": "微信支付代金券批次",
"comment": "零售批次",
"belong_merchant": "98568865",
"available_begin_time": "2015-05-20T13:29:35.120+08:00",
"available_end_time": "2015-05-20T13:29:35.120+08:00",
" stock_use_rule": {
"max_coupons": 100,
"max_amount": 5000,
"max_amount_by_day": 400,
"max_coupons_per_user": 3,
"natural_person_limit": false,
"prevent_api_abuse": false
},
"pattern_info": {
"description": "微信支付營銷代金券",
"merchant_logo": "CDN地址",
"merchant_name": "微信支付",
" background_color": "色號",
" coupon_image ": "圖片cdn地址"
},
"coupon_use_rule": {
"coupon_available_time": {
"fix_available_time": {
" available_week_day ": [
1
],
" begin_time ": 0,
" end_time ": 3600
},
"second_day_available": false,
"available_time_after_receive": 1440
},
" fixed_normal_coupon ": {
" coupon_amount": 50,
"transaction_minimum": 100
},
"goods_tag": [
"123321",
"123322"
],
"trade_type": ["OTHER","APPPAY"],
"combine_use": false,
"available_items": [
"123321",
"123322"
],
"available_merchants": [
"9856000",
"9856001"
]
},
"no_cash": false,
"stock_type": "NORMAL",
"out_request_no": ""
}
返回參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次號 | 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.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時(shí)分秒毫秒，TIMEZONE表示時(shí)區(qū)（+08:00表示東八區(qū)時(shí)間，領(lǐng)先UTC 8小時(shí)，即北京時(shí)間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值：2015-05-20T13:29:35.120+08:00 |
返回示例
{
"stock_id": "98065001",
"create_time": "2015-05-20T13:29:35.120+08:00"
}
錯(cuò)誤碼公共錯(cuò)誤碼
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回調(diào)url不能為空 | 請?zhí)顚懟卣{(diào)url |
| PARAM_ERROR | 回調(diào)商戶不能為空 | 請?zhí)顚懟卣{(diào)商戶 | |
| PARAM_ERROR | 券id必填 | 請?zhí)顚懭痠d | |
| PARAM_ERROR | appid必填 | 請輸入appid | |
| PARAM_ERROR | openid必填 | 請輸入openid | |
| PARAM_ERROR | 頁大小超過閾值 | 請不要超過最大的頁大小 | |
| PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請輸入正確的時(shí)間格式 | |
| PARAM_ERROR | 批次號必填 | 請輸入批次號 | |
| PARAM_ERROR | 商戶號必填 | 請輸入商戶號 | |
| PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài) | |
| 400 | MCH_NOT_EXISTS | 商戶號不合法 | 請輸入正確的商戶號 |
| 400 | INVALID_REQUEST | openid與appID不匹配 | 請使用appID下的的openid |
| INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請檢查批次狀態(tài) | |
| INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號是否正確 | |
| 400 | APPID_MCHID_NOT_MATCH | 商戶號與appid不匹配 | 請綁定調(diào)用接口的商戶號和APPID后重試 |
| 403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號異常，無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
| 403 | NOT_ENOUGH | 批次預(yù)算不足 | 請補(bǔ)充預(yù)算 |
| 403 | REQUEST_BLOCKED | 調(diào)用商戶無權(quán)限 | 請開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
| REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號無權(quán)發(fā)券，請檢查是否是自己的批次或是已授權(quán)的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號的授權(quán)，請授權(quán)后再發(fā)放 | |
| REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限，請調(diào)高上限或停止發(fā)放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次ID是否正確 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請降低調(diào)用頻率 |