# 获取订阅的商品列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getsubscribeproduct
通过该接口,带货机构可获取已订阅的商品 注: 订阅的商品包括通过API主动订阅,以及将商品加入合作时被动触发订阅的两种情况
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/league/headsupplier/subscription/getsubscribe?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
filter | object | 否 | 筛选条件 |
page_size | number | 是 | 每页数量(不超过1000) |
next_key | string | 否 | 翻页参数,从第二页开始传,来源于上一页的返回值 |
need_total_num | boolean | 否 | 否需要返回符合条件的记录总数 |
# Body.filter Object Payload
筛选条件
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
product_id | number | 是 | 商品id |
product_name | string | 是 | 商品名称 |
appid | string | 是 | 店铺AppID |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
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
订阅的商品信息列表
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
product_id | number | 10000207528058 | 商品id |
shop_appid | string | wx2b255582a7b4bfd0 | 店铺AppID |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"filter": {
"product_id": 10000207528058,
"product_name": "",
"appid": ""
},
"page_size": 20,
"next_key": "",
"need_total_num": true
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"subscribe_info_list": {
"product_id": 10000207528058,
"shop_appid": "wx2b255582a7b4bfd0"
},
"total_num": 0,
"next_key": "",
"has_more": "false"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10024000 | 参数错误 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。