条件查询批次列表

更新时间：2024.12.27

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

接口频率：不区分来源 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"

# 应答参数

200OK

total_count 必填 integer

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

data 选填 array[object]

【批次详情】 批次详情

属性

limit 必填 integer

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

offset 必填 integer

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

应答示例

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        "fixed_discount_coupon" : {
29          "discount_amount_max" : 100,
30          "discount_percent" : 88,
31          "transaction_minimum" : 100
32        }
33      },
34      "available_begin_time" : "2015-05-20T13:29:35.120+08:00",
35      "available_end_time" : "2015-05-20T13:29:35.120+08:00",
36      "distributed_coupons" : 100,
37      "no_cash" : true,
38      "start_time" : "2015-05-20T13:29:35.120+08:00",
39      "stop_time" : "2015-05-20T13:29:35.120+08:00",
40      "cut_to_message" : {
41        "single_price_max" : 100,
42        "cut_to_price" : 80
43      },
44      "singleitem" : true,
45      "stock_type" : "NORMAL",
46      "card_id" : "pX2-vjoeC94Nn-r2g5GjDwkfFH7E",
47      "business_type" : "MULTIUSE",
48      "available_region_list" : [
49        {
50          "type" : "PROVINCE",
51          "province" : "广东省",
52          "city" : "深圳市",
53          "district" : "南山区",
54          "country" : "中国大陆"
55        }
56      ],
57      "available_industry_list" : [
58        "餐饮"
59      ]
60    }
61  ],
62  "limit" : 8,
63  "offset" : 1
64}

# 错误码

# 公共错误码

状态码	错误码	描述	解决方案
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	请求过于频繁	稍后重试

文档是否有帮助

服务商文档

代金券参考文档

更多支持

开发者社区微信开放平台微信公众平台腾讯客服

条件查询批次列表

# 接口说明

# 请求参数

# 应答参数

# 错误码

# 公共错误码

# 业务错误码

关于我们

服务支持

友情链接

客服帮助