商户可通过该接口查询微信用户卡包中某一张商家券的详情信息。

接口说明

支持商户：

【普通服务商】【渠道商】

请求方式：

【GET】/v3/marketing/busifavor/users/{openid}/coupons/{coupon_code}/appids/{appid}

请求域名：

【主域名】

https://api.mch.weixin.qq.com

使用该域名将访问就近的接入点

【备域名】

https://api2.mch.weixin.qq.com

使用该域名将访问异地的接入点 ，指引点击查看

请求参数

Header HTTP头参数
Authorization 必填 string
请参考 签名认证 生成认证信息
Accept 必填 string
请设置为 application/json

Path 路径参数
coupon_code 必填 string
【券code】 券的唯一标识
appid 必填 string
【公众账号ID】 支持传入与当前调用接口商户号有绑定关系的AppID。支持小程序AppID与公众号AppID。
校验规则：传入的AppID得是与调用方商户号（即请求头里面的商户号）有绑定关系的AppID或传入的AppID得是归属商户号有绑定关系的AppID
openid 必填 string
【用户OpenID】 OpenID信息，用户在AppID下的唯一标识。
校验规则：传入的OpenID得是调用方商户号（即请求头里面的商户号）有绑定关系的AppID获取的OpenID或传入的OpenID得是归属商户号有绑定关系的AppID获取的OpenID。获取OpenID文档

请求示例

GET

应答参数

200OK
belong_merchant 必填 string
【批次归属商户号】 代金券的所属商户号
stock_name 必填 string
【商家券批次名称】 批次名称，字数上限为21个，一个中文汉字/英文字母/数字均占用一个字数。
comment 选填 string
【批次备注】 仅配置商户可见，用于自定义信息。字数上限为20个，一个中文汉字/英文字母/数字均占用一个字数。
goods_name 必填 string
【适用商品范围】 适用商品范围，字数上限为15个，一个中文汉字/英文字母/数字均占用一个字数。
stock_type 必填 string
【批次类型】 批次类型
可选取值：

• NORMAL: 固定面额满减券批次
• DISCOUNT: 折扣券批次
• EXCHANGE: 换购券批次
transferable 选填 boolean
【是否允许转赠】 不填默认否，枚举值：
true：是
false：否
该字段暂未开放
shareable 选填 boolean
【是否允许分享领券链接】 不填默认否，枚举值：
true：是
false：否
该字段暂未开放
coupon_state 选填 string
【券状态】 商家券状态
可选取值：

• SENDED: 可用
• USED: 已核销
• EXPIRED: 已过期
• DELETED: 已删除
• DEACTIVATED: 已失效
display_pattern_info 选填 object
【样式信息】
• 属性
coupon_use_rule 必填 object
【券核销规则】
• 属性
custom_entrance 选填 object
【自定义入口】
• 属性
coupon_code 选填 string
【券code】 券的唯一标识
stock_id 选填 string
【批次号】 批次号
available_start_time 选填 string
【券可使用开始时间】 用户领取到的这张券实际可使用的开始时间：如批次设置的领取后可用，则开始时间即为券的领取时间； 如批次设置的领取后第X天可用，则为领取时间后第X天00:00:00
expire_time 选填 string
【券过期时间】 用户领取到这张券的过期时间
receive_time 选填 string
【券领取时间】 用户领取到这张券的时间
send_request_no 选填 string
【发券请求单号】 发券时传入的唯一凭证
use_request_no 选填 string
【核销请求单号】 核销时传入的唯一凭证（如券已被核销，将返回此字段）
use_time 选填 string
【券核销时间】 券被核销的时间（如券已被核销，将返回此字段）
associate_out_trade_no 选填 string
【关联的商户订单号】 若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。
return_request_no 选填 string
【回退请求单号】 回退时传入的唯一凭证（如券发生了退回，将返回此字段）
return_time 选填 string
【券回退时间】 券被回退的时间（如券发生了退回，将返回此字段）
deactivate_request_no 选填 string
【失效请求单号】 失效时传入的唯一凭证（如果一张券已失效，将返回此字段）
deactivate_time 选填 string
【券失效时间】 券被失效的时间（如果一张券已失效，将返回此字段）
deactivate_reason 选填 string
【失效原因】 失效一张券的原因（如果一张券已失效，可能返回此字段）

应答示例

200 OK

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅 接口规则
401	SIGN_ERROR	验证不通过	请参阅 签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	APPID_MCHID_NOT_MATCH	AppID与请求方商户无关联关系	AppID与请求方商户不匹配，请确认AppID与请求方商户是否有关联关系
400	INVALID_REQUEST	发券模式不合法	请更换支持预上传code的批次后重试
400	INVALID_REQUEST	上传的自定义code已达上限	请更换一个新的批次后重试
400	MCH_NOT_EXISTS	商户号不存在	请确认传入的商户号是否正确
400	RESOURCE_ALREADY_EXISTS	批次已存在	查看out_request_no字段是否重复使用
400	RESOURCE_ALREADY_EXISTS	券已被其他订单核销	请通过查询券API确认券是否已被其他订单核销
400	SYSTEM_ERROR	系统错误	请使用相同参数稍后重新调用
403	NOAUTH	无权限	查看具体错误信息，确认是否有权限
403	RULELIMIT	券不在有效期	请确认券是否能在当前时间核销
404	RESOURCE_NOT_EXISTS	查询的资源不存在	请检查查询资源的对应ID是否填写正确
404	USER_NOT_EXISTS	OpenID不正确	请确认传入的OpenID是否正确
429	FREQUENCY_LIMITED	频率限制	调用太频繁，请降低调用接口频率
500	SYSTEM_ERROR	系统失败	多为网络超时引起，重试