最新更新時(shí)間：2019.09.27 版本說(shuō)明
通過(guò)此接口可查詢批次信息，包括批次的配置信息以及批次概況數(shù)據(jù)。
? 該接口支持批次創(chuàng)建商戶號(hào)與批次發(fā)放商戶調(diào)用
適用對(duì)象：直連商戶
請(qǐng)求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}
請(qǐng)求方式：GET
接口頻率：不區(qū)分來(lái)源 1000/s 單ip 500/s
接口耗時(shí)：1S
冪等規(guī)則：接口支持冪等重入
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請(qǐng)求URL傳參
body 指該參數(shù)需在請(qǐng)求JSON傳參
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次號(hào) | stock_id | string[1,20] | 是 | path微信為每個(gè)代金券批次分配的唯一id。 示例值：9856888 |
| 創(chuàng)建批次的商戶號(hào) | stock_creator_mchid | string[1,20] | 是 | query 批次創(chuàng)建時(shí)的商戶號(hào)。 校驗(yàn)規(guī)則：接口傳入的批次號(hào)需由stock_creator_mchid所創(chuàng)建。 示例值：123456 |
https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/9856888?stock_creator_mchid=123456
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次號(hào) | stock_id | string[1,20] | 是 | 微信為每個(gè)代金券批次分配的唯一id。 示例值：9836588 |
| 創(chuàng)建批次的商戶號(hào) | stock_creator_mchid | string[1,20] | 是 | 批次創(chuàng)建方商戶號(hào)。 示例值：123456 |
| 批次名稱 | stock_name | string[1,20] | 是 | 批次名稱 示例值：微信支付批次 |
| 批次狀態(tài) | status | string[1,12] | 是 | 批次狀態(tài) 枚舉值： unactivated：未激活 audit：審核中 running：運(yùn)行中 stoped：已停止 paused：暫停發(fā)放 示例值：paused |
| 創(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 |
| 使用說(shuō)明 | description | string[1,3000] | 是 | 批次描述信息 示例值：微信支付營(yíng)銷 |
| +滿減券批次使用規(guī)則 | stock_use_rule | object |
否 | 普通發(fā)券批次特定信息。 示例值：1900000109 |
| 可用開(kāi)始時(shí)間 | available_begin_time | string[1,32] | 是 | 可用開(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秒。 示例值：2015-05-20T13:29:35+08:00 |
| 可用結(jié)束時(shí)間 | available_end_time | string[1,32] | 是 | 可用結(jié)束時(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ā)券數(shù)量 | distributed_coupons | uint32 | 是 | 已發(fā)券數(shù)量 示例值：100 |
| 是否無(wú)資金流 | no_cash | bool | 是 | 是否無(wú)資金流。 ture：是 false：否 示例值：true |
| 激活批次的時(shí)間 | start_time | string[1,32] | 否 | 批次激活開(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秒。 示例值：2015-05-20T13:29:35+08:00 |
| 終止批次的時(shí)間 | stop_time | string[1,32] | 否 | 批次永久停止時(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 |
| + 單品優(yōu)惠特定信息 | cut_to_message | object |
否 | 單品優(yōu)惠特定信息。 |
| 是否單品優(yōu)惠 | singleitem | bool | 是 | 枚舉值： true：是 false：否 示例值：true |
| 批次類型 | stock_type | string[1,16] | 是 | 批次類型，
枚舉值： NORMAL：代金券批次 DISCOUNT_CUT：立減與折扣 OTHER：其他 示例值：NORMAL |
{
"stock_id": "9836588",
"stock_creator_mchid": "123456",
"stock_name": "微信支付批次",
"status": "paused",
"create_time": "2015-05-20T13:29:35+08:00",
"description": "微信支付營(yíng)銷",
"stock_use_rule": {
"max_coupons": 100,
"max_amount": 5000,
"max_amount_by_day": 400,
"max_coupons_per_user": 3,
"trade_type": ["OTHER","APPPAY"]
},
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"distributed_coupons": 100,
"no_cash": true,
"cut_to_message": {
"single_price_max": 100,
"cut_to_price": 5000
},
"singleitem": true,
"stock_type": "NORMAL"
}
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回調(diào)url不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)url |
| PARAM_ERROR | 回調(diào)商戶不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)商戶 | |
| PARAM_ERROR | 券id必填 | 請(qǐng)?zhí)顚懭痠d | |
| PARAM_ERROR | appid必填 | 請(qǐng)輸入appid | |
| PARAM_ERROR | openid必填 | 請(qǐng)輸入openid | |
| PARAM_ERROR | 頁(yè)大小超過(guò)閾值 | 請(qǐng)不要超過(guò)最大的頁(yè)大小 | |
| PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請(qǐng)輸入正確的時(shí)間格式 | |
| PARAM_ERROR | 批次號(hào)必填 | 請(qǐng)輸入批次號(hào) | |
| PARAM_ERROR | 商戶號(hào)必填 | 請(qǐng)輸入商戶號(hào) | |
| PARAM_ERROR | 非法的批次狀態(tài) | 請(qǐng)檢查批次狀態(tài) | |
| 400 | MCH_NOT_EXISTS | 商戶號(hào)不合法 | 請(qǐng)輸入正確的商戶號(hào) |
| 400 | INVALID_REQUEST | openid與appid不匹配 | 請(qǐng)使用appid下的openid |
| INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請(qǐng)檢查批次狀態(tài) | |
| INVALID_REQUEST | 非法的商戶號(hào) | 請(qǐng)檢查商戶號(hào)是否正確 | |
| 400 | APPID_MCHID_NOT_MATCH | 商戶號(hào)與appid不匹配 | 請(qǐng)綁定調(diào)用接口的商戶號(hào)和appid后重試 |
| 403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號(hào)異常，無(wú)法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
| 403 | NOT_ENOUGH | 批次預(yù)算不足 | 請(qǐng)補(bǔ)充預(yù)算 |
| 403 | REQUEST_BLOCKED | 調(diào)用商戶無(wú)權(quán)限 | 請(qǐng)開(kāi)通產(chǎn)品權(quán)限后再調(diào)用該接口 |
| REQUEST_BLOCKED | 商戶無(wú)權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無(wú)權(quán)發(fā)券，請(qǐng)檢查是否是自己的批次或是已授權(quán)的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號(hào)的授權(quán)，請(qǐng)授權(quán)后再發(fā)放 | |
| REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限，請(qǐng)調(diào)高上限或停止發(fā)放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請(qǐng)檢查批次ID是否正確 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請(qǐng)降低調(diào)用頻率 |