最新更新時(shí)間:2019.09.29 版本說明
可通過該接口查詢用戶在某商戶號可用的全部券,可用于商戶的小程序/H5中,用戶"我的代金券"或"提交訂單頁"展示優(yōu)惠信息。無法查詢到微信支付立減金。本接口查不到用戶的微信支付立減金(又稱“全平臺通用券”),即在所有商戶都可以使用的券,例如:搖搖樂紅包;當(dāng)按可用商戶號查詢時(shí),無法查詢用戶已經(jīng)核銷的券
適用對象:服務(wù)商
請求URL:https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
請求方式:GET
接口頻率:不區(qū)分來源 2000/s 單ip 500/s
接口耗時(shí):平均100ms以內(nèi)
冪等規(guī)則:接口支持冪等重入
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求URL傳參
body 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
用戶標(biāo)識 | openid | string[1,128] | 是 | path 用戶在商戶appid 下的唯一標(biāo)識。 校驗(yàn)規(guī)則:該openid需要與接口傳入中的appid有對應(yīng)關(guān)系。 示例值:2323dfsdf342342 |
公眾賬號ID | appid | string[1,128] | 是 | query 微信為發(fā)券方商戶分配的公眾賬號ID,接口傳入的所有appid應(yīng)該為公眾號的appid(在mp.weixin.qq.com申請的)或APP的appid(在open.weixin.qq.com申請的)。 校驗(yàn)規(guī)則: 1、該appid需要與接口傳入中的openid有對應(yīng)關(guān)系; 2、該appid需要與調(diào)用接口的商戶號(即請求頭中的商戶號)有綁定關(guān)系,若未綁定,可參考該指引完成綁定(商家商戶號與AppID賬號關(guān)聯(lián)管理) 示例值:wx233544546545989 |
批次號 | stock_id | string[1,20] | 否 | query 批次號,是否指定批次號查詢,填寫available_mchid,該字段不生效。 示例值:9865000 |
券狀態(tài) | status | string[1,20] | 否 | query 代金券狀態(tài): 選填creator_mchid時(shí), SENDED:返回可用 USED:返回可用+已實(shí)扣 選填available_mchid時(shí),該字段不生效,僅返回 可用 狀態(tài)的券。 示例值:SENDED |
創(chuàng)建批次的商戶號 | creator_mchid | string[1,20] | 三選一 | query 批次創(chuàng)建方商戶號。 示例值:9865002 請求參數(shù)傳創(chuàng)建商戶號返回除過期以外所有狀態(tài)的用戶券 |
批次發(fā)放商戶號 | sender_mchid | string[1,20] | query 批次發(fā)放商戶號 (該字段暫未開放 ) 示例值:9865001 |
|
可用商戶號 | available_mchid | string[1,20] | query 可用商戶號 示例值: 9865000 請求參數(shù)傳核銷商戶號只能返回可用的代金券,實(shí)扣的與過期的無法返回 |
|
分頁頁碼 | offset | uint32 | 否 | query 分頁頁碼,默認(rèn)0,填寫available_mchid,該字段不生效。 示例值:0 |
分頁大小 | limit | uint32 | 否 | query 分頁大小,默認(rèn)20,填寫available_mchid,該字段不生效。 示例值:20 |
https://api.mch.weixin.qq.com/v3/marketing/favor/users/2323dfsdf342342/coupons?appid=wx233544546545989
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
+結(jié)果集 | data | array |
否 | 結(jié)果集 |
查詢結(jié)果總數(shù) | total_count | uint32 | 是 | 查詢結(jié)果總數(shù) 示例值:100 |
分頁大小 | limit | uint32 | 是 | 分頁大小 示例值:10 |
分頁頁碼 | offset | uint32 | 是 | 分頁頁碼 示例值:10 |
{
"data": [{
"stock_creator_mchid": "9800064",
"stock_id": "9865888",
"coupon_id": "98674556",
"cut_to_message": {
"single_price_max": 100,
"cut_to_price":100
},
"coupon_name": "微信支付代金券",
"status": "SENDED",
"description": "微信支付營銷",
"create_time": "2015-05-20T13:29:35+08:00",
"coupon_type": "CUT_TO",
"no_cash": true,
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"singleitem": true,
"normal_coupon_information": {
"coupon_amount": 100,
"transaction_minimum": 100
},
"consume_information": {
"consume_time": "2015-05-20T13:29:35+08:00",
"consume_mchid": "9856081",
"transaction_id": "2345234523",
"goods_detail": [{
"goods_id": "a_goods1",
"quantity": 7,
"price": 1,
"discount_amount": 4
}]
}
}],
"total_count": 100,
"limit": 10,
"offset": 10
}
狀態(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)用頻率 |