根据过滤条件查询用户的券

更新时间:2023.08.16

商户自定义筛选条件(如创建商户号、归属商户号、发放商户号等),查询指定微信用户卡包中满足对应条件的所有商家券信息。

# 接口说明

支持商户:
【普通商户】
请求方式:
【GET】/v3/marketing/busifavor/users/{openid}/coupons
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • openid 必填 string
    【用户标识】 Openid信息,用户在AppID下的唯一标识。
    校验规则:传入的OpenID得是调用方商户号(即请求头里面的商户号)有绑定关系的AppID获取的OpenID或传入的OpenID得是归属商户号有绑定关系的AppID获取的OpenID。获取OpenID文档
    Query 查询参数
  • appid 必填 string
    【公众账号ID】 支持传入与当前调用接口商户号有绑定关系的AppID。支持小程序AppID与公众号AppID。
    校验规则:传入的AppID得是与调用方商户号(即请求头里面的商户号)有绑定关系的AppID 或 传入的AppID得是归属商户号有绑定关系的AppID
  • stock_id 选填 string
    【批次号】 批次号,是否指定批次号查询
  • creator_merchant 选填 string
    【创建批次的商户号】 批次创建方商户号
    校验规则:当调用方商户号(即请求头中的商户号)为创建批次方商户号时,该参数必传
  • belong_merchant 选填 string
    【批次归属商户号】 批次归属商户号
    校验规则:当调用方商户号(即请求头中的商户号)为批次归属商户号时,该参数必传
  • sender_merchant 选填 string
    【批次发放商户号】 批次发放商户号
    校验规则:当调用方商户号(即请求头中的商户号)为批次发放商户号时,该参数必传;委托营销关系下,请填写委托发券的商户号
  • offset 选填 integer
    【分页页码】 分页页码
  • limit 选填 integer
    【分页大小】 分页大小
  • coupon_state 选填 string
    【券状态】 商家券状态
    可选取值:
    • SENDED: 可用
    • USED: 已核销
    • EXPIRED: 已过期
    • DELETED: 已删除
    • DEACTIVATED: 已失效

请求示例

GET

# 应答参数

    200OK
  • data 选填 array[CouponEntity]
    【结果集】
    • 属性
  • total_count 必填 integer
    【总数量】 总数量
  • limit 必填 integer
    【分页大小】 分页大小
  • offset 必填 integer
    【分页页码】 分页页码

应答示例

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 系统失败 多为网络超时引起,重试
反馈
咨询
目录