接口说明
适用对象： 直连商户
请求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons
请求方式：GET
path 指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
请求参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 用户标识 | openid | string[1,128] | 是 | path Openid信息，用户在appid下的唯一标识。 校验规则：传入的openid得是调用方商户号（即请求头里面的商户号）有绑定关系的APPID获取的openid或传入的openid得是归属商户号有绑定关系的APPID获取的openid。获取openid文档 示例值：2323dfsdf342342 |
| 公众账号ID | appid | string[1,32] | 是 | query 支持传入与当前调用接口商户号有绑定关系的appid。支持小程序appid与公众号appid。 校验规则：传入的APPID得是与调用方商户号（即请求头里面的商户号）有绑定关系的APPID 或 传入的APPID得是归属商户号有绑定关系的APPID 示例值：wx233544546545989 |
| 批次号 | stock_id | string[1,20] | 否 | query 微信为每个商家券批次分配的唯一ID，是否指定批次号查询。 示例值：9865000 |
| 券状态 | coupon_state | string[1,16] | 否 | query 券状态 枚举值： |
| 创建批次的商户号 | creator_merchant | string[1,32] | 否 | query 批次创建方商户号 校验规则：当调用方商户号（即请求头中的商户号）为创建批次方商户号时，该参数必传 示例值：1000000001 |
| 批次归属商户号 | belong_merchant | string[8,15] | 否 | query 批次归属商户号 校验规则：当调用方商户号（即请求头中的商户号）为批次归属商户号时，该参数必传 示例值：1000000002 |
| 批次发放商户号 | sender_merchant | string[1,32] | 否 | query 批次发放商户号 校验规则：当调用方商户号（即请求头中的商户号）为批次发放商户号时，该参数必传；委托营销关系下，请填写委托发券的商户号 示例值：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生效。如您业务中需要使用该字段，建议使用“查询用户单张券详情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": "Color020",
"coupon_image_url": "https://qpic.cn/xxx",
"finder_info": {
"finder_id": "sph6Rngt2T4RlUf",
"finder_video_cover_image_url": "https://wxpaylogo.qpic.cn/xxx",
"finder_video_id": "export/UzFfAgtgekIEAQAAAAAAb4MgnPInmAAAAAstQy6ubaLX4KHWvLEZgBPEwIEgVnk9HIP-zNPgMJofG6tpdGPJNg_ojtEjoT94"
}
},
"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
},
"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": "获取更多优惠"
},
"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
}
错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 参数错误 | 查看具体错误信息，调整参数 |
| 400 | SYSTEM_ERROR | 系统错误 | 请使用相同参数稍后重新调用 |
| 400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重复使用 |
| 券已被其他订单核销 | 请通过查询券API确认券是否已被其他订单核销 | ||
| 404 | RESOURCE_NOT_EXISTS | 查询的资源不存在 | 请检查查询资源的对应id是否填写正确 |
| 403 | NOAUTH | 无权限 | 查看具体错误信息，确认是否有权限 |
| 400 | APPID_MCHID_NOT_MATCH | appid与请求方商户无关联关系 | appid与请求方商户不匹配，请确认appid与请求方商户是否有关联关系 |
| 400 | MCH_NOT_EXISTS | 商户号不存在 | 请确认传入的商户号是否正确 |
| 404 | USER_NOT_EXISTS | openid不正确 | 请确认传入的openid是否正确 |
| 500 | SYSTEM_ERROR | 系统失败 | 多为网络超时引起，重试 |
| 429 | FREQUENCY_LIMITED | 频率限制 | 调用太频繁，请降低调用接口频率 |
| 403 | RULELIMIT | 券不在有效期 | 请确认券是否能在当前时间核销 |
| 400 | INVALID_REQUEST | 发券模式不合法 | 请更换支持预上传code的批次后重试 |
| 上传的自定义code已达上限 | 请更换一个新的批次后重试 |