GET 商品列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/product |
| 所属业务 | 商品管理 |
| 来源模块/系统 | 商品管理 |
| 认证方式 | 无需认证 |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
商品列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 搜索范围商品ID商品名描述 |
| id | query | integer(int32) | 否 | 二级分组ID |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| exclusive | query | boolean | 否 | 是否只返回专属商品 |
| product_ids | query | array[integer] | 否 | 筛选哪些商品 |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.list | [object] | 否 | — | — | 商品列表 |
| data.list[].id | integer(int32) | 否 | — | — | ID |
| data.list[].name | string | 否 | — | — | 商品名 |
| data.list[].description | string | 否 | — | — | 描述 |
| data.list[].pay_type | string | 否 | — | — | 付款类型 免费free 一次onetime 周期先付recurring_prepayment 周期后付recurring_postpaid 按需计费on_demand 周期先付+按需计费recurring_prepayment_on_demand |
| data.list[].price | string | 否 | — | — | 商品最低价格 |
| data.list[].cycle | string | 否 | — | — | 商品最低周期 |
| data.list[].mode | string | 否 | — | — | 代理模式 only_api仅调用接口 sync同步商品 |
| data.list[].client_level_name | string | 否 | — | — | 用户等级名称 这个字段在没有用户等级插件时不存在所以需要注意判断 |
| data.list[].stock_control | integer(int32) | 否 | — | — | 是否开启库存 |
| data.list[].qty | integer(int32) | 否 | — | — | 库存数量 当开启库存该字段才有意义 |
| data.list[].pay_ontrial | object | 否 | — | — | 试用配置 status是否开启 cycle_type时长单位hour/day/month cycle_num时长 client_limit用户限制no不限制/new新用户/host用户必须存在激活中的产品 account_limit账户限制email绑定邮件/phone绑定手机/certification old_client_exclusive老用户专享商品ID多选逗号分隔 max单用户最大试用数量 |
| data.list[].product_group_id_first | integer | 否 | — | — | — |
| data.list[].module1 | null | 否 | — | — | — |
| data.list[].module | string | null | string | 否 | — | — | — |
| data.list[].product_group_id_second | integer | 否 | — | — | — |
| data.list[].res_module | string | 否 | — | — | — |
| data.list[].recommend_text | string | 否 | — | — | — |
| data.list[].product_group_name_first | string | 否 | — | — | — |
| data.list[].recommend | integer | 否 | — | — | — |
| data.list[].product_group_name_second | string | 否 | — | — | — |
| data.list[].recommend_color | string | 否 | — | — | — |
| data.count | integer(int32) | 否 | — | — | 商品总数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |