# 获取公开券ID列表

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getpromotepublishcouponlist

可通过接口获取商家设置的机构推广券列表。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/promoter/get_public_coupon_list?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
shop_appidstring店铺id,填了只返回属于该店铺的券
next_keystring分页参数,第一页为空,后面返回前面一页返回的数据
page_sizenumber券数量,不能超过 200

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
next_keystring分页参数,第一页为空,后面请求返回上一次请求返回的next_key
couponsobjarray券信息,推客的绑定参数列表
has_moreboolean是否还有更多

# Res.coupons(Array) Object Payload

券信息,推客的绑定参数列表

参数名类型说明
coupon_idstring券的 id

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "shop_appid": "需要过滤的店铺appid",
    "next_key": "NEXT_KEY",
    "page_size": 20
}

返回示例

{
  "errcode": "0",
  "errmsg": "ok",
  "next_key": "NEW_NEXT_KEY",
  "coupons": [
      {
          "coupon_id": "COUPON_ID"  
      }
  ],
  "has_more": true
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10024000参数错误

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。