# YAPI 接口文档

- Admin 平台用户
  - AdminUserLogin
  - AdminUserLogout
  - GetAdminUserByToken
  - 获取登录页图片
- 上传文件
  - 同步到云服务
  - 图片上传
  - 文件上传
- 会员 -- 分组
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 会员 -- 标签
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 会员 -- 等级
  - 修改
  - 分页列表
  - 清除会员等级
- 会员管理
  - 会员详情
  - 会员详情页Top数据
  - 修改
  - 分组
  - 分页列表
  - 删除
  - 标签
  - 积分余额
  - 详情
- 会员管理 -- 用户账单
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 分类服务
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 根据id集合获取分类列表
  - 获取tree结构的列表
  - 详情
- 分销
  - 分销列表
  - 分销头部数据
  - 分销管理信息保存
  - 分销配置信息获取
  - 根据条件获取推广人列表
  - 根据条件获取推广人订单
  - 添加推广关系
  - 清除上级推广人
- 后台用户服务
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 商品
  - 上架
  - 下架
  - 修改
  - 分页列表
  - 删除
  - 商品表头数量
  - 导入商品
  - 库存变动
  - 新增
  - 虚拟销量
  - 详情
- 商品 -- 规则值(规格)
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 商品 -- 评论
  - 修改
  - 分页列表
  - 删除
  - 回复
  - 新增
  - 详情
- 城市管理
  - 修改
  - 修改状态
  - 分页列表
  - 获取tree结构的列表
  - 详情
- 客服用户对话记录表
  - 分页列表
- 客服表
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 导出 -- Excel
  - 产品
- 微信 -- 消息模版
  - 修改
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 行业信息
  - 详情
- 微信开放平台 -- 小程序access_token
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 微信开放平台 -- 小程序二维码管理
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 微信开放平台 -- 微信二维码管理
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 微信开放平台 -- 微信关键字回复
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 根据关键字查询数据
  - 状态
  - 详情
- 微信开放平台 -- 微信用户
  - 消息推送
- 微信开放平台 -- 微信用户标签
  - 修改
  - 列表
  - 创建
  - 删除
  - 批量为用户取消标签
  - 批量为用户打标签
  - 获取标签下粉丝列表
  - 获取用户身上的标签列表
- 微信开放平台 -- 用户行为记录
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 微信开放平台 -- 素材
  - 上传
  - 根据素材id查询素材
- 微信开放平台 -- 菜单管理
  - 保存个性化菜单
  - 保存自定义菜单
  - 删除个性化菜单
  - 删除自定义菜单
  - 获取个性化菜单
  - 获取自定义菜单
- 微信开放平台 -- 表单id表记录
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 支付回调
  - 微信支付回调
  - 支付宝支付回调
- 文章管理
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 绑定产品
  - 详情
- 短信服务
  - 发送短信
  - sendCodeForRegister
  - 信息登录
  - 是否已经登录
  - 注销
  - 申请模板消息
  - 短信发送记录列表
  - 短信提醒开关保存
  - 短信提醒开关列表
  - 短信模板列表
  - 短信用户信息
  - 获取支付套餐列表
  - 获取支付码
  - 账号注册
- 统计 -- 主页
  - 30天订单量趋势
  - 周订单量趋势
  - 年订单量趋势
  - 新增用户
  - 月订单量趋势
  - 用户曲线图
  - 用户访问量
  - 用户购买统计
  - 订单量
  - 销售额
- 营销 -- 优惠券
  - 修改
  - 分页列表
  - 新增
  - 详情
- 营销 -- 优惠券 -- 领取记录
  - 分页列表
  - 领券
- 订单
  - 修改订单
  - 分页列表
  - 删除
  - 发送货
  - 备注
  - 快递查询
  - 拒绝退款
  - 详情
  - 退款
- 订单 -- 操作记录
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- Config
  - 整体保存表单数据
  - 检测表单name是否存在
  - 表单配置中仅仅存储
  - 表单配置根据key获取
  - 详情
- 设置 -- 会员等级
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 是否使用
  - 详情
- 设置 -- 会员等级 -- 等级任务
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 提货点 -- 提货点
  - 修改
  - 修改门店显示状态
  - 分页列表
  - 删除
  - 数量
  - 新增
  - 详情
- 设置 -- 提货点 -- 核销员
  - 修改
  - 修改状态
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 提货点 -- 核销订单
  - 分页列表
- 设置 -- 权限管理 -- 身份管理
  - TestMenu
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 菜单
  - 详情
- 设置 -- 物流 -- 付费
  - 根据模板id查询数据
- 设置 -- 物流 -- 免费
  - 根据模板id查询数据
- 设置 -- 物流 -- 公司
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 物流 -- 模板
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 管理员操作记录
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 组合数据
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 组合数据 -- 详情
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 设置 -- 表单模板
  - 修改
  - 分页列表
  - 新增
  - 详情
- 设置 -- 通知记录 -- 通知模板
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 详情
- 财务 -- 充值
  - 分页列表
  - 删除
  - 提现总金额
- 财务 -- 提现申请
  - 修改
  - 分页列表
  - 提现总金额
- 财务 -- 资金监控
  - 佣金记录
  - 资金监控
- 附件管理
  - 修改
  - 分页列表
  - 删除
  - 新增
  - 更改图片目录
  - 详情
- 验证码服务
  - 检测验证码
  - 获取验证码

# crmeb_java_admin

crmeb_java_admin

# Admin 平台用户

## AdminUserLogin

### 基本信息

Path： /api/admin/login

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
account | string | 非必须 |  | 后台管理员账号 |
code | string | 必须 |  | code |
key | string | 必须 |  | key |
pwd | string | 非必须 |  | 后台管理员密码 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ account | string | 非必须 |  |  |
├─ addTime | integer | 非必须 |  |  | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ lastIp | string | 非必须 |  |  |
├─ lastTime | integer | 非必须 |  |  | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ loginCount | integer | 非必须 |  |  | format: int32
├─ realName | string | 非必须 |  |  |
├─ roles | string | 非必须 |  |  |
├─ status | boolean | 非必须 |  |  |
├─ token | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## AdminUserLogout

### 基本信息

Path： /api/admin/logout

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ account | string | 非必须 |  |  |
├─ addTime | integer | 非必须 |  |  | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ lastIp | string | 非必须 |  |  |
├─ lastTime | integer | 非必须 |  |  | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ loginCount | integer | 非必须 |  |  | format: int32
├─ realName | string | 非必须 |  |  |
├─ roles | string | 非必须 |  |  |
├─ status | boolean | 非必须 |  |  |
├─ token | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## GetAdminUserByToken

### 基本信息

Path： /api/admin/getAdminInfoByToken

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ account | string | 非必须 |  |  |
├─ addTime | integer | 非必须 |  |  | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ lastIp | string | 非必须 |  |  |
├─ lastTime | integer | 非必须 |  |  | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ loginCount | integer | 非必须 |  |  | format: int32
├─ realName | string | 非必须 |  |  |
├─ roles | string | 非必须 |  |  |
├─ status | boolean | 非必须 |  |  |
├─ token | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取登录页图片

### 基本信息

Path： /api/admin/getLoginPic

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 上传文件

## 同步到云服务

### 基本信息

Path： /api/admin/upload/async

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ extName | string | 非必须 |  |  |
├─ fileName | string | 非必须 |  |  |
├─ fileSize | integer | 非必须 |  |  | format: int64
├─ serverPath | string | 非必须 |  |  |
├─ type | string | 非必须 |  |  |
├─ url | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 图片上传

### 基本信息

Path： /api/admin/upload/image

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | multipart/form-data | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
model | 否 |  | 模块 用户user,商品product,微信wechat,news文章
pid | 否 |  | 分类ID 0编辑器,1商品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图,7前台用户,8微信系列

Body

参数名称 | 参数类型 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
multipart | file | 否 |  | multipart

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ extName | string | 非必须 |  |  |
├─ fileName | string | 非必须 |  |  |
├─ fileSize | integer | 非必须 |  |  | format: int64
├─ serverPath | string | 非必须 |  |  |
├─ type | string | 非必须 |  |  |
├─ url | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 文件上传

### 基本信息

Path： /api/admin/upload/file

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | multipart/form-data | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
model | 否 |  | 模块 用户user,商品product,微信wechat,news文章
pid | 否 |  | 分类ID 0编辑器,1商品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图,7前台用户,8微信系列

Body

参数名称 | 参数类型 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
multipart | file | 否 |  | multipart

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ extName | string | 非必须 |  |  |
├─ fileName | string | 非必须 |  |  |
├─ fileSize | integer | 非必须 |  |  | format: int64
├─ serverPath | string | 非必须 |  |  |
├─ type | string | 非必须 |  |  |
├─ url | string | 非必须 |  |  |
message | string | 非必须 |  |  |

# 会员 -- 分组

## 修改

### 基本信息

Path： /api/admin/user/group/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
groupName | string | 非必须 |  | 用户分组名称 |
id | integer | 非必须 |  |  | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/user/group/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ groupName | string | 非必须 |  | 用户分组名称 |
├─ id | integer | 非必须 |  |  | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/user/group/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/user/group/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
groupName | string | 非必须 |  | 用户分组名称 |
id | integer | 非必须 |  |  | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/user/group/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 用户分组表 |
├─ groupName | string | 非必须 |  | 用户分组名称 |
├─ id | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

# 会员 -- 标签

## 修改

### 基本信息

Path： /api/admin/user/tag/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
name | string | 非必须 |  | 标签名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/user/tag/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 标签名称 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/user/tag/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/user/tag/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
name | string | 非必须 |  | 标签名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/user/tag/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 用户标签表 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 标签名称 |
message | string | 非必须 |  |  |

# 会员 -- 等级

## 修改

### 基本信息

Path： /api/admin/user/level/level

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
levelId | 是 |  | 等级ID
userId | 是 |  | 会员ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/user/level/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 添加时间
discount | 否 |  | 享受折扣
grade | 否 |  | 会员等级
isDel | 否 |  | 是否删除,0=未删除,1=删除
isForever | 否 |  | 是否永久
levelId | 否 |  | 等级vip
limit | 否 |  | 每页数量
mark | 否 |  | 备注
merId | 否 |  | 商户id
page | 否 |  | 页码
remind | 否 |  | 是否已通知
status | 否 |  | 0:禁止,1:正常
uid | 否 |  | 用户uid
validTime | 否 |  | 过期时间

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ discount | number | 非必须 |  | 享受折扣 |
├─ grade | integer | 非必须 |  | 会员等级 | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ isDel | boolean | 非必须 |  | 是否删除,0=未删除,1=删除 |
├─ levelId | integer | 非必须 |  | 等级vip | format: int32
├─ mark | string | 非必须 |  | 备注 |
├─ remind | boolean | 非必须 |  | 是否已通知 |
├─ status | boolean | 非必须 |  | 0:禁止,1:正常 |
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 清除会员等级

### 基本信息

Path： /api/admin/user/level/clean

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
userId | 是 |  | 会员ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

# 会员管理

## 会员详情

### 基本信息

Path： /api/admin/user/infobycondition

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
type | 是 |  | 0=消费记录，1=积分明细，2=签到记录，3=持有优惠券，4=余额变动，5=好友关系
userId | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 会员详情页Top数据

### 基本信息

Path： /api/admin/user/topdetail

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
userId | 是 |  | userId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ allConsumeCount | number | 非必须 |  |  |
├─ allOrderCount | integer | 非必须 |  |  | format: int32
├─ balance | number | 非必须 |  |  |
├─ integralCount | number | 非必须 |  |  |
├─ mothConsumeCount | number | 非必须 |  |  |
├─ mothOrderCount | integer | 非必须 |  |  | format: int32
├─ user | object | 非必须 |  | 用户表 |
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | string | 非必须 |  | 用户分组id |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ path | string | 非必须 |  | 用户推广等级 |
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ subscribe | boolean | 非必须 |  | 是否关注公众号 |
├─ tagId | string | 非必须 |  | 用户标签id |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
message | string | 非必须 |  |  |

## 修改

### 基本信息

Path： /api/admin/user/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
addres | string | 非必须 |  | 详细地址 |
birthday | string | 非必须 |  | 生日 |
cardId | string | 非必须 |  | 身份证号码 |
groupId | string | 非必须 |  | 用户分组id |
isPromoter | boolean | 非必须 |  | 是否为推广员 |
level | integer | 非必须 |  | 等级 | format: int32
mark | string | 非必须 |  | 用户备注 |
phone | string | 非必须 |  | 手机号码 |
realName | string | 非必须 |  | 真实姓名 |
status | boolean | 非必须 |  | 状态是否正常， 0 = 禁止， 1 = 正常 |
tagId | string | 非必须 |  | 用户标签id |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分组

### 基本信息

Path： /api/admin/user/group

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
groupId | 是 |  | groupId
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/user/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
accessType | 否 |  | 访问情况， 0 = 全部， 1 = 首次， 2 = 访问过， 3 = 未访问
city | 否 |  | 城市
country | 否 |  | 国家
data | 否 |  | 时间
groupId | 否 |  | 用户分组
isPromoter | 否 |  | 是否为推广员， 0 = 禁止， 1 = 正常
keywords | 否 |  | 关键字
labelId | 否 |  | 用户标签
level | 否 |  | 等级
limit | 否 |  | 每页数量
loginType | 否 |  | 用户登陆类型，h5 = h5， wechat = wechat，routine = routine
page | 否 |  | 页码
payCount | 否 |  | 消费情况
province | 否 |  | 省份
sex | 否 |  | 性别
status | 否 |  | 状态是否正常， 0 = 禁止， 1 = 正常

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 清除时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | integer | 非必须 |  | 用户分组id | format: int32
├─ groupName | string | 非必须 |  | 分组名称 |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadNickname | string | 非必须 |  | 推广员名称 |
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ tagName | string | 非必须 |  | 标签名称 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/user/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 标签

### 基本信息

Path： /api/admin/user/tag

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
tagId | 是 |  | tagId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 积分余额

### 基本信息

Path： /api/admin/user/operate/founds

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
integralType | 否 |  | 积分类型， 1 = 增加， 2 = 减少
integralValue | 否 |  | 积分
moneyType | 否 |  | 余额类型， 1 = 增加， 2 = 减少
moneyValue | 否 |  | 余额
uid | 否 |  | uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/user/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 用户表 |
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | string | 非必须 |  | 用户分组id |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ path | string | 非必须 |  | 用户推广等级 |
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ subscribe | boolean | 非必须 |  | 是否关注公众号 |
├─ tagId | string | 非必须 |  | 用户标签id |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
message | string | 非必须 |  |  |

# 会员管理 -- 用户账单

## 修改

### 基本信息

Path： /api/admin/user/bill/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
balance | 否 |  | 剩余
category | 否 |  | 明细种类
id | 是 |  | id
linkId | 否 |  | 关联id
mark | 否 |  | 备注
number | 否 |  | 明细数字
pm | 否 |  | 0 = 支出 1 = 获得
status | 否 |  | 0 = 带确定 1 = 有效 -1 = 无效
title | 否 |  | 账单标题
type | 否 |  | 明细类型
uid | 否 |  | 用户uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/user/bill/list

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
category | string | 非必须 |  | 类型 |
dateLimit | string | 非必须 |  | 添加时间 |
keywords | string | 非必须 |  | 搜索关键字 |
max | number | 非必须 |  | 最大佣金 |
min | number | 非必须 |  | 最小佣金 |
sort | string | 非必须 |  | 排序 asc/desc |
type | string | 非必须 |  | 类型 |
uid | integer | 非必须 |  | 用户id list | format: int32
userIdList | integer [] | 非必须 |  | 用户id list | item 类型: integer
├─ |  | 非必须 |  |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ add_time | string | 非必须 |  | 创建时间 | format: date-time
├─ balance | number | 非必须 |  | 剩余 |
├─ category | string | 非必须 |  | 明细种类 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 用户账单id | format: int32
├─ linkId | string | 非必须 |  | 关联id |
├─ mark | string | 非必须 |  | 备注 |
├─ nickName | string | 非必须 |  | 用户呢成 |
├─ number | number | 非必须 |  | 明细数字 |
├─ pm | integer | 非必须 |  | 0 = 支出 1 = 获得 | format: int32
├─ status | integer | 非必须 |  | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32
├─ title | string | 非必须 |  | 账单标题 |
├─ type | string | 非必须 |  | 明细类型 |
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/user/bill/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/user/bill/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
balance | 否 |  | 剩余
category | 否 |  | 明细种类
linkId | 否 |  | 关联id
mark | 否 |  | 备注
number | 否 |  | 明细数字
pm | 否 |  | 0 = 支出 1 = 获得
status | 否 |  | 0 = 带确定 1 = 有效 -1 = 无效
title | 否 |  | 账单标题
type | 否 |  | 明细类型
uid | 否 |  | 用户uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/user/bill/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 用户账单表 |
├─ add_time | string | 非必须 |  | 创建时间 | format: date-time
├─ balance | number | 非必须 |  | 剩余 |
├─ category | string | 非必须 |  | 明细种类 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 用户账单id | format: int32
├─ linkId | string | 非必须 |  | 关联id |
├─ mark | string | 非必须 |  | 备注 |
├─ nickName | string | 非必须 |  | 用户呢成 |
├─ number | number | 非必须 |  | 明细数字 |
├─ pm | integer | 非必须 |  | 0 = 支出 1 = 获得 | format: int32
├─ status | integer | 非必须 |  | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32
├─ title | string | 非必须 |  | 账单标题 |
├─ type | string | 非必须 |  | 明细类型 |
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
message | string | 非必须 |  |  |

# 分类服务

## 修改

### 基本信息

Path： /api/admin/category/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
extra | 否 |  | 扩展字段
id | 否 |  | 分类ID
name | 否 |  | 分类名称
pid | 否 |  | 父级ID
sort | 否 |  | 排序
status | 否 |  | 状态, 0正常，1失效
type | 否 |  | 类型，类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置
url | 否 |  | 地址

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/category/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
name | 否 |  | 分类名称
page | 否 |  | 页码
pid | 否 |  | 父级ID
status | 否 |  | 状态, 0正常，1失效
type | 否 |  | 类型ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型ID | 类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/category/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 分类ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/category/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
extra | 否 |  | 扩展字段
name | 否 |  | 分类名称
pid | 否 |  | 父级ID
sort | 否 |  | 排序
status | 否 |  | 状态, 0正常，1失效
type | 否 |  | 类型，类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置
url | 否 |  | 地址

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 根据id集合获取分类列表

### 基本信息

Path： /api/admin/category/list/ids

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
ids | 否 |  | 分类id集合

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型ID | 类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
message | string | 非必须 |  |  |

## 获取tree结构的列表

### 基本信息

Path： /api/admin/category/list/tree

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
status | 否 |  | -1=全部，0=未生效，1=已生效
type | 否 |  | 类型ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ child | [] | 非必须 |  |  |
├─ |  | 非必须 |  |  |
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型，类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/category/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 分类ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 分类表 |
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型ID | 类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
message | string | 非必须 |  |  |

# 分销

## 分销列表

### 基本信息

Path： /api/admin/store/retail/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
dateLimit | 否 |  | today,yesterday,lately7,lately30,month,year,/yyyy-MM-dd hh:mm:ss,yyyy-MM-dd hh:mm:ss/
keywords | 否 |  | 搜索关键字[身份证，手机，昵称，备注等]
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokerageMoney | number | 非必须 |  | 佣金数据 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 清除时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | integer | 非必须 |  | 用户分组id | format: int32
├─ groupName | string | 非必须 |  | 分组名称 |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ retailShopOrderDataResponse | object | 非必须 |  |  |
├─ orderCount | integer | 非必须 |  | 订单数量 | format: int32
├─ orderPrice | number | 非必须 |  | 订单总价 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadNickname | string | 非必须 |  | 推广员名称 |
├─ spreadPeopleCount | integer | 非必须 |  | 推广用户数量 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ tagName | string | 非必须 |  | 标签名称 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userExtractResponse | object | 非必须 |  |  |
├─ extractCountNum | integer | 非必须 |  | 提现次数 | format: int32
├─ extractCountPrice | number | 非必须 |  | 体现数据总额 |
├─ userType | string | 非必须 |  | 用户类型 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 分销头部数据

### 基本信息

Path： /api/admin/store/retail/statistics

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
dateLimit | 否 |  | today,yesterday,lately7,lately30,month,year,/yyyy-MM-dd hh:mm:ss,yyyy-MM-dd hh:mm:ss/
nickName | 否 |  | 昵称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分销管理信息保存

### 基本信息

Path： /api/admin/store/retail/spread/manage/set

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
brokerageBindind | string | 非必须 |  | 分销关系绑定 |
brokerageFuncStatus | string | 非必须 |  | 是否启用分销 |
extractTime | string | 非必须 |  | 冻结时间 |
storeBrokeragePrice | string | 非必须 |  | 人人分销满足金额 |
storeBrokerageRatio | string | 非必须 |  | 一级返佣比例 |
storeBrokerageStatus | string | 非必须 |  | 分销模式 |
storeBrokerageTwo | string | 非必须 |  | 二级返佣比例 |
userExtractBank | string | 非必须 |  | 提现银行 |
userExtractMinPrice | string | 非必须 |  | 用户提现最低金额 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分销配置信息获取

### 基本信息

Path： /api/admin/store/retail/spread/manage/get

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 根据条件获取推广人列表

### 基本信息

Path： /api/admin/store/retail/spread/userlist

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
dateLimit | string | 非必须 |  | 时间参数 today,yesterday,lately7,lately30,month,year,/yyyy-MM-dd hh:mm:ss,yyyy-MM-dd hh:mm:ss/ |
nickName | string | 非必须 |  | 搜索关键字 |
orderPriceId | string | 非必须 |  |  |
type | integer | 非必须 |  | 类型 null = 全部 1=一级推广人 2=二级推广人 | format: int32
uid | integer | 非必须 |  | 用户id | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | string | 非必须 |  | 用户分组id |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ path | string | 非必须 |  | 用户推广等级 |
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ subscribe | boolean | 非必须 |  | 是否关注公众号 |
├─ tagId | string | 非必须 |  | 用户标签id |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 根据条件获取推广人订单

### 基本信息

Path： /api/admin/store/retail/spread/orderlist

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
dateLimit | string | 非必须 |  | 时间参数 today,yesterday,lately7,lately30,month,year,/yyyy-MM-dd hh:mm:ss,yyyy-MM-dd hh:mm:ss/ |
nickName | string | 非必须 |  | 搜索关键字 |
orderPriceId | string | 非必须 |  |  |
type | integer | 非必须 |  | 类型 null = 全部 1=一级推广人 2=二级推广人 | format: int32
uid | integer | 非必须 |  | 用户id | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ backIntegral | number | 非必须 |  | 给用户退了多少积分 |
├─ bargainId | integer | 非必须 |  | 砍价id | format: int32
├─ clerkId | integer | 非必须 |  | 店员id | format: int32
├─ combinationId | integer | 非必须 |  | 拼团商品id0一般商品 | format: int32
├─ cost | number | 非必须 |  | 成本价 |
├─ couponId | integer | 非必须 |  | 优惠券id | format: int32
├─ couponPrice | number | 非必须 |  | 优惠券金额 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ deductionPrice | number | 非必须 |  | 抵扣金额 |
├─ deliveryId | string | 非必须 |  | 快递单号/手机号 |
├─ deliveryName | string | 非必须 |  | 快递名称/送货人姓名 |
├─ deliveryType | string | 非必须 |  | 发货类型 |
├─ freightPrice | number | 非必须 |  | 运费金额 |
├─ gainIntegral | number | 非必须 |  | 消费赚取积分 |
├─ id | integer | 非必须 |  | 订单ID | format: int32
├─ isChannel | integer | 非必须 |  | 支付渠道(0微信公众号1微信小程序) | format: int32
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isMerCheck | integer | 非必须 |  |  | format: int32
├─ isRemind | boolean | 非必须 |  | 消息提醒 |
├─ isSystemDel | boolean | 非必须 |  | 后台是否删除 |
├─ mark | string | 非必须 |  | 备注 |
├─ merId | integer | 非必须 |  | 商户ID | format: int32
├─ orderId | string | 非必须 |  | 订单号 |
├─ paid | boolean | 非必须 |  | 支付状态 |
├─ payPostage | number | 非必须 |  | 支付邮费 |
├─ payPrice | number | 非必须 |  | 实际支付金额 |
├─ payTime | string | 非必须 |  | 支付时间 | format: date-time
├─ payType | string | 非必须 |  | 支付方式 |
├─ pinkId | integer | 非必须 |  | 拼团id 0没有拼团 | format: int32
├─ realName | string | 非必须 |  | 用户姓名 |
├─ refundPrice | number | 非必须 |  | 退款金额 |
├─ refundReason | string | 非必须 |  | 不退款的理由 |
├─ refundReasonTime | string | 非必须 |  | 退款时间 | format: date-time
├─ refundReasonWap | string | 非必须 |  | 前台退款原因 |
├─ refundReasonWapExplain | string | 非必须 |  | 退款用户说明 |
├─ refundReasonWapImg | string | 非必须 |  | 退款图片 |
├─ refundStatus | integer | 非必须 |  | 0 未退款 1 申请中 2 已退款 | format: int32
├─ remark | string | 非必须 |  | 管理员备注 |
├─ seckillId | integer | 非必须 |  | 秒杀商品ID | format: int32
├─ shippingType | integer | 非必须 |  | 配送方式 1=快递 ，2=门店自提 | format: int32
├─ status | integer | 非必须 |  | 订单状态（-1 : 申请退款 -2 : 退货成功 0：待发货；1：待收货；2：已收货，待评价；3：已完成；） | format: int32
├─ storeId | integer | 非必须 |  | 门店id | format: int32
├─ totalNum | integer | 非必须 |  | 订单商品总数 | format: int32
├─ totalPostage | number | 非必须 |  | 邮费 |
├─ totalPrice | number | 非必须 |  | 订单总价 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ unique | string | 非必须 |  | 唯一id(md5加密)类似id |
├─ useIntegral | number | 非必须 |  | 使用积分 |
├─ userAddress | string | 非必须 |  | 详细地址 |
├─ userPhone | string | 非必须 |  | 用户电话 |
├─ verifyCode | string | 非必须 |  | 核销码 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 添加推广关系

### 基本信息

Path： /api/admin/store/retail/spread/save

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
currentUserId | 否 |  | 当前用户id
spreadUserId | 否 |  | 推广人id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 清除上级推广人

### 基本信息

Path： /api/admin/store/retail/spread/clean/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 后台用户服务

## 修改

### 基本信息

Path： /api/admin/system/admin/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 否 |  | 后台管理员账号
addTime | 否 |  | 后台管理员添加时间
id | 是 |  | id
id | 否 |  | 后台管理员表ID
isDel | 否 |  | 是否删除 1删除 0未删除
lastIp | 否 |  | 后台管理员最后一次登录ip
lastTime | 否 |  | 后台管理员最后一次登录时间
level | 否 |  | 后台管理员级别
loginCount | 否 |  | 登录次数
pwd | 否 |  | 后台管理员密码
realName | 否 |  | 后台管理员姓名
roles | 否 |  | 后台管理员权限(menus_id)
status | 否 |  | 后台管理员状态 1有效0无效

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/admin/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 否 |  | 后台管理员账号
addTime | 否 |  | 后台管理员添加时间
id | 否 |  | 后台管理员表ID
isDel | 否 |  | 是否删除 1删除 0未删除
lastIp | 否 |  | 后台管理员最后一次登录ip
lastTime | 否 |  | 后台管理员最后一次登录时间
level | 否 |  | 后台管理员级别
limit | 否 |  | 每页数量
loginCount | 否 |  | 登录次数
page | 否 |  | 页码
pwd | 否 |  | 后台管理员密码
realName | 否 |  | 后台管理员姓名
roles | 否 |  | 后台管理员权限(menus_id)
status | 否 |  | 后台管理员状态 1有效0无效

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ account | string | 非必须 |  | 后台管理员账号 |
├─ addTime | integer | 非必须 |  | 后台管理员添加时间 | format: int32
├─ id | integer | 非必须 |  | 后台管理员表ID | format: int32
├─ isDel | boolean | 非必须 |  |  |
├─ lastIp | string | 非必须 |  | 后台管理员最后一次登录ip |
├─ lastTime | integer | 非必须 |  | 后台管理员最后一次登录时间 | format: int32
├─ level | integer | 非必须 |  | 后台管理员级别 | format: int32
├─ loginCount | integer | 非必须 |  | 登录次数 | format: int32
├─ pwd | string | 非必须 |  | 后台管理员密码 |
├─ realName | string | 非必须 |  | 后台管理员姓名 |
├─ roles | string | 非必须 |  | 后台管理员权限(menus_id) |
├─ status | boolean | 非必须 |  | 后台管理员状态 1有效0无效 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/admin/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/admin/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 是 |  | 后台管理员账号
level | 是 |  | 后台管理员级别
pwd | 是 |  | 后台管理员密码
realName | 是 |  | 后台管理员姓名
roles | 是 |  | 后台管理员权限(menus_id)
status | 是 |  | 后台管理员状态 1有效0无效

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ account | string | 非必须 |  |  |
├─ addTime | integer | 非必须 |  |  | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ lastIp | string | 非必须 |  |  |
├─ lastTime | integer | 非必须 |  |  | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ loginCount | integer | 非必须 |  |  | format: int32
├─ realName | string | 非必须 |  |  |
├─ roles | string | 非必须 |  |  |
├─ status | boolean | 非必须 |  |  |
├─ token | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/admin/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 后台管理员表 |
├─ account | string | 非必须 |  | 后台管理员账号 |
├─ addTime | integer | 非必须 |  | 后台管理员添加时间 | format: int32
├─ id | integer | 非必须 |  | 后台管理员表ID | format: int32
├─ isDel | boolean | 非必须 |  |  |
├─ lastIp | string | 非必须 |  | 后台管理员最后一次登录ip |
├─ lastTime | integer | 非必须 |  | 后台管理员最后一次登录时间 | format: int32
├─ level | integer | 非必须 |  | 后台管理员级别 | format: int32
├─ loginCount | integer | 非必须 |  | 登录次数 | format: int32
├─ pwd | string | 非必须 |  | 后台管理员密码 |
├─ realName | string | 非必须 |  | 后台管理员姓名 |
├─ roles | string | 非必须 |  | 后台管理员权限(menus_id) |
├─ status | boolean | 非必须 |  | 后台管理员状态 1有效0无效 |
message | string | 非必须 |  |  |

# 商品

## 上架

### 基本信息

Path： /api/admin/store/product/putOnShell/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 下架

### 基本信息

Path： /api/admin/store/product/offShell/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改

### 基本信息

Path： /api/admin/store/product/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
addTime | integer | 非必须 |  | 添加时间 | format: int32
attr | object [] | 非必须 |  | 商品属性 | item 类型: object
├─ attrName | string | 非必须 |  | 属性名 |
├─ attrValues | string | 非必须 |  | 属性值 |
├─ id | integer | 非必须 |  | attrId | format: int32
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ type | integer | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 | format: int32
attrValue | object [] | 非必须 |  | 商品属性详情 | item 类型: object
├─ attrValue | object | 非必须 |  | attrValue字段，前端传递后用作sku字段 |
├─ barCode | string | 非必须 |  | 商品条码 |
├─ brokerage | number | 非必须 |  | 一级返佣 |
├─ brokerageTwo | number | 非必须 |  | 二级返佣 |
├─ cost | number | 非必须 |  | 成本价 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | ID | format: int32
├─ image | string | 非必须 |  | 图片 |
├─ otPrice | number | 非必须 |  | 原价 |
├─ price | number | 非必须 |  | 属性金额 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ quota | integer | 非必须 |  | 活动限购数量 | format: int32
├─ quotaShow | integer | 非必须 |  | 活动限购数量显示 | format: int32
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ stock | integer | 非必须 |  | 属性对应的库存 | format: int32
├─ suk | string | 非必须 |  | 商品属性索引值 (attr_value|attr_value[|....]) |
├─ type | boolean | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 |
├─ unique | string | 非必须 |  | 唯一值 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ volume | number | 非必须 |  | 体积 |
├─ weight | number | 非必须 |  | 重量 |
barCode | string | 非必须 |  | 商品条码（一维码） |
browse | integer | 非必须 |  | 浏览量 | format: int32
cateId | string | 非必须 |  | 分类id |
cateIds | integer [] | 非必须 |  | 商品分类 | item 类型: integer
├─ |  | 非必须 |  |  |
codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
content | string | 非必须 |  | 商品描述 |
cost | number | 非必须 |  | 成本价 |
couponIds | integer [] | 非必须 |  | 优惠券id集合 | item 类型: integer
├─ |  | 非必须 |  |  |
ficti | integer | 非必须 |  | 虚拟销量 | format: int32
giveIntegral | number | 非必须 |  | 获得积分 |
id | integer | 非必须 |  | 商品id | format: int32
image | string | 非必须 |  | 商品图片 |
isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
isBenefit | boolean | 非必须 |  | 是否优惠 |
isBest | boolean | 非必须 |  | 是否精品 |
isDel | boolean | 非必须 |  | 是否删除 |
isGood | boolean | 非必须 |  | 是否优品推荐 |
isHot | boolean | 非必须 |  | 是否热卖 |
isNew | boolean | 非必须 |  | 是否新品 |
isPostage | boolean | 非必须 |  | 是否包邮 |
isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
isSub | boolean | 非必须 |  | 是否单独分佣 |
keyword | string | 非必须 |  | 关键字 |
merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
otPrice | number | 非必须 |  | 市场价 |
postage | number | 非必须 |  | 邮费 |
price | number | 非必须 |  | 商品价格 |
sales | integer | 非必须 |  | 销量 | format: int32
sliderImage | string | 非必须 |  | 轮播图 |
sort | integer | 非必须 |  | 排序 | format: int32
soureLink | string | 非必须 |  | 淘宝京东1688类型 |
specType | boolean | 非必须 |  | 规格 0单 1多 |
stock | integer | 非必须 |  | 库存 | format: int32
storeInfo | string | 非必须 |  | 商品简介 |
storeName | string | 非必须 |  | 商品名称 |
tempId | integer | 非必须 |  | 运费模板ID | format: int32
unitName | string | 非必须 |  | 单位名 |
videoLink | string | 非必须 |  | 主图视频链接 |
vipPrice | number | 非必须 |  | 会员价格 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store/product/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
cateId | 否 |  | 分类ID， 多个逗号分隔
isBenefit | 否 |  | 是否优惠
isBest | 否 |  | 是否精品
isGood | 否 |  | 是否推荐
isHot | 否 |  | 是否热卖
isNew | 否 |  | 是否新品
isShow | 否 |  | 状态（0：未上架，1：上架）
keywords | 否 |  | 关键字搜索， 支持(商品名称, 商品简介, 关键字, 商品条码)
limit | 否 |  | 每页数量
page | 否 |  | 页码
type | 否 |  | 类型（1：出售中（已上架），2：仓库中（未上架），3：已售罄，4：警戒库存，5：回收站）

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
├─ addTime | integer | 非必须 |  | 添加时间 | format: int32
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ browse | integer | 非必须 |  | 浏览量 | format: int32
├─ cateId | string | 非必须 |  | 分类id |
├─ codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
├─ cost | number | 非必须 |  | 成本价 |
├─ ficti | integer | 非必须 |  | 虚拟销量 | format: int32
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
├─ isBenefit | boolean | 非必须 |  | 是否优惠 |
├─ isBest | boolean | 非必须 |  | 是否精品 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isGood | boolean | 非必须 |  | 是否优品推荐 |
├─ isHot | boolean | 非必须 |  | 是否热卖 |
├─ isNew | boolean | 非必须 |  | 是否新品 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
├─ isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ soureLink | string | 非必须 |  | 淘宝京东1688类型 |
├─ specType | boolean | 非必须 |  | 规格 0单 1多 |
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ videoLink | string | 非必须 |  | 主图视频链接 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store/product/delete/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 商品表头数量

### 基本信息

Path： /api/admin/store/product/tabs/headers

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ count | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  |  |
├─ type | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 导入商品

### 基本信息

Path： /api/admin/store/product/importProduct

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
form | 是 |  | 导入平台1=淘宝，2=京东，3=苏宁，4=拼多多, 5=天猫
url | 是 |  | URL

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 商品表 |
├─ activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
├─ addTime | integer | 非必须 |  | 添加时间 | format: int32
├─ attr | object [] | 非必须 |  | 商品属性 | item 类型: object
├─ attrName | string | 非必须 |  | 属性名 |
├─ attrValues | string | 非必须 |  | 属性值 |
├─ id | integer | 非必须 |  | attrId | format: int32
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ type | integer | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 | format: int32
├─ attrValue | object [] | 非必须 |  | 商品属性详情 | item 类型: object
├─ attrValue | object | 非必须 |  | attrValue字段，前端传递后用作sku字段 |
├─ barCode | string | 非必须 |  | 商品条码 |
├─ brokerage | number | 非必须 |  | 一级返佣 |
├─ brokerageTwo | number | 非必须 |  | 二级返佣 |
├─ cost | number | 非必须 |  | 成本价 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | ID | format: int32
├─ image | string | 非必须 |  | 图片 |
├─ otPrice | number | 非必须 |  | 原价 |
├─ price | number | 非必须 |  | 属性金额 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ quota | integer | 非必须 |  | 活动限购数量 | format: int32
├─ quotaShow | integer | 非必须 |  | 活动限购数量显示 | format: int32
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ stock | integer | 非必须 |  | 属性对应的库存 | format: int32
├─ suk | string | 非必须 |  | 商品属性索引值 (attr_value|attr_value[|....]) |
├─ type | boolean | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 |
├─ unique | string | 非必须 |  | 唯一值 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ volume | number | 非必须 |  | 体积 |
├─ weight | number | 非必须 |  | 重量 |
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ browse | integer | 非必须 |  | 浏览量 | format: int32
├─ cateId | string | 非必须 |  | 分类id |
├─ cateIds | integer [] | 非必须 |  | 商品分类 | item 类型: integer
├─ |  | 非必须 |  |  |
├─ codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
├─ content | string | 非必须 |  | 商品描述 |
├─ cost | number | 非必须 |  | 成本价 |
├─ couponIds | integer [] | 非必须 |  | 优惠券id集合 | item 类型: integer
├─ |  | 非必须 |  |  |
├─ ficti | integer | 非必须 |  | 虚拟销量 | format: int32
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
├─ isBenefit | boolean | 非必须 |  | 是否优惠 |
├─ isBest | boolean | 非必须 |  | 是否精品 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isGood | boolean | 非必须 |  | 是否优品推荐 |
├─ isHot | boolean | 非必须 |  | 是否热卖 |
├─ isNew | boolean | 非必须 |  | 是否新品 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
├─ isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ soureLink | string | 非必须 |  | 淘宝京东1688类型 |
├─ specType | boolean | 非必须 |  | 规格 0单 1多 |
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ videoLink | string | 非必须 |  | 主图视频链接 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
message | string | 非必须 |  |  |

## 库存变动

### 基本信息

Path： /api/admin/store/product/stock

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
idList | 是 |  | 商品ID, 多个逗号分割，如果是修改所有的，参数值为 all
num | 是 |  | 数量
type | 是 |  | 类型， 增加 add

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/store/product/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
addTime | integer | 非必须 |  | 添加时间 | format: int32
attr | object [] | 非必须 |  | 商品属性 | item 类型: object
├─ attrName | string | 非必须 |  | 属性名 |
├─ attrValues | string | 非必须 |  | 属性值 |
├─ id | integer | 非必须 |  | attrId | format: int32
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ type | integer | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 | format: int32
attrValue | object [] | 非必须 |  | 商品属性详情 | item 类型: object
├─ attrValue | object | 非必须 |  | attrValue字段，前端传递后用作sku字段 |
├─ barCode | string | 非必须 |  | 商品条码 |
├─ brokerage | number | 非必须 |  | 一级返佣 |
├─ brokerageTwo | number | 非必须 |  | 二级返佣 |
├─ cost | number | 非必须 |  | 成本价 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | ID | format: int32
├─ image | string | 非必须 |  | 图片 |
├─ otPrice | number | 非必须 |  | 原价 |
├─ price | number | 非必须 |  | 属性金额 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ quota | integer | 非必须 |  | 活动限购数量 | format: int32
├─ quotaShow | integer | 非必须 |  | 活动限购数量显示 | format: int32
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ stock | integer | 非必须 |  | 属性对应的库存 | format: int32
├─ suk | string | 非必须 |  | 商品属性索引值 (attr_value|attr_value[|....]) |
├─ type | boolean | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 |
├─ unique | string | 非必须 |  | 唯一值 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ volume | number | 非必须 |  | 体积 |
├─ weight | number | 非必须 |  | 重量 |
barCode | string | 非必须 |  | 商品条码（一维码） |
browse | integer | 非必须 |  | 浏览量 | format: int32
cateId | string | 非必须 |  | 分类id |
cateIds | integer [] | 非必须 |  | 商品分类 | item 类型: integer
├─ |  | 非必须 |  |  |
codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
content | string | 非必须 |  | 商品描述 |
cost | number | 非必须 |  | 成本价 |
couponIds | integer [] | 非必须 |  | 优惠券id集合 | item 类型: integer
├─ |  | 非必须 |  |  |
ficti | integer | 非必须 |  | 虚拟销量 | format: int32
giveIntegral | number | 非必须 |  | 获得积分 |
id | integer | 非必须 |  | 商品id | format: int32
image | string | 非必须 |  | 商品图片 |
isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
isBenefit | boolean | 非必须 |  | 是否优惠 |
isBest | boolean | 非必须 |  | 是否精品 |
isDel | boolean | 非必须 |  | 是否删除 |
isGood | boolean | 非必须 |  | 是否优品推荐 |
isHot | boolean | 非必须 |  | 是否热卖 |
isNew | boolean | 非必须 |  | 是否新品 |
isPostage | boolean | 非必须 |  | 是否包邮 |
isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
isSub | boolean | 非必须 |  | 是否单独分佣 |
keyword | string | 非必须 |  | 关键字 |
merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
otPrice | number | 非必须 |  | 市场价 |
postage | number | 非必须 |  | 邮费 |
price | number | 非必须 |  | 商品价格 |
sales | integer | 非必须 |  | 销量 | format: int32
sliderImage | string | 非必须 |  | 轮播图 |
sort | integer | 非必须 |  | 排序 | format: int32
soureLink | string | 非必须 |  | 淘宝京东1688类型 |
specType | boolean | 非必须 |  | 规格 0单 1多 |
stock | integer | 非必须 |  | 库存 | format: int32
storeInfo | string | 非必须 |  | 商品简介 |
storeName | string | 非必须 |  | 商品名称 |
tempId | integer | 非必须 |  | 运费模板ID | format: int32
unitName | string | 非必须 |  | 单位名 |
videoLink | string | 非必须 |  | 主图视频链接 |
vipPrice | number | 非必须 |  | 会员价格 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 虚拟销量

### 基本信息

Path： /api/admin/store/product/ficti/{id}/{num}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id
num |  | 数值

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store/product/info/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 商品表 |
├─ activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
├─ addTime | integer | 非必须 |  | 添加时间 | format: int32
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ browse | integer | 非必须 |  | 浏览量 | format: int32
├─ cateId | string | 非必须 |  | 分类id |
├─ codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
├─ cost | number | 非必须 |  | 成本价 |
├─ ficti | integer | 非必须 |  | 虚拟销量 | format: int32
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
├─ isBenefit | boolean | 非必须 |  | 是否优惠 |
├─ isBest | boolean | 非必须 |  | 是否精品 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isGood | boolean | 非必须 |  | 是否优品推荐 |
├─ isHot | boolean | 非必须 |  | 是否热卖 |
├─ isNew | boolean | 非必须 |  | 是否新品 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
├─ isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ soureLink | string | 非必须 |  | 淘宝京东1688类型 |
├─ specType | boolean | 非必须 |  | 规格 0单 1多 |
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ videoLink | string | 非必须 |  | 主图视频链接 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
message | string | 非必须 |  |  |

# 商品 -- 规则值(规格)

## 修改

### 基本信息

