租户管理接口文档

Base URL： /tenant

请求头：

参数名	说明
Authorization	Bearer {token}

统一响应格式：

{
  "code": 200,
  "msg": "success",
  "data": {}
}

通用错误响应：

{
  "code": 500,
  "msg": "错误信息描述",
  "data": null
}

1. 分页查询租户列表

接口地址： POST /tenant/page

请求格式： application/x-www-form-urlencoded

请求参数：

参数名	类型	必填	说明
pageNum	Integer	否	当前页码，默认 1
pageSize	Integer	否	每页条数，默认 20，最大 200
code	String	否	租户编码，模糊查询
name	String	否	租户名称，模糊查询
type	Integer	否	租户类型：0-平台 1-电商企业 2-货代 3-报关行
packageType	Integer	否	套餐类型
status	Integer	否	状态：0-禁用 1-启用
contactName	String	否	联系人姓名，模糊查询
createTimeBegin	String	否	入驻时间起，格式 `yyyy-MM-dd HH:mm:ss`
createTimeEnd	String	否	入驻时间止，格式 `yyyy-MM-dd HH:mm:ss`

响应示例：

{
  "code": 200,
  "msg": "success",
  "data": {
    "records": [
      {
        "id": 1,
        "code": "D00001",
        "name": "深圳市跨境通供应链有限公司",
        "type": 3,
        "packageType": 1,
        "status": 1,
        "contactName": "张三",
        "contactPhone": "13800000000",
        "createTime": "2026-04-02 10:30:00"
      }
    ],
    "total": 100,
    "size": 20,
    "current": 1,
    "pages": 5
  }
}

data 字段说明：

字段名	类型	说明
total	Long	总记录数
size	Integer	每页条数
current	Long	当前页码
pages	Long	总页数
records	Array	数据列表，见下表

records 字段说明：

字段名	类型	说明
id	Long	租户 ID
code	String	租户编码，如 D00001
name	String	租户名称
type	Integer	租户类型：0-平台 1-电商企业 2-货代 3-报关行
packageType	Integer	套餐类型
status	Integer	状态：0-禁用 1-启用
contactName	String	联系人姓名
contactPhone	String	联系人手机号
createTime	String	入驻时间，格式 `yyyy-MM-dd HH:mm:ss`

2. 获取租户详情

接口地址： GET /tenant/{id}

路径参数：

参数名	类型	必填	说明
id	Long	是	租户 ID

响应示例：

{
  "code": 200,
  "msg": "success",
  "data": {
    "id": 1,
    "code": "D00001",
    "name": "深圳市跨境通供应链有限公司",
    "creditCode": "91440300XXXXXXXXXX",
    "type": 3,
    "contactName": "张三",
    "contactPhone": "13800000000",
    "email": "zhangsan@example.com",
    "address": "广东省深圳市南山区XX路XX号",
    "attachments": [
      {
        "id": 1,
        "attachmentType": 1,
        "fileName": "营业执照.jpg",
        "fileUrl": "https://xxx.com/file/yyy.jpg"
      }
    ],
    "packageInfo": {
      "packageType": 1,
      "packagePrice": "999.00"
    }
  }
}

data 字段说明：

字段名	类型	说明
id	Long	租户 ID
code	String	租户编码
name	String	租户名称
creditCode	String	统一社会信用代码
type	Integer	租户类型：0-平台 1-电商企业 2-货代 3-报关行
contactName	String	联系人姓名
contactPhone	String	联系人手机号
email	String	电子邮箱
address	String	租户地址
attachments	Array	入驻附件列表，见下表
packageInfo	Object	当前套餐信息，见下表

attachments 字段说明：

字段名	类型	说明
id	Long	附件 ID
attachmentType	Integer	附件类型：1-营业执照 2-经营资质 3-法人身份证
fileName	String	原始文件名
fileUrl	String	文件存储路径

packageInfo 字段说明：

字段名	类型	说明
packageType	Integer	套餐类型
packagePrice	String	套餐价格

3. 编辑租户

接口地址： POST /tenant/update

请求格式： application/json

请求参数：

参数名	类型	必填	说明
id	Long	是	租户 ID
name	String	否	租户名称
creditCode	String	否	统一社会信用代码
packageType	Integer	否	套餐类型
contactName	String	否	联系人姓名
contactPhone	String	否	联系人手机号
email	String	否	电子邮箱
address	String	否	租户地址

请求示例：

{
  "id": 1,
  "name": "深圳市跨境通供应链有限公司",
  "creditCode": "91440300XXXXXXXXXX",
  "packageType": 1,
  "contactName": "张三",
  "contactPhone": "13800000000",
  "email": "zhangsan@example.com",
  "address": "广东省深圳市南山区XX路XX号"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "data": null
}

4. 启用/禁用租户

接口地址： POST /tenant/enable-or-disable

请求格式： application/json

请求参数：

参数名	类型	必填	说明
id	Long	是	租户 ID
status	Integer	是	目标状态：0-禁用 1-启用

请求示例：

{
  "id": 1,
  "status": 0
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "data": null
}

租户管理接口文档

租户管理接口文档#

1. 分页查询租户列表#

2. 获取租户详情#

3. 编辑租户#

4. 启用/禁用租户#

租户管理接口文档

1. 分页查询租户列表

2. 获取租户详情

3. 编辑租户

4. 启用/禁用租户