GET 自定义字段列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/self_defined_field |
| 所属业务 | 系统管理 |
| 来源模块/系统 | 自定义字段管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
自定义字段列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| type | query | string | 否 | 类型 product商品 product_group商品组 |
| relid | query | integer(int32) | 否 | 关联ID 商品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.list | [object] | 否 | — | — |
data.list[].id | integer(int32) | 否 | — | 自定义字段ID |
data.list[].field_name | string | 否 | — | 字段名称 |
data.list[].is_required | integer(int32) | 否 | — | 是否必填 0否 1是 |
data.list[].field_type | string | 否 | — | 字段类型 text文本框 link链接 password密码 dropdown下拉 tickbox勾选框 textarea文本区 explain说明 |
data.list[].description | string | 否 | — | 字段描述 |
data.list[].regexpr | string | 否 | — | 验证规则 |
data.list[].field_option | string | 否 | — | 下拉选项 |
data.list[].show_order_page | integer(int32) | 否 | — | 订单页可见 0否 1是 |
data.list[].show_order_detail | integer(int32) | 否 | — | 订单详情可见 0否 1是 |
data.list[].show_client_host_detail | integer(int32) | 否 | — | 前台产品详情可见 0否 1是 |
data.list[].show_admin_host_detail | integer(int32) | 否 | — | 后台产品详情可见 0否 1是 |
data.list[].show_client_host_list | integer(int32) | 否 | — | 会员中心列表显示 0否 1是 |
data.list[].show_admin_host_list | integer(int32) | 否 | — | 后台产品列表显示 0否 1是 |
data.list[].upstream_id | integer(int32) | 否 | — | 上游ID 大于0不能修改删除 |
data.list[].explain_content | string | 否 | — | 说明内容 |
data.list[].is_global | integer(int32) | 否 | — | 全局 0否 1是 |
data.list[].product_group | [object] | 否 | — | 关联商品分组 类型为商品组时返回 |
data.list[].product_group[].id | integer(int32) | 否 | — | 关联商品分组ID |
data.list[].product_group[].first_group_name | string | 否 | — | 一级分组名称 |
data.list[].product_group[].name | string | 否 | — | 关联商品分组名称 |
data.count | integer(int32) | 否 | — | 总条数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |