接口说明
适用对象： 直连商户
请求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons/{coupon_code}/appids/{appid}
请求方式：GET
path 指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
请求参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 券code | coupon_code | string[1,32] | 是 | path 券的唯一标识。 示例值：123446565767 |
| 公众账号ID | appid | string[1,32] | 是 | path 支持传入与当前调用接口商户号有绑定关系的appid。支持小程序appid与公众号appid。 校验规则：传入的APPID得是与调用方商户号（即请求头里面的商户号）有绑定关系的APPID或传入的APPID得是归属商户号有绑定关系的APPID 示例值：wx233544546545989 |
| 用户标识 | openid | string[1,128] | 是 | path Openid信息，用户在appid下的唯一标识。 校验规则：传入的openid得是调用方商户号（即请求头里面的商户号）有绑定关系的APPID获取的openid或传入的openid得是归属商户号有绑定关系的APPID获取的openid。获取openid文档 示例值：2323dfsdf342342 |
请求示例
https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/2323dfsdf342342/coupons/123446565767/appids/wx233544546545989
返回参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次归属商户号 | belong_merchant | string[8,15] | 是 | 批次归属于哪个商户。 示例值：10000022 |
| 商家券批次名称 | stock_name | string[1,21] | 是 | 批次名称，字数上限为21个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：商家券 |
| 批次备注 | comment | string[1,20] | 否 | 仅配置商户可见，用于自定义信息。字数上限为20个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：xxx可用 |
| 适用商品范围 | goods_name | string[1,15] | 是 | 适用商品范围，字数上限为15个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：xxx商品可用 |
| 批次类型 | stock_type | string[1,128] | 是 | 批次类型 NORMAL：固定面额满减券批次 DISCOUNT：折扣券批次 EXCHANGE：换购券批次 示例值：NORMAL |
| 是否允许转赠 | transferable | bool | 否 | 不填默认否，枚举值： true：是 false：否 该字段暂未开放 示例值：false |
| 是否允许分享领券链接 | shareable | bool | 否 | 不填默认否，枚举值： true：是 false：否 该字段暂未开放 示例值：false |
| 券状态 | coupon_state | string[1,16] | 否 | 商家券状态 枚举值： |
| +样式信息 | display_pattern_info | object | 否 | 商家券详细信息 |
| +券核销规则 | coupon_use_rule | 券核销规则 | 是 | 券核销相关规则 |
| +自定义入口 | custom_entrance | object | 否 | 卡详情页面，可选择多种入口引导用户。 |
| 券code | coupon_code | string[1,32] | 否 | 券的唯一标识。 示例值：123446565767 |
| 批次号 | stock_id | string[1,20] | 否 | 微信为每个商家券批次分配的唯一ID，是否指定批次号查询。 示例值：1002323 |
| 券可使用开始时间 | available_start_time | string[1,32] | 是 | 1、用户领取到该张券实际可使用的开始时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.+08:00表示，北京时间2015年5月20日 13点29分35秒。 2、若券批次设置为领取后可用，则开始时间即为券的领取时间；若券批次设置为领取后第X天可用，则开始时间为券领取时间后第X天00:00:00可用。 示例值：2019-12-30T13:29:35+08:00 |
| 券过期时间 | expire_time | string[1,32] | 是 | 用户领取到该张券的过期时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值：2015-05-20T13:29:35+08:00 |
| 券领券时间 | receive_time | string[1,32] | 是 | 用户领取到该张券的时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值：2015-05-20T13:29:35+08:00 |
| 发券请求单号 | send_request_no | string[1,128] | 是 | 发券时传入的唯一凭证 示例值: MCHSEND202003101234 |
| 核销请求单号 | use_request_no | string[1,32] | 否 | 核销时传入的唯一凭证（如券已被核销，将返回此字段） 示例值: MCHUSE202003101234 |
| 关联的商户订单号 | associate_out_trade_no | string[1,128] | 否 | 若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。 示例值: mchtrade_1234554 |
| 券核销时间 | use_time | string[1,32] | 否 | 券被核销的时间（如券已被核销，将返回此字段）；遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值：2015-05-20T13:29:35+08:00 |
卡券背景颜色图
返回示例
{
"belong_merchant": "100000222",
"stock_name": "商家券",
"comment": "xxx可用",
"goods_name": "xxx商品可用",
"stock_type": "NORMAL",
"transferable": false,
"shareable": false,
"coupon_state": "SENDED",
"display_pattern_info": {
"description": "xxx门店可用",
"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"
}
错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 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已达上限 | 请更换一个新的批次后重试 |