GET 商品详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/product/{id} |
| 所属业务 | 商品管理 |
| 来源模块/系统 | 商品管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
商品详情
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 商品 ID |
成功响应
正在加载示例…失败响应 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.product | object | 否 | — | 商品 |
data.product.id | integer(int32) | 否 | — | ID |
data.product.name | string | 否 | — | 商品名称 |
data.product.product_group_id | integer(int32) | 否 | — | 所属商品组 ID |
data.product.description | string | 否 | — | 商品描述 |
data.product.hidden | integer(int32) | 否 | — | 是否隐藏 0显示 1隐藏 |
data.product.stock_control | integer(int32) | 否 | — | 库存控制 1启用 0关闭 |
data.product.qty | integer(int32) | 否 | — | 库存数量 |
data.product.product_id | integer(int32) | 否 | — | 父商品 ID |
data.product.plugin_custom_fields | [string] | 否 | — | 自定义字段 |
data.product.show | integer(int32) | 否 | — | 是否展示在会员中心 0否 1是 |
data.product.renew_rule | string | 否 | — | 续费规则 due到期日 current当前时间 |
data.product.auto_renew_in_advance | integer(int32) | 否 | — | 自动续费提前开关 0关闭 1开启 |
data.product.auto_renew_in_advance_num | integer(int32) | 否 | — | 自动续费提前时间数 |
data.product.auto_renew_in_advance_unit | string | 否 | — | 自动续费提前时间单位 minute分钟 hour小时 day天 |
data.product.natural_month_prepaid | integer(int32) | 否 | — | 自然月预付费开关 0关闭 1开启 |
data.product.recommend | integer(int32) | 否 | — | 推荐开关 0关闭 1开启 |
data.product.recommend_text | string | 否 | — | 推荐文案 |
data.product.recommend_color | string | 否 | — | 推荐标签颜色 HEX格式如#FF5733 |
data.product.sync_stock | integer(int32) | 否 | — | — |
data.product.pay_type | string | 否 | — | — |
data.product.auto_setup | integer(int32) | 否 | — | — |
data.product.type | string | 否 | — | — |
data.product.rel_id | integer(int32) | 否 | — | — |
data.product.price | string | 否 | — | — |
data.product.cycle | string | 否 | — | — |
data.product.show_base_info | integer(int32) | 否 | — | — |
data.product.pay_ontrial | [任意类型] | 否 | — | — |
data.product.upgrade | [任意类型] | 否 | — | — |
data.product.product_group_id_first | integer(int32) | 否 | — | — |
data.product.module | string | 否 | — | — |
data.mode | string | 否 | — | 代理模式 only_api仅调用接口 sync同步商品 |
data.supplier_name | string | 否 | — | 供应商名称 |
data.profit_type | integer(int32) | 否 | — | 利润类型 0百分比价格方案 1自定义金额 |
data.show_base_info | integer(int32) | 否 | — | 产品列表是否展示基础信息 1是 0否 |
data.module | string | 否 | — | 商品对应模块 |
data.plugin_custom_fields | object | 否 | — | 插件钩子返回的自定义字段 |
data.pay_ontrial | object | 否 | — | 试用配置 |
data.pay_ontrial.status | integer(int32) | 否 | — | 是否开启 |
data.pay_ontrial.cycle_type | string | 否 | — | 时长单位 hour day month |
data.pay_ontrial.cycle_num | integer(int32) | 否 | — | 时长 |
data.pay_ontrial.client_limit | string | 否 | — | 用户限制 no不限制 new新用户 host用户必须存在激活中的产品 |
data.pay_ontrial.account_limit | string | 否 | — | 账户限制 email绑定邮件 phone绑定手机 certification实名 |
data.pay_ontrial.old_client_exclusive | string | 否 | — | 老用户专享商品 ID 逗号分隔 |
data.pay_ontrial.max | integer(int32) | 否 | — | 单用户最大试用数量 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |