根據過濾條件查詢用戶券API
最新更新時間：2020.07.24 版本說明
商戶自定義篩選條件（如創(chuàng)建商戶號、歸屬商戶號、發(fā)放商戶號等），查詢指定微信用戶卡包中滿足對應條件的所有商家券信息。
接口說明
適用對象：直連商戶 服務商 渠道商
請求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons
請求方式：GET
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path 指該參數為路徑參數
query 指該參數需在請求URL傳參
body 指該參數需在請求JSON傳參
請求參數
| 參數名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 用戶標識 | openid | string[1,128] | 是 | path Openid信息，用戶在appid下的唯一標識。 示例值：2323dfsdf342342 |
| 公眾賬號ID | appid | string[1,32] | 是 | query 支持傳入與當前調用接口商戶號有綁定關系的appid。支持小程序appid與公眾號appid。 示例值：wx233544546545989 |
| 批次號 | stock_id | string[1,20] | 否 | query 微信為每個商家券批次分配的唯一ID，是否指定批次號查詢。 示例值：9865000 |
| 券狀態(tài) | coupon_state | string[1,16] | 否 | query 券狀態(tài) 枚舉值： |
| 創(chuàng)建批次的商戶號 | creator_merchant | string[1,32] | 否 | query 批次創(chuàng)建方商戶號 示例值：1000000001 |
| 批次歸屬商戶號 | belong_merchant | string[8,15] | 否 | query 批次歸屬商戶號 示例值：1000000002 |
| 批次發(fā)放商戶號 | sender_merchant | string[1,32] | 否 | query 批次發(fā)放商戶號 示例值：1000000003 |
| 分頁頁碼 | offset | int | 否 | query 分頁頁碼 示例值：0 |
| 分頁大小 | limit | int | 否 | query 分頁大小 示例值：20 |
請求示例
https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/2323dfsdf342342/coupons?appid=wx233544546545989&stock_id=9865000&coupon_state=USED&creator_merchant=1000000001&offset=0&limit=20
返回參數
說明：為提升API性能，返回參數中“結果集>樣式信息>使用須知（description）”字段內容將不再返回，即查詢結果不再返回使用須知，改動將于2020年7月8日12:00生效。如您業(yè)務中需要使用該字段，建議使用“查詢用戶單張券詳情API”
| 參數名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| +結果集 | data | array | 是 | 結果集 |
| 總數量 | total_count | int | 是 | 總數量 示例值：?100 |
| 分頁頁碼 | offset | int | 是 | 分頁頁碼 示例值：1 |
| 分頁大小 | limit | int | 是 | 分頁大小 示例值：10 |
卡券背景顏色圖
返回示例
{
"data": [
{
"belong_merchant": "100000222",
"stock_name": "商家券",
"comment": "xxx可用",
"goods_name": "xxx商品可用",
"stock_type": "NORMAL",
"transferable": "false",
"shareable": "false",
"coupon_state": "SENDED",
"display_pattern_info": {
"merchant_logo_url": "https://xxx",
"merchant_name": "微信支付",
"background_color": "xxxxx",
"coupon_image_url": "圖片cdn地址"
},
"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"
},
"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"
},
"coupon_code": "123446565767",
"stock_id": "1002323",
"available_start_time": "2019-12-30T13:29:35+08:00",
"expire_time": "2019-12-31T13:29:35+08:00",
"receive_time": "2019-12-30T13:29:35+08:00",
"send_request_no": "MCHSEND202003101234",
"use_request_no": "MCHSEND202003101234",
"use_time": "2019-12-30T13:29:35+08:00"
}
],
"total_count": 100,
"limit": 10,
"offset": 1
}
錯誤碼公共錯誤碼
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 參數錯誤 | 查看具體錯誤信息，調整參數 |
| 400 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請使用相同參數稍后重新調用 |
| 400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重復使用 |
| 券已被其他訂單核銷 | 請通過查詢券API確認券是否已被其他訂單核銷 | ||
| 404 | RESOURCE_NOT_EXISTS | 查詢的資源不存在 | 請檢查查詢資源的對應id是否填寫正確 |
| 403 | NOAUTH | 無權限 | 查看具體錯誤信息，確認是否有權限 |
| 400 | APPID_MCHID_NOT_MATCH | appid與請求方商戶無關聯(lián)關系 | appid與請求方商戶不匹配，請確認appid與請求方商戶是否有關聯(lián)關系 |
| 400 | MCH_NOT_EXISTS | 商戶號不存在 | 請確認傳入的商戶號是否正確 |
| 404 | USER_NOT_EXISTS | openid不正確 | 請確認傳入的openid是否正確 |
| 500 | SYSTEM_ERROR | 系統(tǒng)失敗 | 多為網絡超時引起，重試 |
| 429 | FREQUENCY_LIMITED | 頻率限制 | 調用太頻繁，請降低調用接口頻率 |
| 403 | RULELIMIT | 券不在有效期 | 請確認券是否能在當前時間核銷 |
| 400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請更換支持預上傳code的批次后重試 |
| 上傳的自定義code已達上限 | 請更換一個新的批次后重試 |