基础支付
JSAPI支付
APP支付
Native支付
小程序支付
合单支付
付款码支付
经营能力
微信支付分(免确认模式)
微信支付分(免确认预授权模式)
微信支付分(需确认模式)
微信支付分(公共API)
支付即服务
行业方案
智慧商圈
微信支付分停车服务
营销工具
代金券
商家券
委托营销
消费卡
支付有礼
小程序发券插件
H5发券
图片上传(营销专用)
现金红包
资金应用
付款
分账
风险合规
消费者投诉2.0
其他能力
清关报关
图片上传
视频上传

条件查询批次列表API

最新更新时间:2019.09.27 版本说明


通过此接口可查询多个批次的信息,包括批次的配置信息以及批次概况数据。

接口说明

适用对象:直连商户

请求URL:https://api.mch.weixin.qq.com/v3/marketing/favor/stocks

请求方式:GET

接口频率:不区分来源 1000/s 单ip 500/s

接口耗时:1S

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


path指该参数为路径参数

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

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


请求参数

参数名 变量 类型[长度限制] 必填 描述
分页页码 offset uint32 query 页码从0开始,默认第0页。
示例值:0
分页大小 limit uint32 query 分页大小,最大10。
示例值:8
创建批次的商户号 stock_creator_mchid string[1,20] query 批次创建方商户号。
校验规则:接口传入的批次号需由stock_creator_mchid所创建。
示例值:9856888
起始时间 create_start_time string[1,64] query 起始创建时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
校验规则:get请求,参数在 url中,需要进行 url 编码传递
示例值:2015-05-20T19%3A29%3A35.120%2B08%3A00
终止时间 create_end_time string[1,64] query 终止创建时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
校验规则:get请求,参数在 url中,需要进行 url 编码传递
示例值:2015-05-20T19%3A29%3A35.120%2B08%3A00
批次状态 status string[1,16] query 批次状态,枚举值:
unactivated:未激活
audit:审核中
running:运行中
stoped:已停止
paused:暂停发放
示例值:paused

请求示例


 https://api.mch.weixin.qq.com/v3/marketing/favor/stocks?offset=0&limit=8&stock_creator_mchid=9856888&create_start_time=2015-05-20T13%3A29%3A35.120%2B08%3A00&create_end_time=2015-05-20T19%3A29%3A35.120%2B08%3A00
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
批次总数 total_count int64 经过条件筛选,查询到的批次总数量。
示例值:10
+ 批次详情 data array 批次详情
参数名 变量 类型[长度限制] 必填 描述
批次号 stock_id string[1,20] 微信为每个代金券批次分配的唯一id。
示例值:9836588
创建批次的商户号 stock_creator_mchid string[1,20] 微信为创建方商户分配的商户号。
示例值:123456
批次名称 stock_name string[1,20] 批次名称
示例值:微信支付批次
批次状态 status string[1,16] 批次状态,枚举值:
unactivated:未激活
audit:审核中
running:运行中
stoped:已停止
paused:暂停发放
示例值:paused
创建时间 create_time string[1,32] 批次创建时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
使用说明 description string[1,3000] 批次描述信息
示例值:微信支付营销
+ 满减券批次使用规则 stock_use_rule

object

普通发券批次特定信息。
参数名 变量 类型[长度限制] 必填 描述
发放总上限 max_coupons uint64 最大发券数
示例值:100
总预算 max_amount uint64 总消耗金额,单位:分。
示例值:5000
单天发放上限金额 max_amount_by_day uint64 单天最高消耗金额,单位:分。
示例值:400
+ 固定面额批次特定信息 fixed_normal_coupon

object

固定面额发券批次特定信息。
参数名 变量 类型[长度限制] 必填 描述
面额 coupon_amount uint64 面额,单位:分。
示例值:100
门槛 transaction_minimum uint64 使用券金额门槛,单位:分。
示例值:100
单个用户可领个数 max_coupons_per_user uint32 单个用户可领个数
示例值:3
券类型 coupon_type string[1,16] 枚举值:
NORMAL:满减券
CUT_TO:减至券
示例值:NORMAL
订单优惠标记 goods_tag array 订单优惠标记 (该字段暂未开放返回)
特殊规则:单个优惠标记的字符长度为【1,128】,条目个数限制为【1,50】。
示例值:{'123456','23456'}
支付方式 trade_type array 默认不限制,枚举值:
MICROAPP:小程序支付
APPPAY:APP支付
PPAY:免密支付
CARD:付款码支付
FACE:人脸支付
OTHER:(公众号、扫码等)
示例值: ["OTHER","APPPAY"]
是否可叠加其他优惠 combine_use bool 枚举值:
true:是
false:否
示例值:true
可用开始时间 available_begin_time string[1,32] 可用开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
可用结束时间 available_end_time string[1,32] 可用结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
已发券数量 distributed_coupons uint32 已发券数量
示例值:100
是否无资金流 no_cash bool 是否无资金流。枚举值:
ture:是
false:否
示例值:true
激活批次的时间 start_time string[1,32] 批次激活开启时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
终止批次的时间 stop_time string[1,32] 批次永久停止时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
+ 减至批次特定信息 cut_to_message object 单品优惠特定信息。
参数名 变量 类型[长度限制] 必填 描述
可用优惠的商品最高单价 single_price_max uint64 可用优惠的商品最高单价,单位:分。
示例值:100
减至后的优惠单价 cut_to_price uint64 减至后的优惠单价,单位:分。
示例值:100
是否单品优惠 singleitem bool 枚举值:
true:是
false:否
示例值:true
批次类型 stock_type string[1,16]
批次类型
枚举值:
NORMAL:代金券批次
DISCOUNT_CUT:立减与折扣
OTHER:其他
示例值:NORMAL
分页大小 limit uint32 分页大小,最大10。
示例值:8
分页页码 offset uint32 页码从0开始,默认第0页。
示例值:1

返回示例


{
	"total_count": 10,
	"data": [{
		"stock_id": "9836588",
		"stock_creator_mchid": "123456",
		"stock_name": "微信支付批次",
		"status": "paused",
		"create_time": "2015-05-20T13:29:35.120+08:00",
		"description": "微信支付营销",
		"stock_use_rule": {
			"max_coupons": 100,
			"max_amount": 5000,
			"max_amount_by_day": 400,
			"fixed_normal_coupon": {
				"coupon_amount": 100,
				"transaction_minimum": 100
			},
			"max_coupons_per_user": 3,
			"trade_type":  ["OTHER","APPPAY"]
		},
		"available_begin_time": "2015-05-20T13:29:35.120+08:00",
		"available_end_time": "2015-05-20T13:29:35.120+08:00"
		"distributed_coupons": 100,
		"no_cash": true,
		"singleitem ": true,
		"stock_type": "NORMAL",
	}],
	"limit": 8,
	"offset": 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 接口限频 请降低调用频率


技术咨询

文档反馈