# 获取订阅的商品列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getsubscribeproduct

通过该接口，带货机构可获取已订阅的商品， 订阅的商品分以下两种情况

- 主动订阅：调用[商品订阅](api_subscribeproduct)接口主动订阅的商品
- 被动订阅：优选联盟后台合作商品中所有已合作商品，包括：1.商家定向计划 2.商家公开计划 3.机构定向计划 4.机构普通计划

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/league/headsupplier/subscription/getsubscribe?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/leagueheadsupplier/api/basic/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "filter",
    "类型": "object",
    "必填": "否",
    "说明": "筛选条件"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "说明": "每页数量(不超过1000)"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "必填": "否",
    "说明": "翻页参数，从第二页开始传，来源于上一页的返回值"
  },
  {
    "参数名": "need_total_num",
    "类型": "boolean",
    "必填": "否",
    "说明": "否需要返回符合条件的记录总数"
  }
]
```

### Body.filter `Object Payload`

筛选条件

```json
[
  {
    "参数名": "product_id",
    "类型": "number",
    "必填": "是",
    "说明": "商品id"
  },
  {
    "参数名": "product_name",
    "类型": "string",
    "必填": "是",
    "说明": "商品名称"
  },
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "是",
    "说明": "店铺AppID"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "0",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息"
  },
  {
    "参数名": "subscribe_info_list",
    "类型": "objarray",
    "示例": "",
    "说明": "订阅的商品信息列表"
  },
  {
    "参数名": "total_num",
    "类型": "number",
    "示例": "0",
    "说明": "符合条件的记录总数"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "示例": "",
    "说明": "翻页参数"
  },
  {
    "参数名": "has_more",
    "类型": "boolean",
    "示例": "false",
    "说明": "是否还有下一页"
  }
]
```

">

### Res.subscribe_info_list(Array) `Object Payload`

订阅的商品信息列表

```json
[
  {
    "参数名": "product_id",
    "类型": "number",
    "示例": "10000207528058",
    "说明": "商品id"
  },
  {
    "参数名": "shop_appid",
    "类型": "string",
    "示例": "wx2b255582a7b4bfd0",
    "说明": "店铺AppID"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "filter": {
        "product_id": 10000207528058,
        "product_name": "",
        "appid": ""
    },
    "page_size": 20,
    "next_key": "",
    "need_total_num": true
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "subscribe_info_list": {
        "product_id": 10000207528058,
        "shop_appid": "wx2b255582a7b4bfd0"
    },
    "total_num": 0,
    "next_key": "",
    "has_more": "false"
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10024000",
    "错误描述": "参数错误"
  }
]
```

## 7. 适用范围

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