# 获取定向券ID列表

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

接口英文名：getpromotecooperativecouponlist

可通过该接口，可获取定向券ID列表

# 1. 调用方式

# HTTPS 调用

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

# 云调用

本接口不支持云调用

# 第三方调用

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

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
shop_appid	string	否	店铺id，填了只返回属于该店铺的券
next_key	string	是	分页参数，第一页为空，后面返回前面一页返回的数据
page_size	number	是	券数量，不能超过 200
is_from_head_supplier	boolean	否	是否查询这个机构提供的券。见分发优惠券给其他机构
from_head_supplier_appid	string	否	查询特定机构提供的券，仅在is_from_head_supplier为true的情况下有效

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明
errcode	number	0	错误码
errmsg	string	ok	错误信息
next_key	string		分页参数，第一页为空，后面请求返回上一次请求返回的 next_key
coupons	objarray		券信息，推客的绑定参数列表
has_more	boolean		是否还有更多，如果返回为true，表示

# Res.coupons(Array) `Object Payload`

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

参数名	类型	示例	说明
coupon_id	string	COUPON_ID	券的 id
from_head_supplier_appid	string	wxaaaxxxx	券的来源机构。在is_from_head_supplier为true的情况下才会有该参数

# 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. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述
10024000	参数错误
10071003	参数错误

# 7. 适用范围

本接口支持「联盟带货机构」账号类型调用。其他账号类型如无特殊说明，均不可调用。

接口变更日志（1条）

2025 年 11 月 10 日

新增 is_from_head_supplier 、 from_head_supplier_appid 请求字段，补充错误码