条件查询批次列表API

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

接口说明

适用对象: 直连商户服务商渠道商
请求 URL: https://api.mch.weixin.qq.com/v3/marketing/favor/stocks
请求方式: GET
接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3

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

请求参数

变量 |类型 |必填 |参数名/描述/示例值

分页页码 offset uint32 是 path 页码从 0 开始, 默认第 0 页。 |||1 分页大小 limit uint32 是 path 分页大小, 最大 10。 |||8 创建批次的商户号 stock_creator_mchid string(20) 是 path 批次创建方商户号。 |||9856888 起始时间 create_start_time string(64) 否 path 起始创建时间, 遵循 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 终止时间 create_end_time string(64) 否 path 终止创建时间, 遵循 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 批次状态 status string(12) 否 path 批次状态, 枚举值: unactivated: 未激活 audit: 审核中 running: 运行中 stoped: 已停止 paused: 暂停发放 |||paused

请求示例

URL 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

返回参数

变量 |类型 |必填 |参数名/描述/示例值

批次总数 total_count int64 是经过条件筛选, 查询到的批次总数量。 |||10 +批次详情 data object 否批次详情分页大小 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": "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
}

错误码_{公共错误码}

|状态码 |错误码 |描述| 解决方案 |- 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 接口限频请降低调用频率

Feedback

Was this page helpful?

很高兴听到！请告诉我们，我们如何才能改善.

很遗憾听到这个消息。请告诉我们，我们如何才能改善.

最后修改 April 12, 2020: 整理文档 (f36b91e)