微信支付-开发者文档

返回上一层文档首页 / 查询代金券可用单品API

查询代金券可用单品API

最新更新时间：2019.09.29 版本说明

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

接口说明

适用对象：直连商户

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

接口耗时：1S

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

请求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/items

请求方式：GET

path指该参数为路径参数

query 指该参数需在请求URL传参

body 指该参数需在请求JSON传参

请求参数

参数名	变量	类型[长度限制]	必填	描述
分页页码	offset	uint32	是	query 分页页码，最大500。示例值: 10
分页大小	limit	uint32	是	query 分页大小，最大100。示例值: 10
创建批次的商户号	stock_creator_mchid	string[1,20]	是	query 批次创建方商户号。校验规则：接口传入的批次号需由stock_creator_mchid所创建示例值: 9865000
批次号	stock_id	string[1,20]	是	path 批次号校验规则：必须为代金券（全场券或单品券）批次号，不支持立减与折扣。示例值: 9865000

请求示例


https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/9865000/items?offset=10&limit=10&stock_creator_mchid=9865000

    
｛
JAVA示例代码
｝

返回参数

参数名	变量	类型[长度限制]	必填	描述
可用单品编码总数	total_count	uint32	是	可用单品编码总数。示例值: 200
可用单品编码	data	array	否	可用单品编码特殊规则：单个商品编码的字符长度为【1，128】,条目个数限制为【1，100】。示例值:1232001
分页页码	offset	uint32	是	分页页码示例值: 10
分页大小	limit	uint32	是	分页大小示例值: 10
批次号	stock_id	string[1,20]	是	批次号示例值: 9865000

返回示例

正常示例


{
    "data": [
        "1232001"
    ],
    "limit": 5,
    "offset": 0,
    "stock_id": "15019035",
    "total_count": 1
}


    http://2323weixin.qq.com

错误码公共错误码

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