查询代金券可用单品

更新时间：2024.09.19

通过此接口可查询批次的可用商品编码，判断券是否可用于某些商品，来决定是否展示。

接口频率：不区分来源 1000/min，单ip 200/min

接口耗时：1S

幂等规则：接口支持幂等重入

接口说明

支持商户：【普通商户】

请求方式：【GET】/v3/marketing/favor/stocks/{stock_id}/items

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

path 路径参数

stock_id 　必填 string(20)

【批次号】批次号
校验规则：必须为代金券（全场券或单品券）批次号，不支持立减与折扣。

query 查询参数

offset 　必填 integer

【分页页码】分页页码，最大500

limit 　必填 integer

【分页大小】分页大小，最大100

stock_creator_mchid 　必填 string(20)

【创建批次的商户号】批次创建方商户号。
校验规则：接口传入的批次号需由stock_creator_mchid所创建

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/9865000/items?offset=10&limit=10&stock_creator_mchid=9865000 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

total_count 　必填 integer

【可用单品编码总数】可用单品编码总数

data 　选填 array[string]

【可用单品编码】可用单品编码
特殊规则：单个商品编码的字符长度为【1，128】,条目个数限制为【1，100】。

offset 　必填 integer

【分页页码】分页页码

limit 　必填 integer

【分页大小】分页大小

stock_id 　必填 string

【批次号】批次号

应答示例

200 OK

1{
2  "total_count" : 200,
3  "data" : [
4    "example_data"
5  ],
6  "offset" : 10,
7  "limit" : 10,
8  "stock_id" : "9865000"
9}
10

错误码

公共错误码

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

业务错误码

状态码	错误码	描述	解决方案
400	APPID_MCHID_NOT_MATCH	商户号与AppID不匹配	请绑定调用接口的商户号和AppID后重试
400	INVALID_REQUEST	OpenID与AppID不匹配	请使用AppID下的OpenID
400	INVALID_REQUEST	活动已结束或未激活	请检查批次状态
400	INVALID_REQUEST	非法的商户号	请检查商户号是否正确
400	MCH_NOT_EXISTS	商户号不合法	请输入正确的商户号
400	PARAM_ERROR	回调URL不能为空	请填写回调URL
400	PARAM_ERROR	回调商户不能为空	请填写回调商户
400	PARAM_ERROR	券ID必填	请填写券ID
400	PARAM_ERROR	AppID必填	请输入AppID
400	PARAM_ERROR	OpenID必填	请输入OpenID
400	PARAM_ERROR	页大小超过阈值	请不要超过最大的页大小
400	PARAM_ERROR	输入时间格式错误	请输入正确的时间格式
400	PARAM_ERROR	批次号必填	请输入批次号
400	PARAM_ERROR	商户号必填	请输入商户号
400	PARAM_ERROR	非法的批次状态	请检查批次状态
403	NOT_ENOUGH	批次预算不足	请补充预算
403	REQUEST_BLOCKED	调用商户无权限	请开通产品权限后再调用该接口
403	REQUEST_BLOCKED	商户无权发券	调用接口的商户号无权发券，请检查是否是自己的批次或是已授权的批次。
403	REQUEST_BLOCKED	批次不支持跨商户发券	该批次未做跨商户号的授权，请授权后再发放
403	REQUEST_BLOCKED	用户被限领拦截	用户领取已经达到上限，请调高上限或停止发放。
403	USER_ACCOUNT_ABNORMAL	用户非法	该用户账号异常，无法领券。商家可联系微信支付或让用户联系微信支付客服处理。
404	RESOURCE_NOT_EXISTS	批次不存在	请检查批次ID是否正确
429	FREQUENCY_LIMITED	请求过于频繁	稍后重试

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服