接口说明
适用对象： 直连商户
请求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
请求方式：GET
path 指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
请求参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次号 | stock_id | string[1,20] | 是 | path 微信为每个商家券批次分配的唯一ID 示例值：1212 |
请求示例
https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/1212
返回参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商家券批次名称 | stock_name | string[1,21] | 是 | 批次名称，字数上限为21个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：8月1日活动券 |
| 批次归属商户号 | belong_merchant | string[8,15] | 是 | 批次归属于哪个商户。 示例值：10000022 |
| 批次备注 | comment | string[1,20] | 否 | 仅配置商户可见，用于自定义信息。字数上限为20个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：活动使用 |
| 适用商品范围 | goods_name | string[1,15] | 是 | 用来描述批次在哪些商品可用，会显示在微信卡包中。字数上限为15个，一个中文汉字/英文字母/数字均占用一个字数。 示例值：xxx商品使用 |
| 批次类型 | stock_type | string[1,16] | 是 | 批次类型 NORMAL：固定面额满减券批次 DISCOUNT：折扣券批次 EXCHANGE：换购券批次 示例值：NORMAL |
| +核销规则 | coupon_use_rule | object | 是 | 券核销相关规则 |
| +发放规则 | stock_send_rule | object | 是 | 券发放相关规则 |
| +自定义入口 | custom_entrance | object | 否 | 卡详情页面，可选择多种入口引导用户。 |
| +样式信息 | display_pattern_info | object | 否 | 创建批次时的样式信息。 |
| 批次状态 | stock_state | string[1,128] | 是 | 批次状态
示例值：RUNNING |
| 券code模式 | coupon_code_mode | string[1,128] | 是 | 枚举值： WECHATPAY_MODE：系统分配券code。 MERCHANT_API：商户发放时接口指定券code。 MERCHANT_UPLOAD：商户上传自定义code，发券时系统随机选取上传的券code。 示例值：WECHATPAY_MODE |
| 批次号 | stock_id | string[1,20] | 是 | 微信为每个商家券批次分配的唯一ID。 示例值：1212 |
| +券code数量 | coupon_code_count | object | 否 | 当且仅当coupon_code_mode（券code模式）为MERCHANT_UPLOAD（商户上传自定义code）模式时，返回该字段，返回内容为商户上传code的数量信息。 |
| +事件通知配置 | notify_config | object | 否 | 事件回调通知商户的配置。 |
| +批次发放情况 | send_count_information | object | 否 | 批次发放情况 |
卡券背景颜色图
商家券详情信息样式图
返回示例
{
"stock_name": "8月1日活动券",
"belong_merchant": "10000022",
"comment": "xxx店使用",
"goods_name": "xxx商品使用",
"stock_type": "NORMAL",
"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"
},
"stock_send_rule": {
"max_amount": 100000,
"max_coupons": 100,
"max_coupons_per_user": 5,
"max_amount_by_day": 1000,
"max_coupons_by_day": 100,
"natural_person_limit": false,
"prevent_api_abuse": false,
"transferable": false,
"shareable": false
},
"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"
},
"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"
}
},
"stock_state": "RUNNING",
"coupon_code_mode": "MERCHANT_UPLOAD",
"stock_id": "1212",
"coupon_code_count": {
"total_count": 100,
"available_count": 50
}
}
错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 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已达上限 | 请更换一个新的批次后重试 |