商戶自定義篩選條件(如創(chuàng)建商戶號、歸屬商戶號、發(fā)放商戶號等),查詢指定微信用戶卡包中滿足對應條件的所有商家券信息。
# 接口說明
支持商戶:
【普通服務商】【渠道商】
請求方式:
【GET】/v3/marketing/busifavor/users/{openid}/coupons
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設置為
application/json
Header HTTP頭參數(shù)
- openid 必填 string【用戶標識】 Openid信息,用戶在AppID下的唯一標識。
校驗規(guī)則:傳入的OpenID得是調(diào)用方商戶號(即請求頭里面的商戶號)有綁定關系的AppID獲取的OpenID或傳入的OpenID得是歸屬商戶號有綁定關系的AppID獲取的OpenID。獲取OpenID文檔
Path 路徑參數(shù)
- appid 必填 string【公眾賬號ID】 支持傳入與當前調(diào)用接口商戶號有綁定關系的AppID。支持小程序AppID與公眾號AppID。
校驗規(guī)則:傳入的AppID得是與調(diào)用方商戶號(即請求頭里面的商戶號)有綁定關系的AppID 或 傳入的AppID得是歸屬商戶號有綁定關系的AppID - stock_id 選填 string【批次號】 批次號,是否指定批次號查詢
- creator_merchant 選填 string【創(chuàng)建批次的商戶號】 批次創(chuàng)建方商戶號
校驗規(guī)則:當調(diào)用方商戶號(即請求頭中的商戶號)為創(chuàng)建批次方商戶號時,該參數(shù)必傳 - belong_merchant 選填 string【批次歸屬商戶號】 批次歸屬商戶號
校驗規(guī)則:當調(diào)用方商戶號(即請求頭中的商戶號)為批次歸屬商戶號時,該參數(shù)必傳 - sender_merchant 選填 string【批次發(fā)放商戶號】 批次發(fā)放商戶號
校驗規(guī)則:當調(diào)用方商戶號(即請求頭中的商戶號)為批次發(fā)放商戶號時,該參數(shù)必傳;委托營銷關系下,請?zhí)顚懳邪l(fā)券的商戶號 - offset 選填 integer【分頁頁碼】 分頁頁碼
- limit 選填 integer【分頁大小】 分頁大小
- coupon_state 選填 string【券狀態(tài)】 商家券狀態(tài)
可選取值:SENDED
: 可用USED
: 已核銷EXPIRED
: 已過期DELETED
: 已刪除DEACTIVATED
: 已失效
Query 查詢參數(shù)
請求示例
GET
# 應答參數(shù)
- data 選填 array[CouponEntity]【結果集】
- 屬性
- total_count 必填 integer【總數(shù)量】 總數(shù)量
- limit 必填 integer【分頁大小】 分頁大小
- offset 必填 integer【分頁頁碼】 分頁頁碼
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è)務錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | AppID與請求方商戶無關聯(lián)關系 | AppID與請求方商戶不匹配,請確認AppID與請求方商戶是否有關聯(lián)關系 |
400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請更換支持預上傳code的批次后重試 |
400 | INVALID_REQUEST | 上傳的自定義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 | 無權限 | 查看具體錯誤信息,確認是否有權限 |
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)絡超時引起,重試 |