Path： /api/admin/store/product/rule/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
id | integer | 非必须 |  | 规则id | format: int32
ruleName | string | 非必须 |  | 规格名称 |
ruleValue | string | 非必须 |  | 规格值【JSON字符串】 [{\"detail\": [\"string\"],\"title\": \"string\"}] |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store/product/rule/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ id | integer | 非必须 |  |  | format: int32
├─ ruleName | string | 非必须 |  | 规格名称 |
├─ ruleValue | string | 非必须 |  | 规格值 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store/product/rule/delete/{ids}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
ids |  | ids

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/store/product/rule/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
id | integer | 非必须 |  | 规则id | format: int32
ruleName | string | 非必须 |  | 规格名称 |
ruleValue | string | 非必须 |  | 规格值【JSON字符串】 [{\"detail\": [\"string\"],\"title\": \"string\"}] |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store/product/rule/info/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 商品规则值(规格)表 |
├─ id | integer | 非必须 |  |  | format: int32
├─ ruleName | string | 非必须 |  | 规格名称 |
├─ ruleValue | string | 非必须 |  | 规格值 |
message | string | 非必须 |  |  |

# 商品 -- 评论

## 修改

### 基本信息

Path： /api/admin/store/product/reply/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
avatar | string | 非必须 |  | 用户头像 |
comment | string | 非必须 |  | 评论内容 |
createTime | string | 非必须 |  | 评论时间 | format: date-time
id | integer | 非必须 |  | 评论ID | format: int32
isDel | boolean | 非必须 |  | 0未删除1已删除 |
isReply | boolean | 非必须 |  | 0未回复1已回复 |
merchantReplyContent | string | 非必须 |  | 管理员回复内容 |
merchantReplyTime | integer | 非必须 |  | 管理员回复时间 | format: int32
nickname | string | 非必须 |  | 用户名称 |
oid | integer | 非必须 |  | 订单ID | format: int32
pics | string | 非必须 |  | 评论图片 |
productId | integer | 非必须 |  | 商品id | format: int32
productScore | integer | 非必须 |  | 商品分数 | format: int32
replyType | string | 非必须 |  | 某种商品类型(普通商品、秒杀商品） |
serviceScore | integer | 非必须 |  | 服务分数 | format: int32
uid | integer | 非必须 |  | 用户ID | format: int32
unique | string | 非必须 |  | 商品 属性id |
updateTime | string | 非必须 |  | 更新时间 | format: date-time

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store/product/reply/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
dateLimit | 否 |  | 时间区间
isDel | 否 |  | 0未删除1已删除
isReply | 否 |  | 0未回复1已回复
limit | 否 |  | 每页数量
nickname | 否 |  | 用户名称(支持模糊搜索)
oid | 否 |  | 订单ID
page | 否 |  | 页码
productId | 否 |  | 商品id, 多个逗号分割
star | 否 |  | 星数
type | 否 |  | 类型
uid | 否 |  | 用户ID， 多个逗号分割

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ avatar | string | 非必须 |  | 用户头像 |
├─ comment | string | 非必须 |  | 评论内容 |
├─ createTime | string | 非必须 |  | 评论时间 | format: date-time
├─ id | integer | 非必须 |  | 评论ID | format: int32
├─ isDel | boolean | 非必须 |  | 0未删除1已删除 |
├─ isReply | boolean | 非必须 |  | 0未回复1已回复 |
├─ merchantReplyContent | string | 非必须 |  | 管理员回复内容 |
├─ merchantReplyTime | integer | 非必须 |  | 管理员回复时间 | format: int32
├─ nickname | string | 非必须 |  | 用户名称 |
├─ oid | integer | 非必须 |  | 订单ID | format: int32
├─ pics | string [] | 非必须 |  | 评论图片 | item 类型: string
├─ |  | 非必须 |  |  |
├─ productId | integer | 非必须 |  | 商品id | format: int32
├─ productScore | integer | 非必须 |  | 商品分数 | format: int32
├─ replyType | string | 非必须 |  | 某种商品类型(普通商品、秒杀商品） |
├─ serviceScore | integer | 非必须 |  | 服务分数 | format: int32
├─ storeProduct | object | 非必须 |  | 商品表 |
├─ activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
├─ addTime | integer | 非必须 |  | 添加时间 | format: int32
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ browse | integer | 非必须 |  | 浏览量 | format: int32
├─ cateId | string | 非必须 |  | 分类id |
├─ codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
├─ cost | number | 非必须 |  | 成本价 |
├─ ficti | integer | 非必须 |  | 虚拟销量 | format: int32
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
├─ isBenefit | boolean | 非必须 |  | 是否优惠 |
├─ isBest | boolean | 非必须 |  | 是否精品 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isGood | boolean | 非必须 |  | 是否优品推荐 |
├─ isHot | boolean | 非必须 |  | 是否热卖 |
├─ isNew | boolean | 非必须 |  | 是否新品 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
├─ isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ soureLink | string | 非必须 |  | 淘宝京东1688类型 |
├─ specType | boolean | 非必须 |  | 规格 0单 1多 |
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ videoLink | string | 非必须 |  | 主图视频链接 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
├─ uid | integer | 非必须 |  | 用户ID | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store/product/reply/delete/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 回复

### 基本信息

Path： /api/admin/store/product/reply/comment

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
ids | string | 必须 |  | 管理员回复内容 |
merchantReplyContent | string | 必须 |  | 管理员回复内容 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/store/product/reply/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
comment | string | 必须 |  | 评论内容 |
oid | integer | 非必须 |  | 订单ID， 移动端必须传递此参数 | format: int32
pics | string | 必须 |  | 评论图片 |
productId | integer | 必须 |  | 商品id | format: int32
productScore | integer | 必须 |  | 商品分数 | format: int32
serviceScore | integer | 必须 |  | 服务分数 | format: int32
unique | string | 非必须 |  | 商品 属性id |
userId | integer | 非必须 |  | 用户id， 后端必须传递此参数 | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store/product/reply/info/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 评论表 |
├─ avatar | string | 非必须 |  | 用户头像 |
├─ comment | string | 非必须 |  | 评论内容 |
├─ createTime | string | 非必须 |  | 评论时间 | format: date-time
├─ id | integer | 非必须 |  | 评论ID | format: int32
├─ isDel | boolean | 非必须 |  | 0未删除1已删除 |
├─ isReply | boolean | 非必须 |  | 0未回复1已回复 |
├─ merchantReplyContent | string | 非必须 |  | 管理员回复内容 |
├─ merchantReplyTime | integer | 非必须 |  | 管理员回复时间 | format: int32
├─ nickname | string | 非必须 |  | 用户名称 |
├─ oid | integer | 非必须 |  | 订单ID | format: int32
├─ pics | string | 非必须 |  | 评论图片 |
├─ productId | integer | 非必须 |  | 商品id | format: int32
├─ productScore | integer | 非必须 |  | 商品分数 | format: int32
├─ replyType | string | 非必须 |  | 某种商品类型(普通商品、秒杀商品） |
├─ serviceScore | integer | 非必须 |  | 服务分数 | format: int32
├─ uid | integer | 非必须 |  | 用户ID | format: int32
├─ unique | string | 非必须 |  | 商品 属性id |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 城市管理

## 修改

### 基本信息

Path： /api/admin/system/city/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
name | 否 |  | 名称
parentId | 是 |  | 父级id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改状态

### 基本信息

Path： /api/admin/system/city/update/status

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/city/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
parentId | 是 |  | 父级id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取tree结构的列表

### 基本信息

Path： /api/admin/system/city/list/tree

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/city/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 城市表 |
├─ areaCode | string | 非必须 |  | 区号 |
├─ cityId | integer | 非必须 |  | 城市id | format: int32
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  |  | format: int32
├─ isShow | boolean | 非必须 |  | 是否展示 |
├─ lat | string | 非必须 |  | 纬度 |
├─ level | integer | 非必须 |  | 省市级别 | format: int32
├─ lng | string | 非必须 |  | 经度 |
├─ mergerName | string | 非必须 |  | 合并名称 |
├─ name | string | 非必须 |  | 名称 |
├─ parentId | integer | 非必须 |  | 父级id | format: int32
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

# 客服用户对话记录表

## 分页列表

### 基本信息

Path： /api/admin/store-service-log/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
toUid | 否 |  | 接收人uid
uid | 否 |  | 发送人uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 添加时间 | format: date-time
├─ id | integer | 非必须 |  | 客服用户对话记录表ID | format: int32
├─ msn | string | 非必须 |  | 消息内容 |
├─ msnType | boolean | 非必须 |  | 消息类型 1=文字 2=表情 3=图片 4=语音 |
├─ remind | boolean | 非必须 |  | 是否提醒过 |
├─ toUid | integer | 非必须 |  | 接收人uid | format: int32
├─ type | boolean | 非必须 |  | 是否已读（0：否；1：是；） |
├─ uid | integer | 非必须 |  | 发送人uid | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

# 客服表

## 修改

### 基本信息

Path： /api/admin/store-service/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
avatar | string | 非必须 |  | 客服头像 |
createTime | string | 非必须 |  | 添加时间 | format: date-time
customer | boolean | 非必须 |  | 是否展示统计管理 |
id | integer | 非必须 |  | 客服id | format: int32
nickname | string | 非必须 |  | 代理名称 |
notify | integer | 非必须 |  | 订单通知1开启0关闭 | format: int32
status | boolean | 非必须 |  | 0隐藏1显示 |
uid | integer | 非必须 |  | 客服uid | format: int32
updateTime | string | 非必须 |  | 更新时间 | format: date-time

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store-service/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ avatar | string | 非必须 |  | 客服头像 |
├─ createTime | string | 非必须 |  | 添加时间 | format: date-time
├─ customer | boolean | 非必须 |  | 是否展示统计管理 |
├─ id | integer | 非必须 |  | 客服id | format: int32
├─ nickname | string | 非必须 |  | 代理名称 |
├─ notify | integer | 非必须 |  | 订单通知1开启0关闭 | format: int32
├─ status | boolean | 非必须 |  | 0隐藏1显示 |
├─ uid | integer | 非必须 |  | 客服uid | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store-service/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/store-service/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
avatar | string | 非必须 |  | 客服头像 |
createTime | string | 非必须 |  | 添加时间 | format: date-time
customer | boolean | 非必须 |  | 是否展示统计管理 |
id | integer | 非必须 |  | 客服id | format: int32
nickname | string | 非必须 |  | 代理名称 |
notify | integer | 非必须 |  | 订单通知1开启0关闭 | format: int32
status | boolean | 非必须 |  | 0隐藏1显示 |
uid | integer | 非必须 |  | 客服uid | format: int32
updateTime | string | 非必须 |  | 更新时间 | format: date-time

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store-service/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 客服表 |
├─ avatar | string | 非必须 |  | 客服头像 |
├─ createTime | string | 非必须 |  | 添加时间 | format: date-time
├─ customer | boolean | 非必须 |  | 是否展示统计管理 |
├─ id | integer | 非必须 |  | 客服id | format: int32
├─ nickname | string | 非必须 |  | 代理名称 |
├─ notify | integer | 非必须 |  | 订单通知1开启0关闭 | format: int32
├─ status | boolean | 非必须 |  | 0隐藏1显示 |
├─ uid | integer | 非必须 |  | 客服uid | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 导出 -- Excel

## 产品

### 基本信息

Path： /api/admin/export/excel/product

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
cateId | 否 |  | 分类ID， 多个逗号分隔
isBenefit | 否 |  | 是否优惠
isBest | 否 |  | 是否精品
isGood | 否 |  | 是否推荐
isHot | 否 |  | 是否热卖
isNew | 否 |  | 是否新品
isShow | 否 |  | 状态（0：未上架，1：上架）
keywords | 否 |  | 关键字搜索， 支持(商品名称, 商品简介, 关键字, 商品条码)
type | 否 |  | 类型（1：出售中（已上架），2：仓库中（未上架），3：已售罄，4：警戒库存，5：回收站）

### 返回数据

    OK

# 微信 -- 消息模版

## 修改

### 基本信息

Path： /api/admin/wechat/template/update/status/{id}

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改

### 基本信息

Path： /api/admin/wechat/template/update/{id}

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
content | string | 非必须 |  | 回复内容 |
name | string | 非必须 |  | 模板名 |
tempId | string | 非必须 |  | 模板ID |
tempKey | string | 非必须 |  | 模板编号 |
type | boolean | 非必须 |  | 0=订阅消息,1=微信模板消息 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/template/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
name | 否 |  | 模板名
page | 否 |  | 页码
status | 否 |  | 状态, 0 正常，1 禁用
tempId | 否 |  | 模板ID
tempKey | 否 |  | 模板编号
type | 否 |  | 类型， 0 订阅消息, 1 模板消息

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ content | string | 非必须 |  | 回复内容 |
├─ createTime | string | 非必须 |  | 添加时间 | format: date-time
├─ id | integer | 非必须 |  | 模板id | format: int32
├─ name | string | 非必须 |  | 模板名 |
├─ status | integer | 非必须 |  | 状态 | format: int32
├─ tempId | string | 非必须 |  | 模板ID |
├─ tempKey | string | 非必须 |  | 模板编号 |
├─ type | boolean | 非必须 |  | 0=订阅消息,1=微信模板消息 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/template/delete/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/template/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
content | string | 非必须 |  | 回复内容 |
name | string | 非必须 |  | 模板名 |
tempId | string | 非必须 |  | 模板ID |
tempKey | string | 非必须 |  | 模板编号 |
type | boolean | 非必须 |  | 0=订阅消息,1=微信模板消息 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 行业信息

### 基本信息

Path： /api/admin/wechat/template/industry

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 微信模板所属行业 |
├─ primaryIndustry | object | 非必须 |  | 微信模板所属行业详情 |
├─ firstClass | string | 非必须 |  | 主行业 |
├─ secondClass | string | 非必须 |  | 副行业 |
├─ secondaryIndustry | object | 非必须 |  | 微信模板所属行业详情 |
├─ firstClass | string | 非必须 |  | 主行业 |
├─ secondClass | string | 非必须 |  | 副行业 |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/template/info/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 微信模板 |
├─ content | string | 非必须 |  | 回复内容 |
├─ createTime | string | 非必须 |  | 添加时间 | format: date-time
├─ id | integer | 非必须 |  | 模板id | format: int32
├─ name | string | 非必须 |  | 模板名 |
├─ status | integer | 非必须 |  | 状态 | format: int32
├─ tempId | string | 非必须 |  | 模板ID |
├─ tempKey | string | 非必须 |  | 模板编号 |
├─ type | boolean | 非必须 |  | 0=订阅消息,1=微信模板消息 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 微信开放平台 -- 小程序access_token

## 修改

### 基本信息

Path： /api/admin/wechat/routine/access/token/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
accessToken | 否 |  | openid
id | 是 |  | id
stopTime | 否 |  | 添加时间

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/routine/access/token/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
accessToken | 否 |  | openid
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ accessToken | string | 非必须 |  | openid |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 小程序access_token表ID | format: int32
├─ stopTime | integer | 非必须 |  | 添加时间 | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/routine/access/token/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/routine/access/token/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
accessToken | 否 |  | openid
stopTime | 否 |  | 添加时间

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/routine/access/token/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 小程序access_token表 |
├─ accessToken | string | 非必须 |  | openid |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 小程序access_token表ID | format: int32
├─ stopTime | integer | 非必须 |  | 添加时间 | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 微信开放平台 -- 小程序二维码管理

## 修改

### 基本信息

Path： /api/admin/wechat/routine/qrcode/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
page | 否 |  | 小程序页面路径带参数
qrcodeUrl | 否 |  | 小程序二维码路径
status | 否 |  | 状态 0不可用 1可用
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型 spread(用户推广) product_spread(商品推广)

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/routine/qrcode/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 添加时间
id | 否 |  | 微信二维码ID
limit | 否 |  | 每页数量
page | 否 |  | 小程序页面路径带参数
page | 否 |  | 页码
qrcodeUrl | 否 |  | 小程序二维码路径
status | 否 |  | 状态 0不可用 1可用
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型 spread(用户推广) product_spread(商品推广)

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ addTime | string | 非必须 |  | 添加时间 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 微信二维码ID | format: int32
├─ page | string | 非必须 |  | 小程序页面路径带参数 |
├─ qrcodeUrl | string | 非必须 |  | 小程序二维码路径 |
├─ status | boolean | 非必须 |  | 状态 0不可用 1可用 |
├─ thirdId | integer | 非必须 |  | 用户id | format: int32
├─ thirdType | string | 非必须 |  | 二维码类型 spread(用户推广) product_spread(商品推广) |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/routine/qrcode/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/routine/qrcode/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
page | 否 |  | 小程序页面路径带参数
qrcodeUrl | 否 |  | 小程序二维码路径
status | 否 |  | 状态 0不可用 1可用
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型 spread(用户推广) product_spread(商品推广)

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/routine/qrcode/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 小程序二维码管理表 |
├─ addTime | string | 非必须 |  | 添加时间 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 微信二维码ID | format: int32
├─ page | string | 非必须 |  | 小程序页面路径带参数 |
├─ qrcodeUrl | string | 非必须 |  | 小程序二维码路径 |
├─ status | boolean | 非必须 |  | 状态 0不可用 1可用 |
├─ thirdId | integer | 非必须 |  | 用户id | format: int32
├─ thirdType | string | 非必须 |  | 二维码类型 spread(用户推广) product_spread(商品推广) |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 微信开放平台 -- 微信二维码管理

## 修改

### 基本信息

Path： /api/admin/wechat/qrcode/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 添加时间
expireSeconds | 否 |  | 二维码有效时间
id | 是 |  | id
qrcodeUrl | 否 |  | 微信二维码url
scan | 否 |  | 被扫的次数
status | 否 |  | 状态
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型
ticket | 否 |  | 二维码参数
url | 否 |  | 微信访问url

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/qrcode/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 添加时间
expireSeconds | 否 |  | 二维码有效时间
limit | 否 |  | 每页数量
page | 否 |  | 页码
qrcodeUrl | 否 |  | 微信二维码url
scan | 否 |  | 被扫的次数
status | 否 |  | 状态
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型
ticket | 否 |  | 二维码参数
url | 否 |  | 微信访问url

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ expireSeconds | integer | 非必须 |  | 二维码有效时间 | format: int32
├─ id | integer | 非必须 |  | 微信二维码ID | format: int32
├─ qrcodeUrl | string | 非必须 |  | 微信二维码url |
├─ scan | integer | 非必须 |  | 被扫的次数 | format: int32
├─ status | boolean | 非必须 |  | 状态 |
├─ thirdId | integer | 非必须 |  | 用户id | format: int32
├─ thirdType | string | 非必须 |  | 二维码类型 |
├─ ticket | string | 非必须 |  | 二维码参数 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ url | string | 非必须 |  | 微信访问url |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/qrcode/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/qrcode/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 添加时间
expireSeconds | 否 |  | 二维码有效时间
qrcodeUrl | 否 |  | 微信二维码url
scan | 否 |  | 被扫的次数
status | 否 |  | 状态
thirdId | 否 |  | 用户id
thirdType | 否 |  | 二维码类型
ticket | 否 |  | 二维码参数
url | 否 |  | 微信访问url

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/qrcode/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 微信二维码管理表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ expireSeconds | integer | 非必须 |  | 二维码有效时间 | format: int32
├─ id | integer | 非必须 |  | 微信二维码ID | format: int32
├─ qrcodeUrl | string | 非必须 |  | 微信二维码url |
├─ scan | integer | 非必须 |  | 被扫的次数 | format: int32
├─ status | boolean | 非必须 |  | 状态 |
├─ thirdId | integer | 非必须 |  | 用户id | format: int32
├─ thirdType | string | 非必须 |  | 二维码类型 |
├─ ticket | string | 非必须 |  | 二维码参数 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ url | string | 非必须 |  | 微信访问url |
message | string | 非必须 |  |  |

# 微信开放平台 -- 微信关键字回复

## 修改

### 基本信息

Path： /api/admin/wechat/keywords/reply/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
data | string | 非必须 |  | 回复数据 |
keywords | string | 非必须 |  | 关键字 |
status | boolean | 非必须 |  | 回复状态 0=不可用 1 =可用 |
type | string | 非必须 |  | 回复类型 text=文本 image =图片 news =图文 voice =音频 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/keywords/reply/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 否 |  | 关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
type | 否 |  | 回复类型 text=文本 image =图片 news =图文 voice =音频

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ data | string | 非必须 |  | 回复数据 |
├─ id | integer | 非必须 |  | 微信关键字回复id | format: int32
├─ keywords | string | 非必须 |  | 关键字 |
├─ status | boolean | 非必须 |  | 0=不可用 1 =可用 |
├─ type | string | 非必须 |  | 回复类型 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/keywords/reply/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/keywords/reply/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
data | string | 非必须 |  | 回复数据 |
keywords | string | 非必须 |  | 关键字 |
status | boolean | 非必须 |  | 回复状态 0=不可用 1 =可用 |
type | string | 非必须 |  | 回复类型 text=文本 image =图片 news =图文 voice =音频 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 根据关键字查询数据

### 基本信息

Path： /api/admin/wechat/keywords/reply/info/keywords

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 是 |  | keywords

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 微信关键字回复表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ data | string | 非必须 |  | 回复数据 |
├─ id | integer | 非必须 |  | 微信关键字回复id | format: int32
├─ keywords | string | 非必须 |  | 关键字 |
├─ status | boolean | 非必须 |  | 0=不可用 1 =可用 |
├─ type | string | 非必须 |  | 回复类型 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

## 状态

### 基本信息

Path： /api/admin/wechat/keywords/reply/status

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/keywords/reply/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 微信关键字回复表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ data | string | 非必须 |  | 回复数据 |
├─ id | integer | 非必须 |  | 微信关键字回复id | format: int32
├─ keywords | string | 非必须 |  | 关键字 |
├─ status | boolean | 非必须 |  | 0=不可用 1 =可用 |
├─ type | string | 非必须 |  | 回复类型 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

# 微信开放平台 -- 微信用户

## 消息推送

### 基本信息

Path： /api/admin/wechat/user/push

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
newsId | 是 |  | newsId
userId | 是 |  | userId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

# 微信开放平台 -- 微信用户标签

## 修改

### 基本信息

Path： /api/admin/wechat/user/tags/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 标签ID
name | 否 |  | 标签名称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 列表

### 基本信息

Path： /api/admin/wechat/user/tags/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isAsync | 否 |  | 是否同步微信数据, true是，false否

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 创建

### 基本信息

Path： /api/admin/wechat/user/tags/create

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
name | 否 |  | 标签名称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/user/tags/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 标签ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 批量为用户取消标签

### 基本信息

Path： /api/admin/wechat/user/tags/memberBatchUnTags

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 标签ID
openIdList | 否 |  | 用户openId数组

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 批量为用户打标签

### 基本信息

Path： /api/admin/wechat/user/tags/memberBatchTags

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 标签ID
openIdList | 否 |  | 用户openId数组

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取标签下粉丝列表

### 基本信息

Path： /api/admin/wechat/user/tags/getUserListById

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 标签ID
nextOpenId | 否 |  | 第一个拉取的OPENID，不填默认从头开始拉取

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取用户身上的标签列表

### 基本信息

Path： /api/admin/wechat/user/tags/getTagsListByUserId

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isAsync | 否 |  | 是否同步微信数据, true是，false否
openId | 否 |  | 用户openId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 微信开放平台 -- 用户行为记录

## 修改

### 基本信息

Path： /api/admin/wechat/user/log/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
id | 是 |  | id
openid | 否 |  | 用户openid
result | 否 |  | 操作详细记录
type | 否 |  | 操作类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/user/log/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
limit | 否 |  | 每页数量
openid | 否 |  | 用户openid
page | 否 |  | 页码
result | 否 |  | 操作详细记录
type | 否 |  | 操作类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 用户行为记录id | format: int32
├─ openid | string | 非必须 |  | 用户openid |
├─ result | string | 非必须 |  | 操作详细记录 |
├─ type | string | 非必须 |  | 操作类型 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/user/log/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/user/log/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
openid | 否 |  | 用户openid
result | 否 |  | 操作详细记录
type | 否 |  | 操作类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/user/log/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 用户行为记录表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 用户行为记录id | format: int32
├─ openid | string | 非必须 |  | 用户openid |
├─ result | string | 非必须 |  | 操作详细记录 |
├─ type | string | 非必须 |  | 操作类型 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

# 微信开放平台 -- 素材

## 上传

### 基本信息

Path： /api/admin/wechat/media/upload

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | multipart/form-data | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
type | 是 |  | 媒体文件类型，分别有图片（image）、语音（voice

Body

参数名称 | 参数类型 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
media | file | 是 |  | 待上传素材图片文件

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 根据素材id查询素材

### 基本信息

Path： /api/admin/wechat/media/get

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
mediaId | 是 |  | mediaId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 微信开放平台 -- 菜单管理

## 保存个性化菜单

### 基本信息

Path： /api/admin/wechat/menu/public/self/create

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 保存自定义菜单

### 基本信息

Path： /api/admin/wechat/menu/public/create

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 删除个性化菜单

### 基本信息

Path： /api/admin/wechat/menu/public/self/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
menuId | 否 |  | 菜单ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 删除自定义菜单

### 基本信息

Path： /api/admin/wechat/menu/public/delete

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取个性化菜单

### 基本信息

Path： /api/admin/wechat/menu/public/self/get

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isAsync | 否 |  | 是否同步微信数据, true是，false否

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取自定义菜单

### 基本信息

Path： /api/admin/wechat/menu/public/get

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isAsync | 否 |  | 是否同步微信数据, true是，false否

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 微信开放平台 -- 表单id表记录

## 修改

### 基本信息

Path： /api/admin/wechat/routine/form/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 否 |  | 表单ID
id | 是 |  | id
status | 否 |  | 状态1 未使用 2不能使用
stopTime | 否 |  | 表单ID失效时间
uid | 否 |  | 用户uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/wechat/routine/form/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 否 |  | 表单ID
limit | 否 |  | 每页数量
page | 否 |  | 页码
status | 否 |  | 状态1 未使用 2不能使用
stopTime | 否 |  | 表单ID失效时间
uid | 否 |  | 用户uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ formId | string | 非必须 |  | 表单ID |
├─ id | integer | 非必须 |  | 表单ID表ID | format: int32
├─ status | boolean | 非必须 |  | 状态1 未使用 2不能使用 |
├─ stopTime | integer | 非必须 |  | 表单ID失效时间 | format: int32
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/wechat/routine/form/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/wechat/routine/form/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 否 |  | 表单ID
status | 否 |  | 状态1 未使用 2不能使用
stopTime | 否 |  | 表单ID失效时间
uid | 否 |  | 用户uid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/wechat/routine/form/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 表单id表记录表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ formId | string | 非必须 |  | 表单ID |
├─ id | integer | 非必须 |  | 表单ID表ID | format: int32
├─ status | boolean | 非必须 |  | 状态1 未使用 2不能使用 |
├─ stopTime | integer | 非必须 |  | 表单ID失效时间 | format: int32
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 支付回调

## 微信支付回调

### 基本信息

Path： /api/admin/payment/callback/wechat

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |

### 返回数据

    OK

## 支付宝支付回调

### 基本信息

Path： /api/admin/payment/callback/alipay

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |

### 返回数据

    OK

# 文章管理

## 修改

### 基本信息

Path： /api/admin/article/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 文章ID

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
author | string | 必须 |  | 文章作者 |
cid | string | 必须 |  | 分类id |
content | string | 必须 |  | 文章内容 |
imageInput | string | 必须 |  | 文章图片 |
isBanner | boolean | 非必须 |  | 是否轮播图(小程序) |
isHot | boolean | 非必须 |  | 是否热门(小程序) |
shareSynopsis | string | 必须 |  | 文章分享简介 |
shareTitle | string | 必须 |  | 文章分享标题 |
sort | integer | 必须 |  | 排序 | format: int32
synopsis | string | 必须 |  | 文章简介 |
title | string | 必须 |  | 文章标题 |
url | string | 非必须 |  | 原文链接 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/article/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
cid | 是 |  | 分类id
hide | 否 |  | 是否隐藏
isBanner | 否 |  | 是否轮播图(小程序)
isHaveMediaId | 否 |  | 是否有微信素材媒体id
isHot | 否 |  | 是否热门(小程序)
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
status | 否 |  | 状态

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ adminId | integer | 非必须 |  | 管理员id | format: int32
├─ author | string | 非必须 |  | 文章作者 |
├─ categoryName | string | 非必须 |  | 分类 |
├─ cid | string | 非必须 |  | 分类id |
├─ content | string | 非必须 |  | 文章内容 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ hide | boolean | 非必须 |  | 是否隐藏 |
├─ id | integer | 非必须 |  | 文章管理ID | format: int32
├─ imageInput | string [] | 非必须 |  | 文章图片 前端用 | item 类型: string
├─ |  | 非必须 |  |  |
├─ imageInputs | string | 非必须 |  | 文章图片 后端用 |
├─ isBanner | boolean | 非必须 |  | 是否轮播图(小程序) |
├─ isHot | boolean | 非必须 |  | 是否热门(小程序) |
├─ mediaId | string | 非必须 |  | 微信素材媒体id |
├─ merId | integer | 非必须 |  | 商户id | format: int32
├─ productId | integer | 非必须 |  | 商品关联id | format: int32
├─ shareSynopsis | string | 非必须 |  | 文章分享简介 |
├─ shareTitle | string | 非必须 |  | 文章分享标题 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态 |
├─ synopsis | string | 非必须 |  | 文章简介 |
├─ title | string | 非必须 |  | 文章标题 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ url | string | 非必须 |  | 原文链接 |
├─ visit | string | 非必须 |  | 浏览次数 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/article/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 文章ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/article/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
author | string | 必须 |  | 文章作者 |
cid | string | 必须 |  | 分类id |
content | string | 必须 |  | 文章内容 |
imageInput | string | 必须 |  | 文章图片 |
isBanner | boolean | 非必须 |  | 是否轮播图(小程序) |
isHot | boolean | 非必须 |  | 是否热门(小程序) |
shareSynopsis | string | 必须 |  | 文章分享简介 |
shareTitle | string | 必须 |  | 文章分享标题 |
sort | integer | 必须 |  | 排序 | format: int32
synopsis | string | 必须 |  | 文章简介 |
title | string | 必须 |  | 文章标题 |
url | string | 非必须 |  | 原文链接 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 绑定产品

### 基本信息

Path： /api/admin/article/bind/product

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 文章ID
productId | 否 |  | 产品id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/article/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 文章ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 文章管理表 |
├─ adminId | integer | 非必须 |  | 管理员id | format: int32
├─ author | string | 非必须 |  | 文章作者 |
├─ cid | string | 非必须 |  | 分类id |
├─ content | string | 非必须 |  | 文章内容 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ hide | boolean | 非必须 |  | 是否隐藏 |
├─ id | integer | 非必须 |  | 文章管理ID | format: int32
├─ imageInput | string | 非必须 |  | 文章图片 |
├─ isBanner | boolean | 非必须 |  | 是否轮播图(小程序) |
├─ isHot | boolean | 非必须 |  | 是否热门(小程序) |
├─ mediaId | string | 非必须 |  | 微信素材id |
├─ merId | integer | 非必须 |  | 商户id | format: int32
├─ productId | integer | 非必须 |  | 商品关联id | format: int32
├─ shareSynopsis | string | 非必须 |  | 文章分享简介 |
├─ shareTitle | string | 非必须 |  | 文章分享标题 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态 |
├─ synopsis | string | 非必须 |  | 文章简介 |
├─ title | string | 非必须 |  | 文章标题 |
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ url | string | 非必须 |  | 原文链接 |
├─ visit | string | 非必须 |  | 浏览次数 |
message | string | 非必须 |  |  |

# 短信服务

## 发送短信

### 基本信息

Path： /api/admin/sms/sendCode

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
phone | 是 |  | 手机号码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## sendCodeForRegister

### 基本信息

Path： /api/admin/sms/sendCodeForRegister/{phone}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
phone |  | phone

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 信息登录

### 基本信息

Path： /api/admin/sms/login

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 是 |  | 账号
token | 是 |  | smsToken

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 是否已经登录

### 基本信息

Path： /api/admin/sms/islogin

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 注销

### 基本信息

Path： /api/admin/sms/logout

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 申请模板消息

### 基本信息

Path： /api/admin/sms/temp/apply

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
content | 否 |  | 内容
title | 否 |  | 主题
type | 否 |  | type (1=验证码 2=通知 3=推广)

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 短信发送记录列表

### 基本信息

Path： /api/admin/sms/record/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
phone | 否 |  | 接受短信的手机号
recordId | 否 |  | 发送记录id
resultCode | 否 |  | 状态码 null=全部,100=成功,130=失败,131=空号,132=停机,133=关机,134=无状态, 134=无状态, 400黑名单
uid | 否 |  | 短信平台账号

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ addIp | string | 非必须 |  | 添加记录ip |
├─ content | string | 非必须 |  | 短信内容 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 短信发送记录编号 | format: int32
├─ memo | string | 非必须 |  | 备注 |
├─ phone | string | 非必须 |  | 接受短信的手机号 |
├─ recordId | integer | 非必须 |  | 发送记录id | format: int32
├─ resultcode | integer | 非必须 |  | 状态码 100=成功,130=失败,131=空号,132=停机,133=关机,134=无状态 | format: int32
├─ template | string | 非必须 |  | 短信模板ID |
├─ uid | string | 非必须 |  | 短信平台账号 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 短信提醒开关保存

### 基本信息

Path： /api/admin/sms/config/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
adminConfirmTakeOverSwitch | 是 |  | 用户发起退款管理员短信提醒
adminLowerOrderSwitch | 是 |  | 用户下单管理员短信提醒
adminPaySuccessSwitch | 是 |  | 支付成功管理员短信提醒
adminRefundSwitch | 是 |  | 用户确认收货管理员短信提醒
confirmTakeOverSwitch | 是 |  | 确认收货短信提醒
deliverGoodsSwitch | 是 |  | 发货短信提醒
lowerOrderSwitch | 是 |  | 支付成功短信提醒
priceRevisionSwitch | 是 |  | 改价短信提醒

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 短信提醒开关列表

### 基本信息

Path： /api/admin/sms/config/list

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 短信模板列表

### 基本信息

Path： /api/admin/sms/temp/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
status | 否 |  | 状态
title | 否 |  | 名称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 短信用户信息

### 基本信息

Path： /api/admin/sms/info

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取支付套餐列表

### 基本信息

Path： /api/admin/sms/pay/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取支付码

### 基本信息

Path： /api/admin/sms/pay/qrCode

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
mealId | 否 |  | 套餐id
payType | 否 |  | 支付类型 weixin：微信支付/alipay：支付宝支付
price | 否 |  | 价格

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 账号注册

### 基本信息

Path： /api/admin/sms/register

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 是 |  | 账号
code | 否 |  | 验证码
domain | 是 |  | 域名
password | 是 |  | 密码
phone | 是 |  | 手机号
sign | 是 |  | 签名

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 统计 -- 主页

## 30天订单量趋势

### 基本信息

Path： /api/admin/statistics/home/chart/order

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 周订单量趋势

### 基本信息

Path： /api/admin/statistics/home/chart/order/week

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 年订单量趋势

### 基本信息

Path： /api/admin/statistics/home/chart/order/year

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增用户

### 基本信息

Path： /api/admin/statistics/home/user

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 主页用户新增统计 |
├─ count | object | 非必须 |  | 昨日新增量 |
├─ dayRate | object | 非必须 |  | 日同比率 |
├─ total | object | 非必须 |  | 总数 |
├─ weekRate | object | 非必须 |  | 周同比率 |
message | string | 非必须 |  |  |

## 月订单量趋势

### 基本信息

Path： /api/admin/statistics/home/chart/order/month

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 用户曲线图

### 基本信息

Path： /api/admin/statistics/home/chart/user

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 用户访问量

### 基本信息

Path： /api/admin/statistics/home/views

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 主页用户新增统计 |
├─ count | object | 非必须 |  | 昨日新增量 |
├─ dayRate | object | 非必须 |  | 日同比率 |
├─ total | object | 非必须 |  | 总数 |
├─ weekRate | object | 非必须 |  | 周同比率 |
message | string | 非必须 |  |  |

## 用户购买统计

### 基本信息

Path： /api/admin/statistics/home/chart/user/buy

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 订单量

### 基本信息

Path： /api/admin/statistics/home/order

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 主页用户新增统计 |
├─ count | object | 非必须 |  | 昨日新增量 |
├─ dayRate | object | 非必须 |  | 日同比率 |
├─ total | object | 非必须 |  | 总数 |
├─ weekRate | object | 非必须 |  | 周同比率 |
message | string | 非必须 |  |  |

## 销售额

### 基本信息

Path： /api/admin/statistics/home/sales

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 主页用户新增统计 |
├─ count | object | 非必须 |  | 昨日新增量 |
├─ dayRate | object | 非必须 |  | 日同比率 |
├─ total | object | 非必须 |  | 总数 |
├─ weekRate | object | 非必须 |  | 周同比率 |
message | string | 非必须 |  |  |

# 营销 -- 优惠券

## 修改

### 基本信息

Path： /api/admin/marketing/coupon/update/status

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/marketing/coupon/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isDel | 否 |  | 是否删除 状态（0：否，1：是）
limit | 否 |  | 每页数量
name | 否 |  | 优惠券名称
page | 否 |  | 页码
primaryKey | 否 |  | 所属商品id / 分类id
status | 否 |  | 状态（0：关闭，1：开启）
type | 否 |  | 优惠券类型 1 手动领取, 2 新人券, 3 赠送券
useType | 否 |  | 使用类型 1 全场通用, 2 商品券, 3 品类券

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ day | integer | 非必须 |  | 天数 | format: int32
├─ id | integer | 非必须 |  | 优惠券表ID | format: int32
├─ isDel | boolean | 非必须 |  | 是否删除 状态（0：否，1：是） |
├─ isFixedTime | boolean | 非必须 |  | 是否固定使用时间, 默认0 否， 1是 |
├─ isLimited | boolean | 非必须 |  | 是否限量, 默认0 不限量， 1限量 |
├─ lastTotal | integer | 非必须 |  | 剩余数量 | format: int32
├─ minPrice | number | 非必须 |  | 最低消费，0代表不限制 |
├─ money | number | 非必须 |  | 兑换的优惠券面值 |
├─ name | string | 非必须 |  | 优惠券名称 |
├─ primaryKey | string | 必须 |  | 主键id 商品id/分类id |
├─ receiveEndTime | string | 非必须 |  | 可领取结束时间 | format: date-time
├─ receiveStartTime | string | 非必须 |  | 可领取开始时间 | format: date-time
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（0：关闭，1：开启） |
├─ total | integer | 非必须 |  | 发放总数 | format: int32
├─ type | integer | 非必须 |  | 优惠券类型 1 手动领取, 2 新人券, 3 赠送券 | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ useEndTime | string | 非必须 |  | 可使用时间范围 结束时间 | format: date-time
├─ useStartTime | string | 非必须 |  | 可使用时间范围 开始时间 | format: date-time
├─ useType | integer | 非必须 |  | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/marketing/coupon/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
day | integer | 非必须 |  | 天数 | format: int32
isFixedTime | boolean | 必须 |  | 请设置是否固定使用时间, 默认0 否， 1是 |
isForever | boolean | 必须 |  | 是否固定领取时间， 默认0 否， 1是 |
isLimited | boolean | 必须 |  | 是否限量, 默认0 否， 1是 |
minPrice | number | 必须 |  | 最低消费，0代表不限制 |
money | number | 必须 |  | 兑换的优惠券面值 |
name | string | 必须 |  | 优惠券名称 |
primaryKey | string | 必须 |  | 主键id 商品id/分类id |
receiveEndTime | string | 非必须 |  | 可领取结束时间 | format: date-time
receiveStartTime | string | 非必须 |  | 可领取开始时间 | format: date-time
sort | integer | 非必须 |  | 排序 | format: int32
status | boolean | 非必须 |  | 状态（0：关闭，1：开启） |
total | integer | 非必须 |  | 发放总数 | format: int32
type | integer | 非必须 |  | 优惠券类型 1 手动领取, 2 新人券, 3 赠送券 | format: int32
useEndTime | string | 非必须 |  | 可使用时间范围 结束时间 | format: date-time
useStartTime | string | 非必须 |  | 可使用时间范围 开始时间 | format: date-time
useType | integer | 非必须 |  | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/marketing/coupon/info

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 优惠券详情 |
├─ category | object [] | 非必须 |  | 分类信息 | item 类型: object
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型ID | 类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
├─ coupon | object | 非必须 |  | 优惠券表 |
├─ day | integer | 非必须 |  | 天数 | format: int32
├─ isFixedTime | boolean | 必须 |  | 请设置是否固定使用时间, 默认0 否， 1是 |
├─ isForever | boolean | 必须 |  | 是否固定领取时间， 默认0 否， 1是 |
├─ isLimited | boolean | 必须 |  | 是否限量, 默认0 否， 1是 |
├─ minPrice | number | 必须 |  | 最低消费，0代表不限制 |
├─ money | number | 必须 |  | 兑换的优惠券面值 |
├─ name | string | 必须 |  | 优惠券名称 |
├─ primaryKey | string | 必须 |  | 主键id 商品id/分类id |
├─ receiveEndTime | string | 非必须 |  | 可领取结束时间 | format: date-time
├─ receiveStartTime | string | 非必须 |  | 可领取开始时间 | format: date-time
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（0：关闭，1：开启） |
├─ total | integer | 非必须 |  | 发放总数 | format: int32
├─ type | integer | 非必须 |  | 优惠券类型 1 手动领取, 2 新人券, 3 赠送券 | format: int32
├─ useEndTime | string | 非必须 |  | 可使用时间范围 结束时间 | format: date-time
├─ useStartTime | string | 非必须 |  | 可使用时间范围 开始时间 | format: date-time
├─ useType | integer | 非必须 |  | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32
├─ product | object [] | 非必须 |  | 商品信息 | item 类型: object
├─ activity | string | 非必须 |  | 活动显示排序1=秒杀，2=砍价，3=拼团 |
├─ addTime | integer | 非必须 |  | 添加时间 | format: int32
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ browse | integer | 非必须 |  | 浏览量 | format: int32
├─ cateId | string | 非必须 |  | 分类id |
├─ codePath | string | 非必须 |  | 商品二维码地址(用户小程序海报) |
├─ cost | number | 非必须 |  | 成本价 |
├─ ficti | integer | 非必须 |  | 虚拟销量 | format: int32
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isBargain | boolean | 非必须 |  | 砍价状态 0未开启 1开启 |
├─ isBenefit | boolean | 非必须 |  | 是否优惠 |
├─ isBest | boolean | 非必须 |  | 是否精品 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isGood | boolean | 非必须 |  | 是否优品推荐 |
├─ isHot | boolean | 非必须 |  | 是否热卖 |
├─ isNew | boolean | 非必须 |  | 是否新品 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSeckill | boolean | 非必须 |  | 秒杀状态 0 未开启 1已开启 |
├─ isShow | boolean | 非必须 |  | 状态（0：未上架，1：上架） |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ merUse | boolean | 非必须 |  | 商户是否代理 0不可代理1可代理 |
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ soureLink | string | 非必须 |  | 淘宝京东1688类型 |
├─ specType | boolean | 非必须 |  | 规格 0单 1多 |
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ videoLink | string | 非必须 |  | 主图视频链接 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
message | string | 非必须 |  |  |

# 营销 -- 优惠券 -- 领取记录

## 分页列表

### 基本信息

Path： /api/admin/marketing/coupon/user/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
couponId | 否 |  | 优惠券id
limit | 否 |  | 每页数量
minPrice | 否 |  | 最低消费多少金额可用优惠券
name | 否 |  | 优惠券名称
page | 否 |  | 页码
status | 否 |  | 状态（0：未使用，1：已使用, 2:已过期）
uid | 否 |  | 优惠券所属用户

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ avatar | string | 非必须 |  | 用户头像 |
├─ cid | integer | 非必须 |  | 兑换的项目id | format: int32
├─ couponId | integer | 非必须 |  | 优惠券发布id | format: int32
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ endTime | string | 非必须 |  | 过期时间 | format: date-time
├─ id | integer | 非必须 |  | id | format: int32
├─ isValid | boolean | 非必须 |  | 用户头像 |
├─ minPrice | number | 非必须 |  | 最低消费多少金额可用优惠券 |
├─ money | number | 非必须 |  | 优惠券的面值 |
├─ name | string | 非必须 |  | 优惠券名称 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ primaryKey | string | 必须 |  | 主键id 商品id/分类id |
├─ startTime | string | 非必须 |  | 开始使用时间 | format: date-time
├─ status | integer | 非必须 |  | 状态（0：未使用，1：已使用, 2:已失效） | format: int32
├─ type | string | 非必须 |  | 获取方式 |
├─ uid | integer | 非必须 |  | 领取人id | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ useTime | string | 非必须 |  | 使用时间 | format: date-time
├─ useType | integer | 非必须 |  | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 领券

### 基本信息

Path： /api/admin/marketing/coupon/user/receive

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
couponId | 否 |  | 优惠券发布id
uid | 否 |  | 领取人id, 多个id逗号分割

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

# 订单

## 修改订单

### 基本信息

Path： /api/admin/store/order/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
gainIntegral | number | 非必须 |  | 消费赚取积分 |
payPostage | number | 非必须 |  | 支付邮费 |
payPrice | number | 非必须 |  | 实际支付金额 |
totalPostage | number | 非必须 |  | 邮费 |
totalPrice | number | 非必须 |  | 订单总价 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store/order/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isDel | 否 |  | 是否删除
limit | 否 |  | 每页数量
orderId | 否 |  | 订单号
page | 否 |  | 页码
status | 否 |  | 订单状态（all 总数； 未支付 unPaid； 未发货 notShipped；待收货 spike；待评价 bargain；已完成 complete；待核销 toBeWrittenOff；退款中:refunding；已退款:refunded；已删除:deleted
timeRage | 否 |  | 创建时间区间
uid | 否 |  | 用户id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 订单数量 |
├─ list | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ backIntegral | number | 非必须 |  | 给用户退了多少积分 |
├─ clerkName | string | 非必须 |  | 店员名称 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ gainIntegral | number | 非必须 |  | 消费赚取积分 |
├─ id | integer | 非必须 |  | 订单ID | format: int32
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isSystemDel | boolean | 非必须 |  | 后台是否删除 |
├─ mark | string | 非必须 |  | 用户备注 |
├─ orderId | string | 非必须 |  | 订单号 |
├─ paid | boolean | 非必须 |  | 支付状态 |
├─ payPostage | number | 非必须 |  | 支付邮费 |
├─ payPrice | number | 非必须 |  | 实际支付金额 |
├─ payTime | string | 非必须 |  | 支付时间 | format: date-time
├─ payType | string | 非必须 |  | 支付方式 |
├─ payTypeStr | string | 非必须 |  | 支付方式 |
├─ productList | object [] | 非必须 |  | 商品信息 | item 类型: object
├─ info | object | 非必须 |  | 购物车ListResponse |
├─ addTime | string | 非必须 |  |  |
├─ attrStatus | boolean | 非必须 |  | 商品是否有效 |
├─ bargainId | integer | 非必须 |  | 砍价id | format: int32
├─ brokerage | number | 非必须 |  | 一级分佣 |
├─ brokerageTwo | number | 非必须 |  | 二级分佣 |
├─ cartNum | integer | 非必须 |  | 商品数量 | format: int32
├─ combinationId | integer | 非必须 |  | 拼团id | format: int32
├─ costPrice | number | 非必须 |  |  |
├─ id | integer | 非必须 |  | 购物车表ID | format: int64
├─ isNew | boolean | 非必须 |  | 是否为立即购买 |
├─ isReply | integer | 非必须 |  |  | format: int32
├─ productAttrUnique | string | 非必须 |  | 商品属性 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ productInfo | object | 非必须 |  | 商品信息，购物车列表使用 |
├─ attrInfo | object | 非必须 |  | 商品属性值表 |
├─ attrValue | string | 非必须 |  | 产品属性值和属性名对应关系 |
├─ barCode | string | 非必须 |  | 商品条码 |
├─ brokerage | number | 非必须 |  | 一级返佣 |
├─ brokerageTwo | number | 非必须 |  | 二级返佣 |
├─ cost | number | 非必须 |  | 成本价 |
├─ id | integer | 非必须 |  | attrId | format: int32
├─ image | string | 非必须 |  | 图片 |
├─ otPrice | number | 非必须 |  | 原价 |
├─ price | number | 非必须 |  | 属性金额 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ quota | integer | 非必须 |  | 活动限购数量 | format: int32
├─ quotaShow | integer | 非必须 |  | 活动限购数量显示 | format: int32
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ stock | integer | 非必须 |  | 属性对应的库存 | format: int32
├─ suk | string | 非必须 |  | 商品属性索引值 (attr_value|attr_value[|....]) |
├─ type | integer | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 | format: int32
├─ unique | string | 非必须 |  | 唯一值 |
├─ volume | number | 非必须 |  | 体积 |
├─ weight | number | 非必须 |  | 重量 |
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ cateId | string | 非必须 |  | 分类id |
├─ cost | number | 非必须 |  | 成本价 |
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
├─ seckillId | integer | 非必须 |  | 秒杀商品ID | format: int32
├─ truePrice | number | 非必须 |  |  |
├─ trueStock | integer | 非必须 |  |  | format: int32
├─ type | string | 非必须 |  | 类型 |
├─ uid | integer | 非必须 |  | 用户ID | format: int32
├─ vipTruePrice | number | 非必须 |  |  |
├─ orderId | integer | 非必须 |  | 订单id | format: int32
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ unique | string | 非必须 |  | 唯一id |
├─ realName | string | 非必须 |  | 用户姓名 |
├─ refundPrice | number | 非必须 |  | 退款金额 |
├─ refundReason | string | 非必须 |  | 不退款的理由 |
├─ refundReasonTime | string | 非必须 |  | 退款时间 | format: date-time
├─ refundReasonWap | string | 非必须 |  | 前台退款原因 |
├─ refundReasonWapExplain | string | 非必须 |  | 退款用户说明 |
├─ refundReasonWapImg | string | 非必须 |  | 退款图片 |
├─ remark | string | 非必须 |  | 管理员备注 |
├─ spreadInfo | object | 非必须 |  | 推广人信息 |
├─ id | integer | 非必须 |  | 推广人id | format: int32
├─ name | string | 非必须 |  | 推广人姓名 |
├─ status | boolean | 非必须 |  | 订单状态（-1 : 申请退款 -2 : 退货成功 0：待发货；1：待收货；2：已收货；3：待评价；-1：已退款） |
├─ statusStr | object | 非必须 |  | 订单状态 |
├─ storeName | string | 非必须 |  | 门店名称 |
├─ totalPostage | number | 非必须 |  | 邮费 |
├─ totalPrice | number | 非必须 |  | 订单总价 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ useIntegral | number | 非必须 |  | 使用积分 |
├─ userPhone | string | 非必须 |  | 用户电话 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
├─ status | object | 非必须 |  | 订单状态数量 |
├─ all | integer | 非必须 |  | 总数 | format: int32
├─ bargain | integer | 非必须 |  | 待评价 | format: int32
├─ complete | integer | 非必须 |  | 交易完成 | format: int32
├─ deleted | integer | 非必须 |  | 已删除 | format: int32
├─ notShipped | integer | 非必须 |  | 未发货 | format: int32
├─ refunded | integer | 非必须 |  | 已退款 | format: int32
├─ refunding | integer | 非必须 |  | 退款中 | format: int32
├─ spike | integer | 非必须 |  | 待收货 | format: int32
├─ toBeWrittenOff | integer | 非必须 |  | 待核销 | format: int32
├─ unPaid | integer | 非必须 |  | 未支付 | format: int32
├─ top | object | 非必须 |  | 订单九宫格数据 |
├─ amount | number | 非必须 |  | 订单金额 |
├─ count | integer | 非必须 |  | 订单数量 | format: int32
├─ weChatAmount | number | 非必须 |  | 微信支付金额 |
├─ yueAmount | number | 非必须 |  | 余额支付 |
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store/order/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 发送货

### 基本信息

Path： /api/admin/store/order/send

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
expressCode | 否 |  | 快递单号
expressId | 否 |  | 快递公司
id | 否 |  | 订单ID
type | 否 |  | 类型， 1，2，3

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

## 备注

### 基本信息

Path： /api/admin/store/order/mark

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
mark | 是 |  | mark

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 快递查询

### 基本信息

Path： /api/admin/store/order/getLogisticsInfo

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 快递接口返回数据 |
├─ courier | string | 非必须 |  | 快递员 或 快递站(没有则为空 |
├─ courierPhone | string | 非必须 |  | 快递员电话 (没有则为空) |
├─ deliverystatus | string | 非必须 |  | 快递收件(揽件)1.在途中 2.正在派件 3.已签收 4.派送失败 5.疑难件 6.退件签收 */ |
├─ expName | string | 非必须 |  | 快递公司名称 |
├─ expPhone | string | 非必须 |  | 快递公司电话 |
├─ expSite | string | 非必须 |  | 快递公司官网 |
├─ issign | string | 非必须 |  | 是否签收 |
├─ list | object [] | 非必须 |  | 快递运送轨迹 | item 类型: object
├─ status | string | 非必须 |  | 日志 |
├─ time | string | 非必须 |  | 时间 |
├─ logo | string | 非必须 |  | 快递公司LOGO |
├─ number | string | 非必须 |  | 快递单号 |
├─ takeTime | string | 非必须 |  | 发货到收货消耗时长 (截止最新轨迹) |
├─ type | string | 非必须 |  | 快递简写 |
├─ updateTime | string | 非必须 |  | 快递轨迹信息最新时间 |
message | string | 非必须 |  |  |

## 拒绝退款

### 基本信息

Path： /api/admin/store/order/refund/refuse

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
reason | 是 |  | reason

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store/order/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 订单详情 |
├─ backIntegral | number | 非必须 |  | 给用户退了多少积分 |
├─ bargainId | integer | 非必须 |  | 砍价id | format: int32
├─ clerkId | integer | 非必须 |  | 店员id | format: int32
├─ combinationId | integer | 非必须 |  | 拼团商品id0一般商品 | format: int32
├─ cost | number | 非必须 |  | 成本价 |
├─ couponId | integer | 非必须 |  | 优惠券id | format: int32
├─ couponPrice | number | 非必须 |  | 优惠券金额 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ deductionPrice | number | 非必须 |  | 抵扣金额 |
├─ deliveryId | string | 非必须 |  | 快递单号/手机号 |
├─ deliveryName | string | 非必须 |  | 快递名称/送货人姓名 |
├─ deliveryType | string | 非必须 |  | 发货类型 |
├─ freightPrice | number | 非必须 |  | 运费金额 |
├─ gainIntegral | number | 非必须 |  | 消费赚取积分 |
├─ id | integer | 非必须 |  | 订单ID | format: int32
├─ isChannel | boolean | 非必须 |  | 支付渠道(0微信公众号1微信小程序) |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isMerCheck | integer | 非必须 |  |  | format: int32
├─ isRemind | boolean | 非必须 |  | 消息提醒 |
├─ isSystemDel | boolean | 非必须 |  | 后台是否删除 |
├─ mark | string | 非必须 |  | 备注 |
├─ merId | integer | 非必须 |  | 商户ID | format: int32
├─ orderId | string | 非必须 |  | 订单号 |
├─ paid | boolean | 非必须 |  | 支付状态 |
├─ payPostage | number | 非必须 |  | 支付邮费 |
├─ payPrice | number | 非必须 |  | 实际支付金额 |
├─ payTime | string | 非必须 |  | 支付时间 | format: date-time
├─ payType | string | 非必须 |  | 支付方式 |
├─ payTypeStr | string | 非必须 |  | 支付方式 |
├─ pinkId | integer | 非必须 |  | 拼团id 0没有拼团 | format: int32
├─ realName | string | 非必须 |  | 用户姓名 |
├─ refundPrice | number | 非必须 |  | 退款金额 |
├─ refundReason | string | 非必须 |  | 不退款的理由 |
├─ refundReasonTime | string | 非必须 |  | 退款时间 | format: date-time
├─ refundReasonWap | string | 非必须 |  | 前台退款原因 |
├─ refundReasonWapExplain | string | 非必须 |  | 退款用户说明 |
├─ refundReasonWapImg | string | 非必须 |  | 退款图片 |
├─ refundStatus | integer | 非必须 |  | 0 未退款 1 申请中 2 已退款 | format: int32
├─ remark | string | 非必须 |  | 管理员备注 |
├─ seckillId | integer | 非必须 |  | 秒杀商品ID | format: int32
├─ shippingType | integer | 非必须 |  | 配送方式 1=快递 ，2=门店自提 | format: int32
├─ spreadInfo | object | 非必须 |  | 推广人信息 |
├─ id | integer | 非必须 |  | 推广人id | format: int32
├─ name | string | 非必须 |  | 推广人姓名 |
├─ status | integer | 非必须 |  | 订单状态（-1 : 申请退款 -2 : 退货成功 0：待发货；1：待收货；2：已收货；3：待评价；-1：已退款） | format: int32
├─ statusStr | object | 非必须 |  | 订单状态 |
├─ storeId | integer | 非必须 |  | 门店id | format: int32
├─ totalNum | integer | 非必须 |  | 订单商品总数 | format: int32
├─ totalPostage | number | 非必须 |  | 邮费 |
├─ totalPrice | number | 非必须 |  | 订单总价 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ unique | string | 非必须 |  | 唯一id(md5加密)类似id |
├─ useIntegral | number | 非必须 |  | 使用积分 |
├─ user | object | 非必须 |  | 用户表 |
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | string | 非必须 |  | 用户分组id |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ path | string | 非必须 |  | 用户推广等级 |
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ subscribe | boolean | 非必须 |  | 是否关注公众号 |
├─ tagId | string | 非必须 |  | 用户标签id |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
├─ userAddress | string | 非必须 |  | 详细地址 |
├─ userPhone | string | 非必须 |  | 用户电话 |
├─ verifyCode | string | 非必须 |  | 核销码 |
message | string | 非必须 |  |  |

## 退款

### 基本信息

Path： /api/admin/store/order/refund

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
amount | 否 |  | 退款金额
orderId | 否 |  | 订单id
type | 否 |  | status 1 = 直接退款, 2 = 退款后,返回原状态

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

# 订单 -- 操作记录

## 修改

### 基本信息

Path： /api/admin/store/order/status/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
changeMessage | 否 |  | 操作备注
changeTime | 否 |  | 操作时间
changeType | 否 |  | 操作类型
id | 是 |  | id
oid | 否 |  | 订单id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/store/order/status/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
changeMessage | 否 |  | 操作备注
changeTime | 否 |  | 操作时间
changeType | 否 |  | 操作类型
limit | 否 |  | 每页数量
oid | 否 |  | 订单id
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ changeMessage | string | 非必须 |  | 操作备注 |
├─ changeType | string | 非必须 |  | 操作类型 |
├─ createTime | string | 非必须 |  | 操作时间 | format: date-time
├─ oid | integer | 非必须 |  | 订单id | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/store/order/status/delete

Method： DELETE

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/store/order/status/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
changeMessage | 否 |  | 操作备注
changeTime | 否 |  | 操作时间
changeType | 否 |  | 操作类型
oid | 否 |  | 订单id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/store/order/status/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 订单操作记录表 |
├─ changeMessage | string | 非必须 |  | 操作备注 |
├─ changeType | string | 非必须 |  | 操作类型 |
├─ createTime | string | 非必须 |  | 操作时间 | format: date-time
├─ oid | integer | 非必须 |  | 订单id | format: int32
message | string | 非必须 |  |  |

# 设置 -- Config

## 整体保存表单数据

### 基本信息

Path： /api/admin/system/config/save/form

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
fields | object [] | 必须 |  | 字段值列表 | item 类型: object
├─ name | string | 必须 |  | 字段名称 |
├─ title | string | 必须 |  | 字段显示文字 |
├─ value | string | 必须 |  | 字段值 |
id | integer | 必须 |  | 表单名称 | format: int32
sort | integer | 必须 |  | 排序 | format: int32
status | boolean | 非必须 |  | 状态（1：开启；0：关闭；） |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 检测表单name是否存在

### 基本信息

Path： /api/admin/system/config/check

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
name | 是 |  | name

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

## 表单配置中仅仅存储

### 基本信息

Path： /api/admin/system/config/saveuniq

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
key | 是 |  | key
value | 是 |  | value

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

## 表单配置根据key获取

### 基本信息

Path： /api/admin/system/config/getuniq

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
key | 是 |  | key

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/config/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 是 |  | formId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 设置 -- 会员等级

## 修改

### 基本信息

Path： /api/admin/system/user/level/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
discount | number | 非必须 |  | 享受折扣 |
experience | integer | 非必须 |  | 达到多少升级经验 | format: int32
grade | integer | 非必须 |  | 会员等级 | format: int32
icon | string | 非必须 |  | 会员图标 |
image | string | 非必须 |  | 会员卡背景 |
isShow | boolean | 非必须 |  | 是否显示 1=显示,0=隐藏 |
memo | string | 非必须 |  | 说明 |
name | string | 非必须 |  | 会员名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/user/level/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isDel | 否 |  | 是否删除.1=删除,0=未删除
isShow | 否 |  | 是否显示 1=显示,0=隐藏
limit | 否 |  | 每页数量
name | 否 |  | 会员名称
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ discount | number | 非必须 |  | 享受折扣 |
├─ experience | integer | 非必须 |  | 购买金额|经验达到 | format: int32
├─ grade | integer | 非必须 |  | 会员等级 | format: int32
├─ icon | string | 非必须 |  | 会员图标 |
├─ id | integer | 非必须 |  |  | format: int32
├─ image | string | 非必须 |  | 会员卡背景 |
├─ isDel | boolean | 非必须 |  | 是否删除.1=删除,0=未删除 |
├─ isShow | boolean | 非必须 |  | 是否显示 1=显示,0=隐藏 |
├─ memo | string | 非必须 |  | 说明 |
├─ name | string | 非必须 |  | 会员名称 |
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/user/level/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/user/level/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
discount | number | 非必须 |  | 享受折扣 |
experience | integer | 非必须 |  | 达到多少升级经验 | format: int32
grade | integer | 非必须 |  | 会员等级 | format: int32
icon | string | 非必须 |  | 会员图标 |
image | string | 非必须 |  | 会员卡背景 |
isShow | boolean | 非必须 |  | 是否显示 1=显示,0=隐藏 |
memo | string | 非必须 |  | 说明 |
name | string | 非必须 |  | 会员名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 是否使用

### 基本信息

Path： /api/admin/system/user/level/use

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
value | 是 |  | 是否使用, 1=是，0=否

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/user/level/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 设置用户等级表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ discount | number | 非必须 |  | 享受折扣 |
├─ experience | integer | 非必须 |  | 购买金额|经验达到 | format: int32
├─ grade | integer | 非必须 |  | 会员等级 | format: int32
├─ icon | string | 非必须 |  | 会员图标 |
├─ id | integer | 非必须 |  |  | format: int32
├─ image | string | 非必须 |  | 会员卡背景 |
├─ isDel | boolean | 非必须 |  | 是否删除.1=删除,0=未删除 |
├─ isShow | boolean | 非必须 |  | 是否显示 1=显示,0=隐藏 |
├─ memo | string | 非必须 |  | 说明 |
├─ name | string | 非必须 |  | 会员名称 |
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
message | string | 非必须 |  |  |

# 设置 -- 会员等级 -- 等级任务

## 修改

### 基本信息

Path： /api/admin/system/user/task/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 新增时间
id | 是 |  | id
id | 否 |  |
illustrate | 否 |  | 任务说明
isMust | 否 |  | 是否务必达成任务,1务必达成,0=满足其一
isShow | 否 |  | 是否显示
levelId | 否 |  | 等级id
name | 否 |  | 任务名称
number | 否 |  | 限定数
realName | 否 |  | 配置原名
sort | 否 |  | 排序
taskType | 否 |  | 任务类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/user/task/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 新增时间
id | 否 |  |
illustrate | 否 |  | 任务说明
isMust | 否 |  | 是否务必达成任务,1务必达成,0=满足其一
isShow | 否 |  | 是否显示
levelId | 否 |  | 等级id
limit | 否 |  | 每页数量
name | 否 |  | 任务名称
number | 否 |  | 限定数
page | 否 |  | 页码
realName | 否 |  | 配置原名
sort | 否 |  | 排序
taskType | 否 |  | 任务类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ addTime | integer | 非必须 |  | 新增时间 | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ illustrate | string | 非必须 |  | 任务说明 |
├─ isMust | boolean | 非必须 |  | 是否务必达成任务,1务必达成,0=满足其一 |
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ levelId | integer | 非必须 |  | 等级id | format: int32
├─ name | string | 非必须 |  | 任务名称 |
├─ number | integer | 非必须 |  | 限定数 | format: int32
├─ realName | string | 非必须 |  | 配置原名 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ taskType | string | 非必须 |  | 任务类型 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/user/task/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/user/task/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 新增时间
id | 否 |  |
illustrate | 否 |  | 任务说明
isMust | 否 |  | 是否务必达成任务,1务必达成,0=满足其一
isShow | 否 |  | 是否显示
levelId | 否 |  | 等级id
name | 否 |  | 任务名称
number | 否 |  | 限定数
realName | 否 |  | 配置原名
sort | 否 |  | 排序
taskType | 否 |  | 任务类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/user/task/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 等级任务设置 |
├─ addTime | integer | 非必须 |  | 新增时间 | format: int32
├─ id | integer | 非必须 |  |  | format: int32
├─ illustrate | string | 非必须 |  | 任务说明 |
├─ isMust | boolean | 非必须 |  | 是否务必达成任务,1务必达成,0=满足其一 |
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ levelId | integer | 非必须 |  | 等级id | format: int32
├─ name | string | 非必须 |  | 任务名称 |
├─ number | integer | 非必须 |  | 限定数 | format: int32
├─ realName | string | 非必须 |  | 配置原名 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ taskType | string | 非必须 |  | 任务类型 |
message | string | 非必须 |  |  |

# 设置 -- 提货点 -- 提货点

## 修改

### 基本信息

Path： /api/admin/system/store/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
address | string | 非必须 |  | 提货点地址省市区 |
dayTime | string | 非必须 |  | 每日营业开关时间 |
detailedAddress | string | 非必须 |  | 详细地址 |
image | string | 非必须 |  | 门店logo |
introduction | string | 非必须 |  | 简介 |
latitude | string | 非必须 |  | 纬度 |
longitude | string | 非必须 |  | 经度 |
name | string | 非必须 |  | 门店名称 |
phone | string | 非必须 |  | 手机号码 |
validTime | string | 非必须 |  | 核销有效日期 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改门店显示状态

### 基本信息

Path： /api/admin/system/store/update/status

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/store/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 否 |  | 搜索关键字，支持 门店名称
limit | 否 |  | 每页数量
page | 否 |  | 页码
status | 否 |  | 状态，0隐藏，1显示，2回收站

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ address | string | 非必须 |  | 省市区 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ dayTime | string | 非必须 |  | 每日营业开关时间 |
├─ detailedAddress | string | 非必须 |  | 详细地址 |
├─ id | integer | 非必须 |  |  | format: int32
├─ image | string | 非必须 |  | 门店logo |
├─ introduction | string | 非必须 |  | 简介 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ latitude | string | 非必须 |  | 纬度 |
├─ longitude | string | 非必须 |  | 经度 |
├─ name | string | 非必须 |  | 门店名称 |
├─ phone | string | 非必须 |  | 手机号码 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ validTime | string | 非必须 |  | 核销有效日期 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/store/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 数量

### 基本信息

Path： /api/admin/system/store/getCount

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/store/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
address | string | 非必须 |  | 提货点地址省市区 |
dayTime | string | 非必须 |  | 每日营业开关时间 |
detailedAddress | string | 非必须 |  | 详细地址 |
image | string | 非必须 |  | 门店logo |
introduction | string | 非必须 |  | 简介 |
latitude | string | 非必须 |  | 纬度 |
longitude | string | 非必须 |  | 经度 |
name | string | 非必须 |  | 门店名称 |
phone | string | 非必须 |  | 手机号码 |
validTime | string | 非必须 |  | 核销有效日期 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/store/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 门店自提 |
├─ address | string | 非必须 |  | 省市区 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ dayTime | string | 非必须 |  | 每日营业开关时间 |
├─ detailedAddress | string | 非必须 |  | 详细地址 |
├─ id | integer | 非必须 |  |  | format: int32
├─ image | string | 非必须 |  | 门店logo |
├─ introduction | string | 非必须 |  | 简介 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ latitude | string | 非必须 |  | 纬度 |
├─ longitude | string | 非必须 |  | 经度 |
├─ name | string | 非必须 |  | 门店名称 |
├─ phone | string | 非必须 |  | 手机号码 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ validTime | string | 非必须 |  | 核销有效日期 |
message | string | 非必须 |  |  |

# 设置 -- 提货点 -- 核销员

## 修改

### 基本信息

Path： /api/admin/system/store/staff/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
avatar | string | 非必须 |  | 店员头像 |
createTime | string | 非必须 |  | 创建时间 | format: date-time
id | integer | 非必须 |  |  | format: int32
phone | string | 非必须 |  | 手机号码 |
staffName | string | 非必须 |  | 店员名称 |
status | integer | 非必须 |  | 状态 | format: int32
storeId | integer | 非必须 |  | 门店id | format: int32
uid | integer | 非必须 |  | 微信用户id | format: int32
updateTime | string | 非必须 |  | 更新时间 | format: date-time
verifyStatus | integer | 非必须 |  | 核销开关 | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改状态

### 基本信息

Path： /api/admin/system/store/staff/update/status

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
status | 是 |  | status

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/store/staff/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
storeId | 否 |  | storeId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ avatar | string | 非必须 |  | 店员头像 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  |  | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ staffName | string | 非必须 |  | 店员名称 |
├─ status | integer | 非必须 |  | 状态 | format: int32
├─ storeId | integer | 非必须 |  | 门店id | format: int32
├─ systemStore | object | 非必须 |  | 门店自提 |
├─ address | string | 非必须 |  | 省市区 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ dayTime | string | 非必须 |  | 每日营业开关时间 |
├─ detailedAddress | string | 非必须 |  | 详细地址 |
├─ id | integer | 非必须 |  |  | format: int32
├─ image | string | 非必须 |  | 门店logo |
├─ introduction | string | 非必须 |  | 简介 |
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ latitude | string | 非必须 |  | 纬度 |
├─ longitude | string | 非必须 |  | 经度 |
├─ name | string | 非必须 |  | 门店名称 |
├─ phone | string | 非必须 |  | 手机号码 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ validTime | string | 非必须 |  | 核销有效日期 |
├─ uid | integer | 非必须 |  | 微信用户id | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ user | object | 非必须 |  | 用户表 |
├─ account | string | 非必须 |  | 用户账号 |
├─ addIp | string | 非必须 |  | 添加ip |
├─ addres | string | 非必须 |  | 详细地址 |
├─ adminid | integer | 非必须 |  | 管理员编号 | format: int32
├─ avatar | string | 非必须 |  | 用户头像 |
├─ birthday | string | 非必须 |  | 生日 |
├─ brokeragePrice | number | 非必须 |  | 佣金金额 |
├─ cardId | string | 非必须 |  | 身份证号码 |
├─ cleanTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ experience | integer | 非必须 |  | 用户剩余经验 | format: int32
├─ groupId | string | 非必须 |  | 用户分组id |
├─ integral | number | 非必须 |  | 用户剩余积分 |
├─ isPromoter | boolean | 非必须 |  | 是否为推广员 |
├─ lastIp | string | 非必须 |  | 最后一次登录ip |
├─ lastLoginTime | string | 非必须 |  | 最后一次登录时间 | format: date-time
├─ level | integer | 非必须 |  | 等级 | format: int32
├─ loginType | string | 非必须 |  | 用户登陆类型，h5,wechat,routine |
├─ mark | string | 非必须 |  | 用户备注 |
├─ nickname | string | 非必须 |  | 用户昵称 |
├─ nowMoney | number | 非必须 |  | 用户余额 |
├─ partnerId | integer | 非必须 |  | 合伙人id | format: int32
├─ path | string | 非必须 |  | 用户推广等级 |
├─ payCount | integer | 非必须 |  | 用户购买次数 | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ realName | string | 非必须 |  | 真实姓名 |
├─ signNum | integer | 非必须 |  | 连续签到天数 | format: int32
├─ spreadCount | integer | 非必须 |  | 下级人数 | format: int32
├─ spreadTime | string | 非必须 |  | 推广员关联时间 | format: date-time
├─ spreadUid | integer | 非必须 |  | 推广人id | format: int32
├─ status | boolean | 非必须 |  | 1为正常，0为禁止 |
├─ subscribe | boolean | 非必须 |  | 是否关注公众号 |
├─ tagId | string | 非必须 |  | 用户标签id |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ userType | string | 非必须 |  | 用户类型 |
├─ verifyStatus | integer | 非必须 |  | 核销开关 | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/store/staff/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/store/staff/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
avatar | string | 非必须 |  | 店员头像 |
createTime | string | 非必须 |  | 创建时间 | format: date-time
id | integer | 非必须 |  |  | format: int32
phone | string | 非必须 |  | 手机号码 |
staffName | string | 非必须 |  | 店员名称 |
status | integer | 非必须 |  | 状态 | format: int32
storeId | integer | 非必须 |  | 门店id | format: int32
uid | integer | 非必须 |  | 微信用户id | format: int32
updateTime | string | 非必须 |  | 更新时间 | format: date-time
verifyStatus | integer | 非必须 |  | 核销开关 | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/store/staff/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 门店店员表 |
├─ avatar | string | 非必须 |  | 店员头像 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  |  | format: int32
├─ phone | string | 非必须 |  | 手机号码 |
├─ staffName | string | 非必须 |  | 店员名称 |
├─ status | integer | 非必须 |  | 状态 | format: int32
├─ storeId | integer | 非必须 |  | 门店id | format: int32
├─ uid | integer | 非必须 |  | 微信用户id | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ verifyStatus | integer | 非必须 |  | 核销开关 | format: int32
message | string | 非必须 |  |  |

# 设置 -- 提货点 -- 核销订单

## 分页列表

### 基本信息

Path： /api/admin/system/store/order/list

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
data | 否 |  | 时间
keywords | 否 |  | 关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
storeId | 否 |  | 核销点ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 核销订单 |
├─ list | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ backIntegral | number | 非必须 |  | 给用户退了多少积分 |
├─ clerkName | string | 非必须 |  | 店员名称 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ gainIntegral | number | 非必须 |  | 消费赚取积分 |
├─ id | integer | 非必须 |  | 订单ID | format: int32
├─ isDel | boolean | 非必须 |  | 是否删除 |
├─ isSystemDel | boolean | 非必须 |  | 后台是否删除 |
├─ mark | string | 非必须 |  | 用户备注 |
├─ orderId | string | 非必须 |  | 订单号 |
├─ paid | boolean | 非必须 |  | 支付状态 |
├─ payPostage | number | 非必须 |  | 支付邮费 |
├─ payPrice | number | 非必须 |  | 实际支付金额 |
├─ payTime | string | 非必须 |  | 支付时间 | format: date-time
├─ payType | string | 非必须 |  | 支付方式 |
├─ payTypeStr | string | 非必须 |  | 支付方式 |
├─ productList | object [] | 非必须 |  | 商品信息 | item 类型: object
├─ info | object | 非必须 |  | 购物车ListResponse |
├─ addTime | string | 非必须 |  |  |
├─ attrStatus | boolean | 非必须 |  | 商品是否有效 |
├─ bargainId | integer | 非必须 |  | 砍价id | format: int32
├─ brokerage | number | 非必须 |  | 一级分佣 |
├─ brokerageTwo | number | 非必须 |  | 二级分佣 |
├─ cartNum | integer | 非必须 |  | 商品数量 | format: int32
├─ combinationId | integer | 非必须 |  | 拼团id | format: int32
├─ costPrice | number | 非必须 |  |  |
├─ id | integer | 非必须 |  | 购物车表ID | format: int64
├─ isNew | boolean | 非必须 |  | 是否为立即购买 |
├─ isReply | integer | 非必须 |  |  | format: int32
├─ productAttrUnique | string | 非必须 |  | 商品属性 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ productInfo | object | 非必须 |  | 商品信息，购物车列表使用 |
├─ attrInfo | object | 非必须 |  | 商品属性值表 |
├─ attrValue | string | 非必须 |  | 产品属性值和属性名对应关系 |
├─ barCode | string | 非必须 |  | 商品条码 |
├─ brokerage | number | 非必须 |  | 一级返佣 |
├─ brokerageTwo | number | 非必须 |  | 二级返佣 |
├─ cost | number | 非必须 |  | 成本价 |
├─ id | integer | 非必须 |  | attrId | format: int32
├─ image | string | 非必须 |  | 图片 |
├─ otPrice | number | 非必须 |  | 原价 |
├─ price | number | 非必须 |  | 属性金额 |
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ quota | integer | 非必须 |  | 活动限购数量 | format: int32
├─ quotaShow | integer | 非必须 |  | 活动限购数量显示 | format: int32
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ stock | integer | 非必须 |  | 属性对应的库存 | format: int32
├─ suk | string | 非必须 |  | 商品属性索引值 (attr_value|attr_value[|....]) |
├─ type | integer | 非必须 |  | 活动类型 0=商品，1=秒杀，2=砍价，3=拼团 | format: int32
├─ unique | string | 非必须 |  | 唯一值 |
├─ volume | number | 非必须 |  | 体积 |
├─ weight | number | 非必须 |  | 重量 |
├─ barCode | string | 非必须 |  | 商品条码（一维码） |
├─ cateId | string | 非必须 |  | 分类id |
├─ cost | number | 非必须 |  | 成本价 |
├─ giveIntegral | number | 非必须 |  | 获得积分 |
├─ id | integer | 非必须 |  | 商品id | format: int32
├─ image | string | 非必须 |  | 商品图片 |
├─ isPostage | boolean | 非必须 |  | 是否包邮 |
├─ isSub | boolean | 非必须 |  | 是否单独分佣 |
├─ keyword | string | 非必须 |  | 关键字 |
├─ merId | integer | 非必须 |  | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32
├─ otPrice | number | 非必须 |  | 市场价 |
├─ postage | number | 非必须 |  | 邮费 |
├─ price | number | 非必须 |  | 商品价格 |
├─ sales | integer | 非必须 |  | 销量 | format: int32
├─ sliderImage | string | 非必须 |  | 轮播图 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ stock | integer | 非必须 |  | 库存 | format: int32
├─ storeInfo | string | 非必须 |  | 商品简介 |
├─ storeName | string | 非必须 |  | 商品名称 |
├─ tempId | integer | 非必须 |  | 运费模板ID | format: int32
├─ unitName | string | 非必须 |  | 单位名 |
├─ vipPrice | number | 非必须 |  | 会员价格 |
├─ seckillId | integer | 非必须 |  | 秒杀商品ID | format: int32
├─ truePrice | number | 非必须 |  |  |
├─ trueStock | integer | 非必须 |  |  | format: int32
├─ type | string | 非必须 |  | 类型 |
├─ uid | integer | 非必须 |  | 用户ID | format: int32
├─ vipTruePrice | number | 非必须 |  |  |
├─ orderId | integer | 非必须 |  | 订单id | format: int32
├─ productId | integer | 非必须 |  | 商品ID | format: int32
├─ unique | string | 非必须 |  | 唯一id |
├─ realName | string | 非必须 |  | 用户姓名 |
├─ refundPrice | number | 非必须 |  | 退款金额 |
├─ refundReason | string | 非必须 |  | 不退款的理由 |
├─ refundReasonTime | string | 非必须 |  | 退款时间 | format: date-time
├─ refundReasonWap | string | 非必须 |  | 前台退款原因 |
├─ refundReasonWapExplain | string | 非必须 |  | 退款用户说明 |
├─ refundReasonWapImg | string | 非必须 |  | 退款图片 |
├─ remark | string | 非必须 |  | 管理员备注 |
├─ spreadInfo | object | 非必须 |  | 推广人信息 |
├─ id | integer | 非必须 |  | 推广人id | format: int32
├─ name | string | 非必须 |  | 推广人姓名 |
├─ status | boolean | 非必须 |  | 订单状态（-1 : 申请退款 -2 : 退货成功 0：待发货；1：待收货；2：已收货；3：待评价；-1：已退款） |
├─ statusStr | object | 非必须 |  | 订单状态 |
├─ storeName | string | 非必须 |  | 门店名称 |
├─ totalPostage | number | 非必须 |  | 邮费 |
├─ totalPrice | number | 非必须 |  | 订单总价 |
├─ uid | integer | 非必须 |  | 用户id | format: int32
├─ useIntegral | number | 非必须 |  | 使用积分 |
├─ userPhone | string | 非必须 |  | 用户电话 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
├─ orderTotalPrice | number | 非必须 |  | 订单总金额 |
├─ refundTotal | integer | 非必须 |  | 退款总单数 | format: int32
├─ refundTotalPrice | number | 非必须 |  | 退款总金额 |
├─ total | integer | 非必须 |  | 订单总数量 | format: int64
message | string | 非必须 |  |  |

# 设置 -- 权限管理 -- 身份管理

## TestMenu

### 基本信息

Path： /api/admin/system/role/testMenu

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 修改

### 基本信息

Path： /api/admin/system/role/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id
level | 是 |  | 身份管理名称
roleName | 是 |  | 身份管理名称
rules | 是 |  | 身份管理权限(menus_id)
status | 是 |  | 状态

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/role/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
createTime | 否 |  | 创建时间
level | 否 |  | 身份管理名称
limit | 否 |  | 每页数量
page | 否 |  | 页码
roleName | 否 |  | 身份管理名称
rules | 否 |  | 身份管理权限(menus_id)
status | 否 |  | 状态
updateTime | 否 |  | 修改时间

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 身份管理id | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ roleName | string | 非必须 |  | 身份管理名称 |
├─ rules | string | 非必须 |  | 身份管理权限(menus_id) |
├─ status | boolean | 非必须 |  | 状态 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/role/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/role/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
level | 是 |  | 身份管理名称
roleName | 是 |  | 身份管理名称
rules | 是 |  | 身份管理权限(menus_id)
status | 是 |  | 状态

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 菜单

### 基本信息

Path： /api/admin/system/role/menu

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ child | [] | 非必须 |  |  |
├─ |  | 非必须 |  |  |
├─ extra | string | 非必须 |  | 扩展字段 |
├─ id | integer | 非必须 |  |  | format: int32
├─ name | string | 非必须 |  | 分类名称 |
├─ path | string | 非必须 |  | 路径 |
├─ pid | integer | 非必须 |  | 父级ID | format: int32
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态, 0正常，1失效 |
├─ type | integer | 非必须 |  | 类型，类型，1 产品分类，2 附件分类，3 文章分类， 4 设置分类， 5 菜单分类， 6 配置分类， 7 秒杀配置 | format: int32
├─ url | string | 非必须 |  | 地址 |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/role/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 身份管理表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 身份管理id | format: int32
├─ level | integer | 非必须 |  |  | format: int32
├─ roleName | string | 非必须 |  | 身份管理名称 |
├─ rules | string | 非必须 |  | 身份管理权限(menus_id) |
├─ status | boolean | 非必须 |  | 状态 |
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

# 设置 -- 物流 -- 付费

## 根据模板id查询数据

### 基本信息

Path： /api/admin/express/shipping/region/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
tempId | 是 |  | tempId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。全国 all |
├─ first | number | 必须 |  | 首件 |
├─ firstPrice | number | 必须 |  | 首件运费 |
├─ renewal | number | 必须 |  | 续件 |
├─ renewalPrice | number | 必须 |  | 续件运费 |
├─ title | string | 非必须 |  | 城市名称描述 |
├─ uniqid | string | 非必须 |  | 分组唯一值 |
message | string | 非必须 |  |  |

# 设置 -- 物流 -- 免费

## 根据模板id查询数据

### 基本信息

Path： /api/admin/express/shipping/free/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
tempId | 是 |  | tempId

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object [] | 非必须 |  |  | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。 全国 all |
├─ number | integer | 必须 |  | 包邮件数 | format: int32
├─ price | number | 必须 |  | 包邮金额 |
├─ title | string | 非必须 |  | 城市名称描述 |
message | string | 非必须 |  |  |

# 设置 -- 物流 -- 公司

## 修改

### 基本信息

Path： /api/admin/express/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
code | 是 |  | 快递公司简称
id | 否 |  | 快递ID
isShow | 是 |  | 是否显示
name | 是 |  | 快递公司全称
sort | 否 |  | 排序

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/express/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
isShow | 是 |  | 是否显示
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ code | string | 非必须 |  | 快递公司简称 |
├─ id | integer | 非必须 |  | 快递公司id | format: int32
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ name | string | 非必须 |  | 快递公司全称 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/express/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 快递ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/express/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
code | 是 |  | 快递公司简称
isShow | 是 |  | 是否显示
name | 是 |  | 快递公司全称
sort | 否 |  | 排序

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/express/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 否 |  | 快递ID

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 快递公司表 |
├─ code | string | 非必须 |  | 快递公司简称 |
├─ id | integer | 非必须 |  | 快递公司id | format: int32
├─ isShow | boolean | 非必须 |  | 是否显示 |
├─ name | string | 非必须 |  | 快递公司全称 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
message | string | 非必须 |  |  |

# 设置 -- 物流 -- 模板

## 修改

### 基本信息

Path： /api/admin/express/shipping/templates/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
appoint | boolean | 必须 |  | 指定包邮 |
name | string | 必须 |  | 模板名称 |
shippingTemplatesFreeRequestList | object [] | 必须 |  | 指定包邮设置 | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。 全国 all |
├─ number | integer | 必须 |  | 包邮件数 | format: int32
├─ price | number | 必须 |  | 包邮金额 |
├─ title | string | 非必须 |  | 城市名称描述 |
shippingTemplatesRegionRequestList | object [] | 必须 |  | 配送区域及运费 | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。全国 all |
├─ first | number | 必须 |  | 首件 |
├─ firstPrice | number | 必须 |  | 首件运费 |
├─ renewal | number | 必须 |  | 续件 |
├─ renewalPrice | number | 必须 |  | 续件运费 |
├─ title | string | 非必须 |  | 城市名称描述 |
├─ uniqid | string | 非必须 |  | 分组唯一值 |
sort | integer | 非必须 |  | 排序 | format: int32
type | integer | 必须 |  | 计费方式 1(按件数), 2(按重量)，3(按体积) | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/express/shipping/templates/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
name | 否 |  | 模板名称
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ appoint | boolean | 非必须 |  | 指定包邮 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 编号 | format: int32
├─ name | string | 非必须 |  | 模板名称 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ type | integer | 非必须 |  | 计费方式 | format: int32
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/express/shipping/templates/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/express/shipping/templates/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
appoint | boolean | 必须 |  | 指定包邮 |
name | string | 必须 |  | 模板名称 |
shippingTemplatesFreeRequestList | object [] | 必须 |  | 指定包邮设置 | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。 全国 all |
├─ number | integer | 必须 |  | 包邮件数 | format: int32
├─ price | number | 必须 |  | 包邮金额 |
├─ title | string | 非必须 |  | 城市名称描述 |
shippingTemplatesRegionRequestList | object [] | 必须 |  | 配送区域及运费 | item 类型: object
├─ cityId | string | 必须 |  | 城市ID, 多个逗号分割。全国 all |
├─ first | number | 必须 |  | 首件 |
├─ firstPrice | number | 必须 |  | 首件运费 |
├─ renewal | number | 必须 |  | 续件 |
├─ renewalPrice | number | 必须 |  | 续件运费 |
├─ title | string | 非必须 |  | 城市名称描述 |
├─ uniqid | string | 非必须 |  | 分组唯一值 |
sort | integer | 非必须 |  | 排序 | format: int32
type | integer | 必须 |  | 计费方式 1(按件数), 2(按重量)，3(按体积) | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/express/shipping/templates/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ appoint | boolean | 非必须 |  | 指定包邮 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 编号 | format: int32
├─ name | string | 非必须 |  | 模板名称 |
├─ sort | integer | 非必须 |  | 排序 | format: int32
├─ type | integer | 非必须 |  | 计费方式 | format: int32
├─ updateTime | string | 非必须 |  | 修改时间 | format: date-time
message | string | 非必须 |  |  |

# 设置 -- 管理员操作记录

## 修改

### 基本信息

Path： /api/admin/system/log/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
adminId | 否 |  | 管理员id
adminName | 否 |  | 管理员姓名
id | 是 |  | id
id | 否 |  | 管理员操作记录ID
ip | 否 |  | 登录IP
merchantId | 否 |  | 商户id
method | 否 |  | 访问类型
page | 否 |  | 行为
path | 否 |  | 链接
type | 否 |  | 类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/log/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
adminId | 否 |  | 管理员id
adminName | 否 |  | 管理员姓名
id | 否 |  | 管理员操作记录ID
ip | 否 |  | 登录IP
limit | 否 |  | 每页数量
merchantId | 否 |  | 商户id
method | 否 |  | 访问类型
page | 否 |  | 行为
page | 否 |  | 页码
path | 否 |  | 链接
type | 否 |  | 类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ addTime | integer | 非必须 |  | 操作时间 | format: int32
├─ adminId | integer | 非必须 |  | 管理员id | format: int32
├─ adminName | string | 非必须 |  | 管理员姓名 |
├─ id | integer | 非必须 |  | 管理员操作记录ID | format: int32
├─ ip | string | 非必须 |  | 登录IP |
├─ merchantId | integer | 非必须 |  | 商户id | format: int32
├─ method | string | 非必须 |  | 访问类型 |
├─ page | string | 非必须 |  | 行为 |
├─ path | string | 非必须 |  | 链接 |
├─ type | string | 非必须 |  | 类型 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/log/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/log/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
addTime | 否 |  | 操作时间
adminId | 否 |  | 管理员id
adminName | 否 |  | 管理员姓名
id | 否 |  | 管理员操作记录ID
ip | 否 |  | 登录IP
merchantId | 否 |  | 商户id
method | 否 |  | 访问类型
page | 否 |  | 行为
path | 否 |  | 链接
type | 否 |  | 类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/log/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 管理员操作记录表 |
├─ addTime | integer | 非必须 |  | 操作时间 | format: int32
├─ adminId | integer | 非必须 |  | 管理员id | format: int32
├─ adminName | string | 非必须 |  | 管理员姓名 |
├─ id | integer | 非必须 |  | 管理员操作记录ID | format: int32
├─ ip | string | 非必须 |  | 登录IP |
├─ merchantId | integer | 非必须 |  | 商户id | format: int32
├─ method | string | 非必须 |  | 访问类型 |
├─ page | string | 非必须 |  | 行为 |
├─ path | string | 非必须 |  | 链接 |
├─ type | string | 非必须 |  | 类型 |
message | string | 非必须 |  |  |

# 设置 -- 组合数据

## 修改

### 基本信息

Path： /api/admin/system/group/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 否 |  | form 表单 id
id | 是 |  | id
info | 否 |  | 简介
name | 否 |  | 数据组名称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/group/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 否 |  | 关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ formId | integer | 非必须 |  | form 表单 id | format: int32
├─ id | integer | 非必须 |  | 组合数据ID | format: int32
├─ info | string | 非必须 |  | 简介 |
├─ name | string | 非必须 |  | 数据组名称 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/group/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/group/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
formId | 否 |  | form 表单 id
info | 否 |  | 简介
name | 否 |  | 数据组名称

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/group/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 组合数据表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ formId | integer | 非必须 |  | form 表单 id | format: int32
├─ id | integer | 非必须 |  | 组合数据ID | format: int32
├─ info | string | 非必须 |  | 简介 |
├─ name | string | 非必须 |  | 数据组名称 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 设置 -- 组合数据 -- 详情

## 修改

### 基本信息

Path： /api/admin/system/group/data/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
form | object | 非必须 |  | 整体保存表单数据 |
├─ fields | object [] | 必须 |  | 字段值列表 | item 类型: object
├─ name | string | 必须 |  | 字段名称 |
├─ title | string | 必须 |  | 字段显示文字 |
├─ value | string | 必须 |  | 字段值 |
├─ id | integer | 必须 |  | 表单名称 | format: int32
├─ sort | integer | 必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（1：开启；0：关闭；） |
gid | integer | 非必须 |  | 对应的数据组id | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/group/data/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
gid | 否 |  | 分组id
keywords | 否 |  | 关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
status | 否 |  | 状态（1：开启；2：关闭；）

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ gid | integer | 非必须 |  | 对应的数据组id | format: int32
├─ id | integer | 非必须 |  | 组合数据详情ID | format: int32
├─ sort | integer | 非必须 |  | 数据排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（1：开启；0：关闭；） |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ value | string | 非必须 |  | 数据组对应的数据值（json数据） |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/group/data/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/group/data/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
form | object | 非必须 |  | 整体保存表单数据 |
├─ fields | object [] | 必须 |  | 字段值列表 | item 类型: object
├─ name | string | 必须 |  | 字段名称 |
├─ title | string | 必须 |  | 字段显示文字 |
├─ value | string | 必须 |  | 字段值 |
├─ id | integer | 必须 |  | 表单名称 | format: int32
├─ sort | integer | 必须 |  | 排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（1：开启；0：关闭；） |
gid | integer | 非必须 |  | 对应的数据组id | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/group/data/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 组合数据详情表 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ gid | integer | 非必须 |  | 对应的数据组id | format: int32
├─ id | integer | 非必须 |  | 组合数据详情ID | format: int32
├─ sort | integer | 非必须 |  | 数据排序 | format: int32
├─ status | boolean | 非必须 |  | 状态（1：开启；0：关闭；） |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ value | string | 非必须 |  | 数据组对应的数据值（json数据） |
message | string | 非必须 |  |  |

# 设置 -- 表单模板

## 修改

### 基本信息

Path： /api/admin/system/form/temp/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
content | string | 必须 |  | 表单内容 |
info | string | 必须 |  | 表单简介 |
name | string | 必须 |  | 表单名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/form/temp/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ content | string | 非必须 |  | 表单内容 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 表单模板id | format: int32
├─ info | string | 非必须 |  | 表单简介 |
├─ name | string | 非必须 |  | 表单名称 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/form/temp/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
content | string | 必须 |  | 表单内容 |
info | string | 必须 |  | 表单简介 |
name | string | 必须 |  | 表单名称 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/form/temp/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 表单模板 |
├─ content | string | 非必须 |  | 表单内容 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 表单模板id | format: int32
├─ info | string | 非必须 |  | 表单简介 |
├─ name | string | 非必须 |  | 表单名称 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 设置 -- 通知记录 -- 通知模板

## 修改

### 基本信息

Path： /api/admin/system/notice/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
icon | 否 |  | 图标
id | 是 |  | id
id | 否 |  | 通知模板id
pushAdmin | 否 |  | 通知管理员id
status | 否 |  | 状态
tableTitle | 否 |  | 通知数据
template | 否 |  | 通知模板
title | 否 |  | 通知标题
type | 否 |  | 通知类型
url | 否 |  | 链接

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/notice/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
icon | 否 |  | 图标
id | 否 |  | 通知模板id
limit | 否 |  | 每页数量
page | 否 |  | 页码
pushAdmin | 否 |  | 通知管理员id
status | 否 |  | 状态
tableTitle | 否 |  | 通知数据
template | 否 |  | 通知模板
title | 否 |  | 通知标题
type | 否 |  | 通知类型
url | 否 |  | 链接

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ icon | string | 非必须 |  | 图标 |
├─ id | integer | 非必须 |  | 通知模板id | format: int32
├─ pushAdmin | string | 非必须 |  | 通知管理员id |
├─ status | boolean | 非必须 |  | 状态 |
├─ tableTitle | string | 非必须 |  | 通知数据 |
├─ template | string | 非必须 |  | 通知模板 |
├─ title | string | 非必须 |  | 通知标题 |
├─ type | string | 非必须 |  | 通知类型 |
├─ url | string | 非必须 |  | 链接 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/notice/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/notice/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
icon | 否 |  | 图标
id | 否 |  | 通知模板id
pushAdmin | 否 |  | 通知管理员id
status | 否 |  | 状态
tableTitle | 否 |  | 通知数据
template | 否 |  | 通知模板
title | 否 |  | 通知标题
type | 否 |  | 通知类型
url | 否 |  | 链接

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/notice/info

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 通知模板表 |
├─ icon | string | 非必须 |  | 图标 |
├─ id | integer | 非必须 |  | 通知模板id | format: int32
├─ pushAdmin | string | 非必须 |  | 通知管理员id |
├─ status | boolean | 非必须 |  | 状态 |
├─ tableTitle | string | 非必须 |  | 通知数据 |
├─ template | string | 非必须 |  | 通知模板 |
├─ title | string | 非必须 |  | 通知标题 |
├─ type | string | 非必须 |  | 通知类型 |
├─ url | string | 非必须 |  | 链接 |
message | string | 非必须 |  |  |

# 财务 -- 充值

## 分页列表

### 基本信息

Path： /api/admin/user/topUpLog/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
endTime | 否 |  | 结束时间
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
paid | 否 |  | 是否充值
startTime | 否 |  | 添加时间
status | 否 |  | -1 未通过 0 审核中 1 已提现

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ createTime | string | 非必须 |  | 充值时间 | format: date-time
├─ givePrice | number | 非必须 |  | 购买赠送金额 |
├─ id | integer | 非必须 |  |  | format: int32
├─ orderId | string | 非必须 |  | 订单号 |
├─ paid | boolean | 非必须 |  | 是否充值 |
├─ payTime | string | 非必须 |  | 充值支付时间 | format: date-time
├─ price | number | 非必须 |  | 充值金额 |
├─ rechargeType | string | 非必须 |  | 充值类型 |
├─ refundPrice | number | 非必须 |  | 退款金额 |
├─ uid | integer | 非必须 |  | 充值用户UID | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/user/topUpLog/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 提现总金额

### 基本信息

Path： /api/admin/user/topUpLog/balance

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 财务 -- 提现申请

## 修改

### 基本信息

Path： /api/admin/finance/apply/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
alipayCode | 否 |  | 支付宝账号
bankCode | 否 |  | 银行卡
bankname | 否 |  | 提现银行名称
extractPrice | 否 |  | 提现金额
extractType | 否 |  | 提现方式
id | 是 |  | id
realName | 否 |  | 姓名
wechat | 否 |  | 微信号

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/finance/apply/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
endTime | 否 |  | 结束时间
extractType | 否 |  | bank = 银行卡 alipay = 支付宝wx=微信
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
page | 否 |  | 页码
startTime | 否 |  | 添加时间
status | 否 |  | -1 未通过 0 审核中 1 已提现

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ alipayCode | string | 非必须 |  | 支付宝账号 |
├─ balance | number | 非必须 |  | 金额 |
├─ bankAddress | string | 非必须 |  | 开户地址 |
├─ bankCode | string | 非必须 |  | 银行卡 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ extractPrice | number | 非必须 |  | 提现金额 |
├─ extractType | string | 非必须 |  | bank = 银行卡 alipay = 支付宝wx=微信 |
├─ failMsg | string | 非必须 |  | 无效原因 |
├─ failTime | string | 非必须 |  | 失败时间 | format: date-time
├─ id | integer | 非必须 |  |  | format: int32
├─ mark | string | 非必须 |  | 备注 |
├─ realName | string | 非必须 |  | 名称 |
├─ status | integer | 非必须 |  | -1 未通过 0 审核中 1 已提现 | format: int32
├─ uid | integer | 非必须 |  |  | format: int32
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ wechat | string | 非必须 |  | 微信号 |
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 提现总金额

### 基本信息

Path： /api/admin/finance/apply/balance

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 提现金额 |
├─ commissionTotal | number | 非必须 |  | 佣金总金额 |
├─ toBeWithdrawn | number | 非必须 |  |  |
├─ unDrawn | number | 非必须 |  | 未提现 |
├─ withdrawn | number | 非必须 |  | 已提现 |
message | string | 非必须 |  |  |

# 财务 -- 资金监控

## 佣金记录

### 基本信息

Path： /api/admin/finance/founds/monitor/list/user

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
endTime | 否 |  |
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
max | 否 |  | 最大佣金
min | 否 |  | 最小佣金
page | 否 |  | 页码
sort | 否 |  | 排序 asc/desc
type | 否 |  | 类型

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ brokerage | number | 非必须 |  | 账户佣金 |
├─ nickname | string | 非必须 |  | 昵称 |
├─ nowMoney | number | 非必须 |  | 账户余额 |
├─ totalBrokerage | number | 非必须 |  | 账户总佣金 |
├─ totalExtract | number | 非必须 |  | 提现总金额 |
├─ uid | integer | 非必须 |  | 充值用户UID | format: int32
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 资金监控

### 基本信息

Path： /api/admin/finance/founds/monitor/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
category | 否 |  | 类型
dateLimit | 否 |  | 添加时间
keywords | 否 |  | 搜索关键字
limit | 否 |  | 每页数量
linkId | 否 |  | 关联id
max | 否 |  | 最大佣金
min | 否 |  | 最小佣金
page | 否 |  | 页码
pm | 否 |  | 操作类型
sort | 否 |  | 排序 asc/desc
type | 否 |  | 类型
uid | 否 |  | 用户id list
userIdList | 否 |  | 用户id list

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ add_time | string | 非必须 |  | 创建时间 | format: date-time
├─ balance | number | 非必须 |  | 剩余 |
├─ category | string | 非必须 |  | 明细种类 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ id | integer | 非必须 |  | 用户账单id | format: int32
├─ linkId | string | 非必须 |  | 关联id |
├─ mark | string | 非必须 |  | 备注 |
├─ nickName | string | 非必须 |  | 用户呢成 |
├─ number | number | 非必须 |  | 明细数字 |
├─ pm | integer | 非必须 |  | 0 = 支出 1 = 获得 | format: int32
├─ status | integer | 非必须 |  | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32
├─ title | string | 非必须 |  | 账单标题 |
├─ type | string | 非必须 |  | 明细类型 |
├─ uid | integer | 非必须 |  | 用户uid | format: int32
├─ updateTime | string | 非必须 |  | 创建时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

# 附件管理

## 修改

### 基本信息

Path： /api/admin/system/attachment/update

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
id | 是 |  | id

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
attDir | string | 非必须 |  | 附件路径 |
attId | integer | 非必须 |  |  | format: int32
attSize | string | 非必须 |  | 附件大小 |
attType | string | 非必须 |  | 附件类型 |
createTime | string | 非必须 |  | 创建时间 | format: date-time
imageType | integer | 非必须 |  | 图片上传类型 1本地 2七牛云 3OSS 4COS | format: int32
model | string | 非必须 |  | 模块，store |
moduleType | integer | 非必须 |  | 图片上传模块类型 1 后台上传 2 用户生成 | format: int32
name | string | 非必须 |  | 附件名称 |
rootDir | string | 非必须 |  | 服务器上存储的绝对地址 |
sattDir | string | 非必须 |  | 压缩图片路径 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 分页列表

### 基本信息

Path： /api/admin/system/attachment/list

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
limit | 否 |  | 每页数量
page | 否 |  | 页码
pid | 是 |  | pid

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
├─ limit | integer | 非必须 |  |  | format: int32
├─ list | object [] | 非必须 |  |  | item 类型: object
├─ attDir | string | 非必须 |  | 附件路径 |
├─ attId | integer | 非必须 |  |  | format: int32
├─ attSize | string | 非必须 |  | 附件大小 |
├─ attType | string | 非必须 |  | 附件类型 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ imageType | integer | 非必须 |  | 图片上传类型 1本地 2七牛云 3OSS 4COS | format: int32
├─ name | string | 非必须 |  | 附件名称 |
├─ pid | integer | 非必须 |  | 分类ID 0编辑器,1商品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图,7前台用户,8微信系列 | format: int32
├─ sattDir | string | 非必须 |  | 压缩图片路径 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
├─ page | integer | 非必须 |  |  | format: int32
├─ total | integer | 非必须 |  |  | format: int64
├─ totalPage | integer | 非必须 |  |  | format: int32
message | string | 非必须 |  |  |

## 删除

### 基本信息

Path： /api/admin/system/attachment/delete/{ids}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
ids |  | ids

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/admin/system/attachment/save

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
attDir | string | 非必须 |  | 附件路径 |
attId | integer | 非必须 |  |  | format: int32
attSize | string | 非必须 |  | 附件大小 |
attType | string | 非必须 |  | 附件类型 |
createTime | string | 非必须 |  | 创建时间 | format: date-time
imageType | integer | 非必须 |  | 图片上传类型 1本地 2七牛云 3OSS 4COS | format: int32
model | string | 非必须 |  | 模块，store |
moduleType | integer | 非必须 |  | 图片上传模块类型 1 后台上传 2 用户生成 | format: int32
name | string | 非必须 |  | 附件名称 |
rootDir | string | 非必须 |  | 服务器上存储的绝对地址 |
sattDir | string | 非必须 |  | 压缩图片路径 |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 更改图片目录

### 基本信息

Path： /api/admin/system/attachment/move

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
attrId | integer | 非必须 |  |  | format: int32
pid | integer | 非必须 |  |  | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | string | 非必须 |  |  |
message | string | 非必须 |  |  |

## 详情

### 基本信息

Path： /api/admin/system/attachment/info/{id}

Method： GET

接口描述：

### 请求参数

路径参数

参数名称 | 示例 | 备注
--- | --- | ---
id |  | id

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 附件管理表 |
├─ attDir | string | 非必须 |  | 附件路径 |
├─ attId | integer | 非必须 |  |  | format: int32
├─ attSize | string | 非必须 |  | 附件大小 |
├─ attType | string | 非必须 |  | 附件类型 |
├─ createTime | string | 非必须 |  | 创建时间 | format: date-time
├─ imageType | integer | 非必须 |  | 图片上传类型 1本地 2七牛云 3OSS 4COS | format: int32
├─ name | string | 非必须 |  | 附件名称 |
├─ pid | integer | 非必须 |  | 分类ID 0编辑器,1商品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图,7前台用户,8微信系列 | format: int32
├─ sattDir | string | 非必须 |  | 压缩图片路径 |
├─ updateTime | string | 非必须 |  | 更新时间 | format: date-time
message | string | 非必须 |  |  |

# 验证码服务

## 检测验证码

### 基本信息

Path： /api/admin/validate/code/check

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
code | 是 |  | code
key | 是 |  | key

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | boolean | 非必须 |  |  |
message | string | 非必须 |  |  |

## 获取验证码

### 基本信息

Path： /api/admin/validate/code/get

Method： GET

接口描述：

### 请求参数

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  | 验证码类 |
├─ code | string | 必须 |  | code |
├─ key | string | 必须 |  | key |
message | string | 非必须 |  |  |