条件查询批次列表

更新时间：2024.09.19

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

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

接口耗时：1S

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

接口说明

支持商户：【普通商户】

请求方式：【GET】/v3/marketing/favor/stocks

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

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

请求参数

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

query 查询参数

offset 　必填 integer

【分页页码】页码从0开始，默认第0页

limit 　必填 integer

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

stock_creator_mchid 　必填 string(20)

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

create_start_time 　选填 string(64)

【起始时间】起始创建时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。
校验规则：get请求，参数在 url中，需要进行 url 编码传递

create_end_time 　选填 string(664)

【终止时间】终止创建时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。
校验规则：get请求，参数在 url中，需要进行 url 编码传递

status 　选填 string(12)

【批次状态】批次状态，枚举值：
unactivated：未激活
audit：审核中
running：运行中
stoped：已停止
paused：暂停发放

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/favor/stocks?offset=1&limit=8&stock_creator_mchid=9856888&create_start_time=2015-05-20T13:29:35.120+08:00&create_end_time=2015-05-20T13:29:35.120+08:00&status=paused \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

total_count 　必填 integer

【批次总数】经过条件筛选，查询到的批次总数量。

data 　选填 array[object]

【批次详情】批次详情

属性

stock_id 　必填 string

【批次号】微信为每个代金券批次分配的唯一id。

stock_creator_mchid 　必填 string

【批次创建方商户号】微信为创建方商户分配的商户号

stock_name 　必填 string

【批次名称】批次名称

status 　必填 string

【批次状态】批次状态，枚举值：
unactivated：未激活
audit：审核中
running：运行中
stoped：已停止
paused：暂停发放

create_time 　必填 string

【创建时间】批次创建时间，遵循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秒。

description 　必填 string

【使用说明】批次描述信息

stock_use_rule 　选填 object

【满减券/消费金批次使用规则】满减券或消费金批次特定信息。

属性

max_coupons 　必填 integer

【发放总上限】最大发券数

max_amount 　必填 integer

【总预算】总消耗金额，单位：分。

max_amount_by_day 　必填 integer

【单天发放上限金额】单天最高消耗金额，单位：分。

fixed_normal_coupon 　选填 object

【固定面额批次特定信息】固定面额发券或消费金批次特定信息。

属性

max_coupons_per_user 　必填 integer

【单个用户可领个数】单个用户可领个数

coupon_type 　选填 string

【券或消费金类型】券或消费金类型
枚举值：
NORMAL：满减券
CUT_TO：减至券

goods_tag 　选填 array[string]

【订单优惠标记】订单优惠标记 (该字段暂未开放返回)
特殊规则：单个优惠标记的字符长度为【1，128】,条目个数限制为【1，50】。

trade_type 　选填 array[string]

【指定支付模式】默认不限制，枚举值：
MICROAPP：小程序支付
APPPAY：APP支付
PPAY：免密支付
CARD：付款码支付
FACE：人脸支付
OTHER：（公众号、扫码等）

可选取值：

MICROAPP: 小程序支付

APPPAY: APP支付

PPAY: 免密支付

CARD: 刷卡支付

FACE: 人脸支付

OTHER: 其他支付，公众号、扫码等

combine_use 　选填 boolean

【是否可叠加其他优惠】枚举值：
true：是
false：否

available_begin_time 　必填 string

【可用开始时间】可用开始时间，遵循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秒。

available_end_time 　必填 string

【可用结束时间】可用结束时间，遵循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秒。

distributed_coupons 　必填 integer

【已发券或消费金数量】已发券或消费金数量

no_cash 　必填 boolean

【是否无资金流】是否无资金流。枚举值：
ture：是
false：否

start_time 　选填 string

【激活批次的时间】批次激活开启时间，遵循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秒。

stop_time 　选填 string

【终止批次的时间】批次永久停止时间，遵循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秒。

cut_to_message 　选填 object

【减至批次特定信息】单品优惠特定信息

属性

singleitem 　必填 boolean

【是否单品优惠】枚举值：
true：是
false：否

stock_type 　必填 string

【批次类型】批次类型
枚举值：
NORMAL：代金券批次
DISCOUNT_CUT：立减与折扣
OTHER：其他

card_id 　选填 string

【卡包ID】微信卡包ID

business_type 　选填 string

【业务类型】细分业务类型，仅有当business_type=MULTIUSE时，才会返回，枚举值：
MULTIUSE：消费金

可选取值：

MULTIUSE: 消费金类型

available_region_list 　选填 array[object]

【消费金可用地域】消费金可用地域列表，仅有当business_type=MULTIUSE时，才会返回

属性

type 　选填 string

【类型】消费金可用地域的类型，COUNTRY表示国家级别可用，PROVINCE表示省级可用，CITY表示市级可用，DISTRICT表示区级可用。

可选取值：

PROVINCE: 地域信息精确到省级

CITY: 地域信息精确到市级

DISTRICT: 地域信息精确到区级

COUNTRY: 地域信息精确到国家级

province 　选填 string

【省】消费金可用省

city 　选填 string

【市】消费金可用

district 　选填 string

【区】消费金可用区

country 　选填 string

【国家】消费金可用国家

available_industry_list 　选填 array[string]

【消费金可用行业】消费金可用行业列表，仅有当business_type=MULTIUSE时，才会返回

limit 　必填 integer

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

offset 　必填 integer

【分页页码】页码从0开始，默认第0页

应答示例

200 OK

1{
2  "total_count" : 10,
3  "data" : [
4    {
5      "stock_id" : "9836588",
6      "stock_creator_mchid" : "123456",
7      "stock_name" : "微信支付批次",
8      "status" : "paused",
9      "create_time" : "2015-05-20T13:29:35.120+08:00",
10      "description" : "微信支付营销",
11      "stock_use_rule" : {
12        "max_coupons" : 100,
13        "max_amount" : 5000,
14        "max_amount_by_day" : 400,
15        "fixed_normal_coupon" : {
16          "coupon_amount" : 100,
17          "transaction_minimum" : 100
18        },
19        "max_coupons_per_user" : 3,
20        "coupon_type" : "NORMAL",
21        "goods_tag" : [
22          "123456"
23        ],
24        "trade_type" : [
25          "MICROAPP"
26        ],
27        "combine_use" : true
28      },
29      "available_begin_time" : "2015-05-20T13:29:35.120+08:00",
30      "available_end_time" : "2015-05-20T13:29:35.120+08:00",
31      "distributed_coupons" : 100,
32      "no_cash" : true,
33      "start_time" : "2015-05-20T13:29:35.120+08:00",
34      "stop_time" : "2015-05-20T13:29:35.120+08:00",
35      "cut_to_message" : {
36        "single_price_max" : 100,
37        "cut_to_price" : 80
38      },
39      "singleitem" : true,
40      "stock_type" : "NORMAL",
41      "card_id" : "pX2-vjoeC94Nn-r2g5GjDwkfFH7E",
42      "business_type" : "MULTIUSE",
43      "available_region_list" : [
44        {
45          "type" : "PROVINCE",
46          "province" : "广东省",
47          "city" : "深圳市",
48          "district" : "南山区",
49          "country" : "中国大陆"
50        }
51      ],
52      "available_industry_list" : [
53        "餐饮"
54      ]
55    }
56  ],
57  "limit" : 8,
58  "offset" : 1
59}
60

错误码

公共错误码

状态码	错误码	描述	解决方案
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版)开发者社区微信开放平台微信公众平台腾讯客服