IconCreated with Sketch.

YAPI 接口文档

YApi
  • 基础接口
    • 登录页面图片数据
    • 验证码
    • 管理员登录
    • 管理员退出
    • 下载文件
  • 主页
    • 获取logo
    • 获取采单列表
    • 消息提醒
    • 首页头部
    • 首页订单图表
    • 首页用户图表
    • 首页商品交易额排行
    • 获取菜单数据
  • 商品->商品管理
    • 删除商品草稿
    • 获取商品表单头
    • 商品列表
    • 商品导出
    • 保存新增或编辑
    • 获取规则属性模板
    • 获取运费模板
    • 获取上传密钥
    • 检测活动存在
    • 商品采集
    • 获取商品采集配置
    • 商品采集保存
    • 设置商品批量下架
    • 获取退出是未保存数据
    • 1分钟保存一次数据
    • 获取商品分类cascader列表
    • 选择商品列表
    • 商品详情
    • 商品上下架操作
    • 商品加入/移除回收站
    • 商品快速编辑
    • 设置产品批量上架
    • 生成属性
    • 获取京东、淘宝商品数据(已废弃)
    • 获取商品详情描述
    • 商品属性详情
  • 商品->商品分类
    • 分类列表
    • 树形列表
    • 新增表单
    • 分类添加
    • 编辑表单
    • 分类编辑
    • 分类删除
    • 修改状态
    • 快捷编辑
  • 商品->商品规格
    • 保存新建或编辑
    • 列表
    • 删除
    • 规则详情
  • 商品->商品评论
    • 商品评论列表
    • 删除评论
    • 回复评论
    • 虚拟评论表单
    • 添加虚拟评论
  • 订单->订单管理
    • 批量删除订单
    • 订单类型数据
    • 订单列表
    • 订单导出
    • 获取订单编辑表单
    • 修改订单
    • 订单退款表单
    • 手动批量发货
    • 自动批量发货
    • 订单退款
    • 获取物流信息
    • 订单详情
    • 获取配送信息表单
    • 修改配送信息
    • 获取不退款表单
    • 修改不退款理由
    • 订单核销
    • 订单号核销
    • 线下支付(立即支付)
    • 获取退积分表单
    • 修改退积分
    • 修改备注信息
    • 获取订单状态记录
    • 伪删除订单
    • 小票打印
    • 获取配送员列表
    • 电子面单模板
    • 发送货
    • 获取物流公司列表
    • 确认收货
    • 获取电子面单打印默认数据
    • 电子面单打印
  • 订单->收银订单
    • 收银订单列表
    • 收款二维码
  • 订单->售后退款
    • 售后退款列表
  • 用户->用户管理
    • 发送图文消息
    • 获取会员列表头(已废弃)
    • 用户列表
    • 获取设置用户分组表单
    • 保存用户分组
    • 获取设置用户标签表单
    • 保存用户标签
    • 同步用户
    • 添加用户表单
    • 添加用户
    • 编辑用户表单
    • 修改用户状态
    • 编辑用户
    • 用户详情中(积分、消费、签到等信息)
    • 用户详情
    • 获取编辑其他表单
    • 编辑其他
    • 赠送付费会员时长表单
    • 执行赠送付费会员
    • 获取赠送会员等级表单(已废弃)
    • 赠送会员等级(已废弃)
    • 清除会员等级(已废弃)
    • 获取某用户推广下线(已废弃)
    • 获取某用户的订单列表(已废弃)
    • 获取某用户的积分列表(已废弃)
    • 获取某用户的签到明细(已废弃)
    • 获取某用户的优惠券列表(已废弃)
    • 获取某用户的余额变动记录(已废弃)
  • 用户->用户分组
    • 分组列表
    • 删除分组
    • 添加/修改分组
    • 添加/修改分组表单
  • 用户->用户标签
    • 用户标签列表
    • 用户标签添加/编辑表单
    • 添加、编辑用户标签
    • 删除用户标签
    • 获取标签分类(分页)
    • 获取标签分类(全部)
    • 获取用户标签分类创建表单
    • 保存用户标签分类
    • 获取用户标签分类编辑表单
    • 编辑用户标签分类
    • 删除用户标签分类
    • 获取用户标签
    • 保存和取消用户标签
  • 用户->用户等级
    • 等级列表
    • 创建等级表单
    • 会员等级添加或者修改
    • 删除会员等级(假删)
    • 设置等级的显示和隐藏
    • 等级列表快速编辑
    • 等级任务列表(已废弃)
    • 快速编辑等级任务(已废弃)
    • 设置等级任务的显示和隐藏(已废弃)
    • 设置任务是否务必达成(已废弃)
    • 生成任务表单(已废弃)
    • 保存或修改任务(已废弃)
    • 等级详情(已废弃)
    • 删除任务(已废弃)
  • 用户->付费会员->会员类型
    • 会员卡类型编辑
    • 会员类型列表
    • 会员类型启用|禁用
  • 用户->付费会员->会员权益
    • 会员权益
    • 修改会员权益
  • 用户->付费会员->会员协议
    • 获取会员协议
    • 设置会员协议
  • 用户->付费会员->卡密会员
    • 批次卡列表
    • 生成批次卡
    • 会员卡导出
    • 列表操作(启用,名称修改)
    • 会员卡列表
    • 修改会员卡状态
    • 会员卡列表单字段修改
    • 兑换会员卡二维码
  • 用户->付费会员->会员记录
    • 会员卡记录
  • 分销->分销设置
    • 获取配置表单
    • 保存配置
  • 分销->分销员管理
    • 分销员列表头部统计
    • 分销员列表
    • 分销员导出
    • 推广人列表
    • 推广人列表头部
    • 推广订单列表
    • 推广订单列表头部
    • 查看公众号推广二维码
    • 查看小程序推广二维码
    • 查看h5推广二维码
    • 清除上级推广人
    • 修改上级用户
    • 取消推广资格
  • 客服->客服列表
    • 客服列表
    • 添加客服选择用户
    • 添加客服表单
    • 添加客服
    • 编辑客服表单
    • 编辑客服
    • 删除客服
    • 聊天记录
    • 查看对话
    • 修改状态
    • 登录客服平台
  • 客服->客服话术
    • 话术列表
    • 添加话术表单
    • 添加话术
    • 编辑话术表单
    • 编辑话术
    • 删除话术
    • 获取话术信息
    • 获取话术分类
    • 添加话术分类表单
    • 添加话术分类
    • 修改话术分类表单
    • 修改话术分类
    • 删除话术分类
  • 客服->用户留言
    • 获取客服反馈列表
    • 反馈备注表单
    • 反馈备注
    • 删除反馈
  • 营销->优惠券->优惠券列表
    • 列表(已废弃)
    • 新增表单(已废弃)
    • 新增(已废弃)
    • 编辑表单(已废弃)
    • 编辑(已废弃)
    • 删除(已废弃)
    • 立即失效(已废弃)
    • 发布优惠券表单(已废弃)
    • 发布优惠券(已废弃)
    • 优惠券列表
    • 添加优惠券
    • 一键复制优惠券
    • 修改优惠券状态
    • 某个优惠券领取记录
    • 删除优惠券
    • 发送优惠券列表
    • 发送优惠券
  • 营销->优惠券->用户领取记录
    • 用户领取优惠券记录
  • 营销->砍价管理->砍价商品
    • 修改状态
    • 删除
    • 商品详情
    • 开启砍价(已废弃)
    • 新增/编辑/复制
    • 砍价商品列表
    • 商铺砍价活动导出
  • 营销->砍价管理->砍价列表
    • 砍价列表
    • 砍价详情
  • 营销->拼团管理->拼团商品
    • 拼团商品列表
    • 拼团商品详情
    • 添加/编辑/复制
    • 商铺拼团导出
    • 修改拼团状态
    • 删除
    • 开启拼团(已废弃)
    • 导出(已废弃)
  • 营销->拼团管理->拼团列表
    • 拼团统计
    • 拼团列表
    • 拼团详情
  • 营销->秒杀管理->秒杀商品
    • 秒杀商品列表
    • 秒杀时间段列表
    • 保存新增或编辑
    • 详情
    • 获取商品规格-秒杀
    • 删除
    • 修改秒杀状态
    • 秒杀商品导出
    • 导出(已废弃)
    • 获取秒杀等详情(已废弃)
    • 开启秒杀(已废弃)
  • 营销->秒杀管理->秒杀配置
    • 修改状态
    • 删除
    • 添加表单
    • 秒杀配置头部数据
    • 秒杀配置数据列表
    • 编辑表单
  • 营销->积分管理->积分配置
    • 保存配置
    • 获取配置数据
  • 营销->积分管理->积分日志
    • 积分日志列表
    • 积分日志头部数据
    • 用户积分导出
    • 积分日志导出(已废弃)
  • 营销->积分管理->签到配置
    • 修改状态
    • 删除
    • 标记表单
    • 添加表单
    • 签到配置头部数据
    • 签到配置数据列表
  • 营销->积分管理->积分商品
    • 积分商品列表
    • 积分商品订单列表
    • 积分商品详情
    • 积分订单统计数据
  • 营销->预售管理->预售管理
    • 预售商品列表
    • 预售商品详情
  • 营销->直播管理->直播间管理
    • 直播列表
    • 添加直播间
    • 直播间删除
    • 直播间添加商品
    • 直播间设置是否显示
    • 直播间详情
    • 同步直播间状态
  • 营销->直播管理->直播商品管理
    • 直播商品列表
    • 直播商品详情
    • 直播商品删除
    • 生成直播商品(直播商品添加准备数据)
    • 直播商品添加
    • 直播商品设置是否显示
    • 同步直播商品审核状态(未启用)
  • 营销->直播管理->主播管理
    • 主播列表
    • 主播添加/修改保存数据
    • 主播添加/修改获取表单
    • 删除主播
    • 设置主播是否显示
  • 营销->九宫格抽奖->九宫格抽奖
    • 抽奖列表
    • 抽奖记录
  • 财务->财务操作->提现申请
    • 保存编辑
    • 列表
    • 拒绝申请
    • 编辑表单
    • 通过申请
  • 财务->财务操作->发票管理
    • 发票列表
    • 发票头部统计
    • 开票详情
    • 设置发票状态
  • 财务->财务记录->充值记录
    • 充值记录列表
    • 获取用户充值数据
    • 删除
    • 退款表单
    • 退款
    • 用户充值记录导出
  • 财务->财务记录->资金监控
    • 筛选类型
    • 资金记录
    • 导出
    • 用户资金导出(已废弃)
  • 财务->佣金记录->佣金记录
    • 佣金记录
    • 佣金详情用户信息
    • 佣金提现记录个人列表
    • 用户佣金导出
  • 内容->文章管理
    • 文章列表
    • 文章详情
    • 新增或修改
    • 删除文章
    • 关联产品
    • 取消关联
    • 上传图文图片(已废弃)
  • 内容->文章分类
    • 修改状态
    • 分类列表
    • 删除分类
    • 新增分类
    • 新增分类表单
    • 编辑分类
    • 编辑分类表单
  • 统计->商品统计
    • 商品基础统计
    • 商品排行
    • 商品统计数据导出
    • 商品趋势
  • 统计->用户统计
    • 微信用户地域
    • 微信用户性别
    • 微信用户统计
    • 微信用户趋势
    • 用户基础统计
    • 用户统计数据导出
    • 用户趋势
  • 统计->交易统计
    • 交易统计上面数据
    • 交易统计下部分数据
  • 设置->系统设置
    • 基础配置头部
  • 设置->一号通
    • 获取验证码
    • 检测验证码
    • 注册服务
    • 登录平台
    • 获取平台用户信息
    • 开通电子面单
    • 开通短信服务
    • 修改短信签名
    • 获取短信模板
    • 申请短信模板表单
    • 申请模板
    • 申请模板(已废弃)
    • 获取申请记录
    • 开通其他服务
    • 获取用量列表
    • 全部物流公司
    • 快递公司面板
    • 修改密码
    • 修改手机号
    • 获取套餐
    • 获取支付码
    • 获取当前一号通账户是否开通电子面单
  • 设置->页面管理->页面设计
    • 模板列表
    • 添加表单
    • 获取商品
    • 获取商品列表
    • 获取添加表单
    • 设置默认数据
    • 页面链接(新)
    • 模版详情
    • 保存DIY数据
    • 删除DIY模板
    • 使用模板
    • 一键恢复默认
    • 获取商品分类
    • 获取页面链接
    • 获取门店自提开启状态
    • 获取所有二级商品分类
  • 设置->页面管理->数据配置
    • 获取所有组合数据
    • 获取列表头
    • 数据列表
    • 新建表单
    • 新增数据
    • 编辑表单
    • 编辑数据
    • 删除
    • 修改状态
  • 设置->页面管理->客服广告
    • 获取客服广告
    • 设置客服广告
  • 设置->管理权限->角色管理
    • 保存新建或编辑
    • 修改状态
    • 列表
    • 删除
    • 权限列表
    • 编辑详情
  • 设置->管理权限->管理员列表
    • 管理员列表
    • 管理员添加表单
    • 管理员添加
    • 获取修改管理员表单
    • 修改管理员信息
    • 删除管理员
    • 获取当前登陆管理员信息
    • 修改当前管理员信息
    • 修改状态
  • 设置->管理权限->权限规则
    • 获取权限列表
    • 获取权限规则表单
    • 添加权限
    • 修改权限规则表单(已废弃)
    • 修改权限规则
    • 删除规则
    • 获取单个规则
    • 修改显示
  • 设置->发货设置->配送员管理
    • 配送员列表
    • 新增配送员表单
    • 添加
    • 编辑配送员表单
    • 编辑
    • 删除
    • 修改配送员状态
    • 新增配送员选择用户列表(已废弃)
    • 订单时获取所有配送员列表(已废弃)
    • 编辑配送员表单(已废弃)
    • 列表修改账号状态(已废弃)
  • 设置->发货设置->提货点设置->提货点
    • 获取地图key
    • 门店列表分类数量
    • 门店列表
    • 获取门店详情
    • 保存或修改门店
    • 门店设置显示或隐藏
    • 删除门店
    • 商铺提货点导出(已废弃)
  • 设置->发货设置->提货点设置->核销员
    • 搜索门店列表
    • 核销员列表
    • 新增核销员表单
    • 修改核销员表单
    • 保存店员
    • 删除店员
    • 店员设置显示隐藏
  • 设置->发货设置->提货点设置->核销订单
    • 核销订单列表
    • 核销订单头部(已废弃)
    • 核销列表推荐人信息(已废弃)
  • 设置->发货设置->运费模板
    • 运费模板列表
    • 添加/修改运费模板
    • 删除运费模板
    • 获取城市数据
    • 修改运费模板数据(已废弃)
  • 设置->消息管理
    • 消息管理
    • 编辑消息通知
  • 应用->公众号->菜单
    • 保存菜单
    • 获取菜单值
  • 应用->公众号->微信模板消息
    • 修改状态
    • 列表
    • 删除
    • 新增操作
    • 新增表单
    • 编辑操作
    • 编辑表单
  • 应用->公众号->图文管理
    • 保存图文
    • 删除图文
    • 图文列表
    • 图文详情
  • 应用->公众号->自动回复->微信关注回复
    • 获取(关注、无效关键词)回复内容
    • 添加/修改关键词
  • 应用->公众号->自动回复
    • 修改关键词状态
    • 关键词列表
    • 删除关键词
    • 回复详情
    • 获取二维码
  • 应用->公众号-->微信用户管理(已废弃)
    • 修改分组
    • 修改用户分组表单
    • 修改用户标签
    • 修改用户标签表单
    • 分组列表
    • 删除分组
    • 删除标签
    • 同步标签
    • 操作名称列表
    • 标签列表
    • 添加分组
    • 添加分组表单
    • 添加标签
    • 添加标签表单
    • 用户列表
    • 用户行为列表
    • 编辑分组
    • 编辑分组表单
    • 编辑标签
    • 编辑标签表单
    • 获取用户分组和标签
    • 微信用户导出
  • 应用->小程序->小程序订阅消息
    • 一键同步订阅消息
    • 修改状态
    • 列表
    • 删除
    • 新增操作
    • 新增表单
    • 编辑操作
    • 编辑表单
  • 维护-开发配置-配置分类
    • 修改配置分类状态
    • 删除配置分类
    • 新增配置分类
    • 新增配置分类表单
    • 编辑配置分类
    • 编辑配置分类表单
    • 配置分类列表
    • 配置列表
    • 配置详情
    • 新增配置表单
    • 新增配置
    • 编辑配置表单
    • 编辑配置
    • 删除配置
    • 修改状态
    • 配置上传文件
  • 维护*开发配置-组合数据
    • 删除
    • 新增
    • 组合数据列表
    • 组合数据详情
    • 编辑
  • 维护->安全维护->刷新缓存
    • 刷新缓存
    • 清除日志
  • 维护->安全维护->系统日志
    • 系统日志管理员搜索条件
    • 系统日志
  • 维护->安全维护->文件校验
    • 保存文件内容(已废弃)
    • 打开目录(已废弃)
    • 文件校验
    • 读取文件(已废弃)
  • 维护->安全维护->清除数据
    • 更换域名
    • 清除数据
  • 维护->安全维护->数据备份
    • 获取表列表
    • 获取备份记录列表
    • 查看表结构详情
    • 优化表
    • 修复表
    • 备份表
    • 删除备份记录
    • 导入备份记录表
    • 下载备份记录表
  • 维护->物流公司
    • 修改状态
    • 列表
    • 删除(已废弃)
    • 同步物流公司
    • 新增表单(已废弃)
    • 新增(已废弃)
    • 编辑
    • 编辑表单
  • 维护->城市数据
    • 删除城市数据
    • 城市修改表单
    • 城市列表
    • 城市添加表单
    • 添加/修改城市数据
    • 清除城市数据缓存
  • 维护->附件管理->附件分类管理
    • 修改分类
    • 分类列表
    • 删除分类
    • 添加分类
  • 维护->附件管理->附件图片管理
    • 修改附件名称
    • 附件列表
    • 附件图片上传
    • 附件删除
    • 图片上传
    • 修改附件分类表单
    • 修改附件分类
    • 附件分类列表
    • 新增分类表单
    • 新增分类
    • 编辑分类表单
    • 编辑分类
    • 删除分类
  • 维护->商业授权
    • 查询授权
    • 申请授权
    • 验证授权

CRMEB_标准版后台

基础接口

登录页面图片数据

基本信息

Path: /adminapi/login/info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ slidestring []非必须轮播

item 类型: string

├─ 非必须
├─ logo_squarestring非必须方形logo
├─ logo_rectanglestring非必须长logo
├─ login_logostring非必须登录logo

验证码

基本信息

Path: /adminapi/captcha_pro

Method: GET

接口描述:

请求参数

返回数据

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

管理员登录

基本信息

Path: /adminapi/login

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 admin 用户名
pwd text 是 123456 密码
imgcode text 否 abcd 图片验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须登录token
├─ expires_timenumber非必须到期时间
├─ menusobject []非必须左侧菜单

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ childrenobject []必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []必须

item 类型: string

├─ 非必须
├─ childrenobject []必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []必须

item 类型: string

├─ 非必须
├─ childrenobject []必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []非必须

item 类型: string

├─ 非必须
├─ unique_authstring []非必须权限

item 类型: string

├─ 非必须
├─ user_infoobject非必须管理员信息
├─ idnumber非必须管理员ID
├─ accountstring非必须帐号
├─ head_picstring非必须头像
├─ logostring非必须logo
├─ logo_squarestring非必须正方形logo
├─ versionstring非必须版本号
├─ newOrderAudioLinkstring非必须

管理员退出

基本信息

Path: /adminapi/setting/admin/logout

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

下载文件

基本信息

Path: /adminapi/download

Method: GET

接口描述:

请求参数

主页

获取logo

基本信息

Path: /adminapi/logo

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ logostring非必须
├─ logo_squarestring非必须

获取采单列表

基本信息

Path: /adminapi/menusList

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须编号
├─ pidnumber必须上级ID
├─ menu_namestring必须菜单名称
├─ menu_pathstring必须菜单地址
├─ unique_authstring必须前端权限
├─ sortnumber必须排序
├─ typenumber必须类型
├─ htmlstring必须标签

消息提醒

基本信息

Path: /adminapi/jnotice

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ iconstring必须图标
├─ iconColorstring必须颜色
├─ titlestring必须标题
├─ urlstring必须链接
├─ typestring必须类型
├─ readnumber必须是否已读
├─ timenumber必须时间

首页头部

基本信息

Path: /adminapi/home/header

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject []非必须

item 类型: object

├─ todaynumber必须今日
├─ yesterdaynumber必须昨日
├─ today_rationumber,string必须日环比
├─ weeknumber必须本周
├─ last_weeknumber必须上周
├─ week_rationumber,string必须周环比
├─ totalstring必须总计
├─ datestring必须显示文字
├─ titlestring必须标题
├─ total_namestring必须总名称

首页订单图表

基本信息

Path: /adminapi/home/order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cycle 否 thirtyday 周期 thirtyday-30天 week-周 month-月 year-年

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ yAxisobject非必须
├─ maxnumnumber非必须
├─ maxpricestring非必须
├─ legendstring []非必须

item 类型: string

├─ 非必须
├─ xAxisstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ typestring必须
├─ itemStyleobject必须
├─ normalobject非必须
├─ colorobject非必须
├─ xnumber非必须
├─ ynumber非必须
├─ x2number非必须
├─ y2number非必须
├─ colorStopsobject []非必须

item 类型: object

├─ offsetnumber必须
├─ colorstring必须
├─ datanumber []必须

item 类型: number

├─ 非必须
├─ yAxisIndexnumber必须
├─ pre_cycleobject非必须
├─ countobject非必须
├─ datanumber非必须
├─ priceobject非必须
├─ datanumber非必须
├─ cycleobject非必须
├─ countobject非必须
├─ datanumber非必须
├─ percentnumber非必须
├─ is_plusnumber非必须
├─ priceobject非必须
├─ datastring非必须
├─ percentnumber非必须
├─ is_plusnumber非必须

首页用户图表

基本信息

Path: /adminapi/home/user

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ legendstring []非必须

item 类型: string

├─ 非必须
├─ yAxisobject非必须
├─ maxnumnumber非必须
├─ xAxisstring []非必须

item 类型: string

├─ 非必须
├─ seriesnumber []非必须

item 类型: number

├─ 非必须
├─ bing_xdatastring []非必须

item 类型: string

├─ 非必须
├─ bing_dataobject []非必须

item 类型: object

├─ namestring必须
├─ valuenumber必须
├─ itemStyleobject必须
├─ colorstring非必须

首页商品交易额排行

基本信息

Path: /adminapi/home/rank

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ product_idnumber必须
├─ store_namestring,null必须
├─ valstring必须

获取菜单数据

基本信息

Path: /adminapi/menus

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
is_show 否 1 是否显示
keyword 否 财务 搜索关键词

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ menusobject []非必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ childrenobject []必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []必须

item 类型: string

├─ 非必须
├─ childrenobject []必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []必须

item 类型: string

├─ 非必须
├─ childrenobject []非必须

item 类型: object

├─ pathstring必须
├─ titlestring必须
├─ iconstring必须
├─ headerstring必须
├─ is_headernumber必须
├─ authstring []非必须

item 类型: string

├─ 非必须
├─ unique_authstring []非必须

item 类型: string

├─ 非必须

商品->商品管理

删除商品草稿

基本信息

Path: /adminapi/product/cache

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
statusnumber非必须

获取商品表单头

基本信息

Path: /adminapi/product/product/type_header

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ typenumber必须
├─ namestring必须
├─ countnumber必须

商品列表

基本信息

Path: /adminapi/product/product

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
cate_id 否 分类id 默认传0
type 否 1 type值 1-6 数字
store_name 否 搜索词
sales 否 asc 销量排序asc desc 默认:normal

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mer_idnumber必须
├─ imagestring必须
├─ recommend_imagestring必须
├─ slider_imagestring []必须

item 类型: string

├─ 非必须
├─ store_namestring必须
├─ store_infostring必须
├─ keywordstring必须
├─ bar_codestring必须
├─ cate_idstring必须
├─ pricestring必须
├─ vip_pricestring必须
├─ ot_pricestring必须
├─ postagestring必须
├─ unit_namestring必须
├─ sortnumber必须
├─ salesnumber必须
├─ stockstring必须
├─ is_shownumber必须
├─ is_hotnumber必须
├─ is_benefitnumber必须
├─ is_bestnumber必须
├─ is_newnumber必须
├─ add_timenumber必须
├─ is_postagenumber必须
├─ is_delnumber必须
├─ mer_usenumber必须
├─ give_integralstring必须
├─ coststring必须
├─ is_seckillnumber必须
├─ is_bargainnull必须
├─ is_goodnumber必须
├─ is_subnumber必须
├─ is_vipnumber必须
├─ fictinumber必须
├─ browsenumber必须
├─ code_pathstring必须
├─ soure_linkstring必须
├─ video_linkstring必须
├─ temp_idnumber必须
├─ spec_typenumber必须
├─ activitystring必须
├─ spustring必须
├─ label_idstring必须
├─ command_wordstring必须
├─ collectnumber必须
├─ likesnumber必须
├─ visitornumber必须
├─ cate_namestring必须
├─ stock_attrboolean必须
├─ countnumber非必须

商品导出

基本信息

Path: /adminapi/export/storeProduct

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页数
limit 是 20 每页条数
cate_id 是 分类id
type 是 type值 1-6 数字
store_name 是 商铺名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须

item 类型: string

├─ 非必须导出文件地址

保存新增或编辑

基本信息

Path: /adminapi/product/product/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 商品id 新增时为0

Body

参数名称 参数类型 是否必须 示例 备注
cate_id text 是 分类ID 数组
store_name text 是 商品名称
store_info text 否 商品简介
keyword text 否 关键字
unit_name text 否 单位
bar_code text 否 产品码
image text 否 主产品
slider_image text 是 多图 数组
postage text 否 邮费
ot_price text 是 市场价
price text 是 价格
sort text 否 排序
stock text 是 库存
sales text 否 销量
ficti text 否 虚拟销量
give_integral text 否 获得积分
is_show text 是 是否上架
cost text 是 成本价
is_hot text 是 是否热卖
is_benefit text 是 是否优惠
is_best text 是 是否精品
is_new text 是 是否新品
mer_use text 是 商户是否代理
is_postage text 是 是否包邮
is_good text 是 是否优品推荐
spec_type text 是 规格类型
items text 是 属性值
attrs text 是 规则
coupon_ids text 是 [] 关联优惠券id
label_id text 是 [] 关联标签id
command_word text 是 商品复制口令

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取规则属性模板

基本信息

Path: /adminapi/product/product/get_rule

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ rule_namestring必须属性模板名称
├─ rule_valueobject []必须属性模板值

item 类型: object

├─ valuestring必须属性名称
├─ detailstring []必须属性值

item 类型: string

├─ 非必须

获取运费模板

基本信息

Path: /adminapi/product/product/get_template

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须

获取上传密钥

基本信息

Path: /adminapi/product/product/get_temp_keys

Method: GET

接口描述:

请求参数

检测活动存在

基本信息

Path: /adminapi/product/product/check_activity/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 商品ID

返回数据

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

商品采集

基本信息

Path: /adminapi/product/copy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
url text 是 https://item.jd.com/100009722461.html?extension_id=eyJhZCI6IjE3NTUiLCJjaCI6IjIiLCJza3UiOiIxMDAwMDk3MjI0NjEiLCJ0cyI6IjE2MDk5MDEwNzkiLCJ1bmlxaWQiOiJ7XCJjbGlja19pZFwiOlwiNWNjYTNmMTAtNWI5YS00ODAzLTk5MjYtMjZiMjMxYzZiZGNlXCIsXCJtYXRlcmlhbF9pZFwiOlwiMzA5NjI2Nzg1NVwiLFwicG9zX2lkXCI6XCIxNzU1XCIsXCJzaWRcIjpcImZkOWY0ODA2LWNhYmYtNDhjMC1iZGU3LTVkNTIwOTc3ODg2ZFwifSJ9&jd_pop=5cca3f10-5b9a-4803-9926-26b231c6bdce&abt=0

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ cate_idstring非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ unit_namestring非必须
├─ pricestring非必须
├─ keywordstring非必须
├─ fictinumber非必须
├─ ot_pricestring非必须
├─ give_integralnumber非必须
├─ postagenumber非必须
├─ costnumber非必须
├─ imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ video_linkstring非必须
├─ add_timenumber非必须
├─ stocknumber非必须
├─ descriptionstring非必须
├─ description_imagesstring []非必须

item 类型: string

├─ 非必须
├─ soure_linkstring非必须
├─ temp_idstring非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ attrsstring []非必须

item 类型: string

├─ 非必须
├─ infoobject非必须
├─ attrobject []非必须

item 类型: object

├─ valuestring必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 尺寸string非必须
├─ 版本string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ keystring必须
├─ slotstring必须

获取商品采集配置

基本信息

Path: /adminapi/product/copy_config

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ copy_typestring非必须
├─ copy_numnumber非必须

商品采集保存

基本信息

Path: /adminapi/product/crawl/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cate_id text 是 分类id
store_name text 是 产品名称
store_info text 是 产品简介
keyword text 是 产品关键字
unit_name text 是 单位
image text 是 产品主图
slider_image text 是 产品轮播图
price text 是 售价
ot_price text 是 市场价
give_integral text 是 赠送积分
postage text 是 邮费
ficti text 是 虚拟销量
stock text 是 库存
cost text 是 成本价
description_images text 是 [] 详情图片
description text 是 详情内容
is_show text 是 状态 0-下架 1-上架
soure_link text 是 原链接
temp_id text 是 运费模版
spec_type text 是 0 单、多规格
items text 是 [] 规格
attrs text 是 [] 规格详情

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

设置商品批量下架

基本信息

Path: /adminapi/product/product/product_unshow

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
ids 是 [] 选择商品ids

Body

参数名称 参数类型 是否必须 示例 备注
all text 否 0 0:单页1:所有加入队列
where text 否 条件

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

获取退出是未保存数据

基本信息

Path: /adminapi/product/cache

Method: GET

接口描述:

请求参数

1分钟保存一次数据

基本信息

Path: /adminapi/product/cache

Method: POST

接口描述:

请求参数

获取商品分类cascader列表

基本信息

Path: /adminapi/product/category/cascader_list/:type

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
authori-zation 是

路径参数

参数名称 示例 备注
type 1 非必填

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ pidnumber必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ pidnumber必须

选择商品列表

基本信息

Path: /adminapi/product/product/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
cate_id 否
store_name 否

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ mer_idnumber非必须商户Id
├─ imagestring非必须产品图片
├─ slider_imagestring []非必须轮播图

item 类型: string

├─ 非必须
├─ store_namestring非必须商品名称
├─ store_infostring非必须商品简介
├─ keywordstring非必须关键词
├─ cate_idstring []非必须分类

item 类型: string

├─ 非必须
├─ pricestring非必须价格
├─ vip_pricestring非必须会员价格
├─ ot_pricestring非必须市场价
├─ postagestring非必须邮费
├─ unit_namestring非必须单位名
├─ sortnumber非必须排序
├─ salesnumber非必须销量
├─ stocknumber非必须库存
├─ is_shownumber非必须是否显示
├─ is_hotnumber非必须是否热卖
├─ is_benefitnumber非必须是否优惠
├─ is_bestnumber非必须是否精品
├─ is_newnumber非必须是否新品
├─ descriptionstring非必须产品描述
├─ add_timenumber非必须添加时间
├─ is_postagenumber非必须是否包邮
├─ is_delnumber非必须是否删除
├─ mer_usenumber非必须商户是否代理
├─ give_integralstring非必须获得积分
├─ coststring非必须成本价
├─ is_seckillnumber非必须秒杀状态
├─ is_bargainnumber非必须砍价状态
├─ fictinumber非必须虚拟销量
├─ browsenumber非必须浏览量
├─ code_pathstring非必须浏览量
├─ soure_linknull非必须淘宝京东1688类型
├─ bar_codestring非必须产品条码
├─ is_goodnumber非必须虚拟销量
├─ cate_namestring非必须分类名称
├─ attrsobject []必须

item 类型: object

├─ product_idstring必须商品ID
├─ sukstring必须规格名称
├─ stockstring必须库存
├─ salesstring必须销量
├─ pricestring必须价格
├─ imagestring必须图片
├─ uniquestring必须唯一值
├─ coststring必须成本价
├─ bar_codestring必须规格编码
├─ ot_pricestring必须原价
├─ weightstring必须重量
├─ volumestring必须体积
├─ brokeragestring必须一级返佣
├─ brokerage_twostring必须二级返佣
├─ typestring必须类型
├─ quotastring必须限量
├─ quota_showstring必须限量显示

商品详情

基本信息

Path: /adminapi/product/product/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 商品id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ tempListobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ cateListobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ disablednumber必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring []非必须

item 类型: string

├─ 非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralnumber非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber []非必须

item 类型: number

├─ 非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring []非必须

item 类型: string

├─ 非必须
├─ spustring非必须
├─ label_idstring []非必须

item 类型: string

├─ 非必须
├─ command_wordstring非必须
├─ couponsstring []非必须

item 类型: string

├─ 非必须
├─ descriptionstring非必须
├─ itemsstring []非必须

item 类型: string

├─ 非必须
├─ attrsstring []非必须

item 类型: string

├─ 非必须
├─ attrobject非必须
├─ picstring非必须
├─ vip_pricenumber非必须
├─ pricenumber非必须
├─ costnumber非必须
├─ ot_pricenumber非必须
├─ stocknumber非必须
├─ bar_codestring非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ brokeragenumber非必须
├─ brokerage_twonumber非必须

商品上下架操作

基本信息

Path: /adminapi/product/product/set_show/:id/:is_show

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 商品id
is_show 1上架 0 下架

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商品加入/移除回收站

基本信息

Path: /adminapi/product/product/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 商品id参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商品快速编辑

基本信息

Path: /adminapi/product/product/set_product/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 商品id

Body

参数名称 参数类型 是否必须 示例 备注
field text 是 字段 ficti-虚拟销量 stock-库存 sort-排序
value text 是 字段值

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

设置产品批量上架

基本信息

Path: /adminapi/product/product/product_show

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 [] 选中的商品id
all text 否 0 0:单页1:所有加入队列
where text 否 条件

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

生成属性

基本信息

Path: /adminapi/product/generate_attr/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 0 商品id 新增时为0

Body

参数名称 参数类型 是否必须 示例 备注
attrs text 是

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ attrstring []非必须属性值

item 类型: string

├─ 非必须
├─ valuestring []非必须属性表单

item 类型: string

├─ 非必须
├─ headerstring []非必须属性表头

item 类型: string

├─ 非必须

获取京东、淘宝商品数据(已废弃)

基本信息

Path: /adminapi/product/crawl

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
link text 是 商品链接

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ cate_idstring非必须分类id
├─ store_namestring非必须产品名称
├─ store_infostring非必须产品简介
├─ unit_namestring非必须单位
├─ pricestring非必须产品售价
├─ keywordstring非必须产品关键字
├─ fictistring非必须虚拟销量
├─ ot_pricestring非必须产品市场价
├─ give_integralstring非必须赠送积分
├─ postagestring非必须邮费
├─ coststring非必须产品成本价
├─ imagestring非必须产品主图片
├─ slider_imagestring []非必须产品轮播图

item 类型: string

├─ 非必须
├─ add_timestring非必须添加时间
├─ stockstring非必须库存
├─ descriptionstring非必须详情内容
├─ soure_linkstring非必须原始链接
├─ description_imagesstring []非必须详情图片

item 类型: string

├─ 非必须

获取商品详情描述

基本信息

Path: /adminapi/goods/get_goods_field/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 商品id

返回数据

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

商品属性详情

基本信息

Path: /adminapi/product/attr/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

商品->商品分类

分类列表

基本信息

Path: /adminapi/product/category

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
is_show 否 1 是否显示 1-显示 0-不显示
pid 否 0 父级id
cate_name 否 产品名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ cate_namestring必须
├─ sortnumber必须
├─ picstring必须
├─ is_shownumber必须
├─ add_timestring必须
├─ big_picstring必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ cate_namestring必须
├─ sortnumber必须
├─ picstring必须
├─ is_shownumber必须
├─ add_timestring必须
├─ big_picstring必须
├─ countnumber非必须

树形列表

基本信息

Path: /adminapi/product/category/tree/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 1 0-仅顶级分类 1-所有分类

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须
├─ cate_namestring非必须分类名称
├─ htmlstring非必须

新增表单

基本信息

Path: /adminapi/product/category/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

分类添加

基本信息

Path: /adminapi/product/category

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cate_name text 是 分类名称
pid text 是 分类id
sort text 否 排序
pic text 否 图片
is_show text 否 1 是否显示

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/product/category/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

分类编辑

基本信息

Path: /adminapi/product/category/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
pid text 是 父级id
cate_name text 是 分类名称
pic text 是 [] 图标
sort text 是 排序
is_show text 是 1 状态 1-开启 2-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

分类删除

基本信息

Path: /adminapi/product/category/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改状态

基本信息

Path: /adminapi/product/category/set_show/:id/:is_show

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类id
is_show 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

快捷编辑

基本信息

Path: /adminapi/product/category/set_category/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类id

Body

参数名称 参数类型 是否必须 示例 备注
field text 是 cate_name 编辑的字段
value text 是 字段的值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商品->商品规格

保存新建或编辑

基本信息

Path: /adminapi/product/product/rule/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 规则id

Body

参数名称 参数类型 是否必须 示例 备注
rule_name text 是 规则名称
spec text 是 [{value: "123", detail: ["12", "123", "1234"]}, {value: "234", detail: ["23", "234", "345"]}] 规则值

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

列表

基本信息

Path: /adminapi/product/product/rule

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 15
rule_name 否 规则名称搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ rule_namestring非必须
├─ rule_valuestring非必须
├─ attr_namestring非必须
├─ attr_valuestring []非必须

item 类型: string

├─ 非必须
├─ countnumber非必须

删除

基本信息

Path: /adminapi/product/product/rule/delete

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 1,2,3 规则id id拼接的字符串
all text 否 0 0:单页1:所有加入队列执行
where text 否 条件

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

规则详情

基本信息

Path: /adminapi/product/product/rule/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 规则id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ rule_namestring非必须
├─ rule_valuestring非必须
├─ specobject []非必须

item 类型: object

├─ valuestring必须
├─ detailstring []必须

item 类型: string

├─ 非必须

商品->商品评论

商品评论列表

基本信息

Path: /adminapi/product/reply

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
account 否 评论用户名
is_reply 否 是否回复
store_name 否 产品名称
data 否 时间选择
product_id 否 指定商品评论 (默认)0-表示所有商品评论

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ product_idnumber非必须产品id
├─ accountstring非必须用户名名称
├─ imagestring非必须商品图片
├─ store_namestring非必须商品名称
├─ commentstring非必须评论内容
├─ picsstring非必须评论图片
├─ add_timenumber非必须添加时间
├─ merchant_reply_contentnull非必须回复内容
├─ scorestring非必须评分
├─ create_timestring非必须添加时间转换后
├─ timestring非必须表示时间间隔

mock: 3分钟前

删除评论

基本信息

Path: /adminapi/product/reply/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 评论id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

回复评论

基本信息

Path: /adminapi/product/reply/set_reply/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 回复id

Body

参数名称 参数类型 是否必须 示例 备注
content text 是 回复内容

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

虚拟评论表单

基本信息

Path: /adminapi/product/reply/fictitious_reply/:product_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
product_id 0 默认为0在选择商品

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuearray,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ srcKeystring非必须
├─ placeholderstring非必须
├─ allowHalfboolean非必须
├─ closeBtnboolean非必须
├─ okBtnboolean非必须
├─ editableboolean非必须
├─ colobject非必须
├─ spannumber非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加虚拟评论

基本信息

Path: /adminapi/product/reply/save_fictitious_reply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 商品ID
nickname text 是 用户昵称
avatar text 是 用户头像
comment text 是 评论内容
pics text 是 评论图片,数组
product_score text 是 商品分数
service_score text 是 服务分数
add_time text 否 2020-12-30 评论时间:为空默认当前时间

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须状态
msgstring非必须内容

订单->订单管理

批量删除订单

基本信息

Path: /adminapi/order/dels

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
ids 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 [1,2,3,4,5,6,7] 订单id合集

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

订单类型数据

基本信息

Path: /adminapi/order/chart

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 否 时间
type 是 1:普通订单2:拼团3:秒杀4:砍价

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ allstring非必须
├─ generalstring非必须
├─ pinkstring非必须
├─ seckillstring非必须
├─ bargainstring非必须
├─ statusAllstring非必须
├─ unpaidstring非必须
├─ unshippedstring非必须
├─ untakestring非必须
├─ write_offstring非必须
├─ write_offedstring非必须
├─ unevaluatestring非必须
├─ completestring非必须
├─ refundingstring非必须
├─ refundstring非必须
├─ delstring非必须

订单列表

基本信息

Path: /adminapi/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 '' 和 8 =全部,0=未支付,1=已支付,2待收货,3=待评价,4=交易完成,5=待核销,-1=退款中,-2=已退款,-3=包含-1和-2,-4=已删除 订单状态
real_name 否 wx157119520452732527 订单号或者用户名或者用户uid或者电话
is_del 否 1 或 0 是否是删除的订单
data 否 today,week,month,year,yesterday,quarter,lately7,lately30,自定义 时间查询
pay_type 否 1=微信支付,2=余额支付,3=线下支付 支付类型
order 否 a.id-desc,a.id-asc,a.order_id-desc,a.add_time-desc 排序
page 是 1 页码
limit 是 10 展示条数
type 是 '' = 全部,1=普通订单,2=拼团订单,3=秒杀订单,4=砍价订单 订单类型
field_key 是 uid order_id real_name user_phone title 精准查询字段

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ order_idstring必须
├─ trade_nostring必须
├─ uidnumber必须
├─ real_namestring必须
├─ user_phonestring必须
├─ user_addressstring必须
├─ cart_idstring []必须

item 类型: string

├─ 非必须
├─ freight_pricestring必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ total_postagestring必须
├─ pay_pricestring必须
├─ pay_postagestring必须
├─ deduction_pricestring必须
├─ coupon_idnumber必须
├─ coupon_pricestring必须
├─ paidnumber必须
├─ pay_timenumber必须
├─ pay_typestring必须
├─ add_timestring必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ refund_reason_wap_imgnull,string必须
├─ refund_reason_wap_explainnull,string必须
├─ refund_reason_timenull,number必须
├─ refund_reason_wapnull,string必须
├─ refund_reasonnull必须
├─ refund_pricestring必须
├─ delivery_namenull,string必须
├─ delivery_codestring必须
├─ delivery_typenull,string必须
├─ delivery_idnull,string必须
├─ fictitious_contentstring必须
├─ delivery_uidnumber必须
├─ gain_integralstring必须
├─ use_integralstring必须
├─ back_integralnull必须
├─ markstring必须
├─ is_delnumber必须
├─ uniquestring必须
├─ remarknull,string必须
├─ mer_idnumber必须
├─ is_mer_checknumber必须
├─ combination_idnumber必须
├─ pink_idnumber必须
├─ coststring必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ verify_codestring必须
├─ store_idnumber必须
├─ shipping_typenumber必须
├─ clerk_idnumber必须
├─ is_channelnumber必须
├─ is_remindnumber必须
├─ is_system_delnumber必须
├─ channel_typestring必须
├─ provincestring必须
├─ express_dumpstring必须
├─ nicknamestring必须
├─ phonestring必须
├─ spread_uidnumber必须
├─ spread_nicknamenull,string必须
├─ pinkStatusnull,number必须
├─ invoiceobject,null必须
├─ _infoobject必须
├─ 447object非必须
├─ cart_infoobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ integral_pricenumber非必须
├─ 448object非必须
├─ cart_infoobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ integral_pricenumber非必须
├─ 457object非必须
├─ cart_infoobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ integral_pricenumber非必须
├─ 460object非必须
├─ cart_infoobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ integral_pricenumber非必须
├─ 43978081192552824832object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ coupon_pricestring非必须
├─ integral_pricenumber非必须
├─ 176573819436850610176object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 43972728374732128256object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ pricestring非必须
├─ postagestring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ costnumber非必须
├─ temp_idnumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 43972296462607712256object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 43972294301400301568object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ pricestring非必须
├─ postagestring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ costnumber非必须
├─ temp_idnumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 122472286021982617600object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ pricestring非必须
├─ postagestring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ costnumber非必须
├─ temp_idnumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 43971277975030464512object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ pricestring非必须
├─ postagestring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ costnumber非必须
├─ temp_idnumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 43965497109977104384object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ _pay_timestring必须
├─ pink_namestring必须
├─ colorstring必须
├─ pay_type_namestring必须
├─ status_nameobject必须
├─ status_namestring非必须
├─ picsstring []非必须

item 类型: string

├─ 非必须
├─ _statusnumber必须
├─ clerk_namestring必须
├─ countnumber非必须
├─ statobject []非必须

item 类型: object

├─ namestring必须
├─ fieldstring必须
├─ countnumber,string,null必须
├─ classNamestring必须
├─ colnumber必须

订单导出

基本信息

Path: /adminapi/export/storeOrder

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否
real_name 否
data 否 today 时间选择
type 是

返回数据

名称类型是否必须默认值备注其他信息
stausnumber必须
msgstring必须
dataobject必须excel地址

获取订单编辑表单

基本信息

Path: /adminapi/order/edit/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单号id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ minnumber非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改订单

基本信息

Path: /adminapi/order/update/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单号id

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单号
total_price text 是 总价
total_postage text 是 原始邮费
pay_price text 是 支付金额
pay_postage text 是 支付邮费
gain_integral text 是 赠送积分

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须状态 400 =错误,200 = 正确
msgstring非必须提醒字段

订单退款表单

基本信息

Path: /adminapi/order/refund/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ precisionnumber非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

手动批量发货

基本信息

Path: /adminapi/order/hand/batch_delivery

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
file 是 对照文件

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

自动批量发货

基本信息

Path: /adminapi/order/other/batch_delivery

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
where text 是 条件
all text 是 0 1
ids text 是 订单ids
express_record_type text 是 1
type text 是 1
delivery_name text 是 快递公司名称
delivery_id text 是 快递单号
delivery_code text 是 快递公司编码
express_temp_id text 是 电子面单模板
to_name text 是 寄件人姓名
to_tel text 是 寄件人电话
to_addr text 是 寄件人地址
sh_delivery_name text 是 送货人姓名
sh_delivery_id text 是 送货人电话
sh_delivery_uid text 是 送货人ID
fictitious_content text 是 虚拟发货内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

订单退款

基本信息

Path: /adminapi/order/refund/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

Body

参数名称 参数类型 是否必须 示例 备注
refund_price text 是 1 退款金额
type text 是 1 1=立即退款,2=退款,返回原状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200=正确
msgstring非必须提示语

获取物流信息

基本信息

Path: /adminapi/order/express/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 2 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ delivery_namestring非必须快递名称
├─ delivery_idstring非必须快递单号
├─ resultobject []非必须

item 类型: object

├─ timestring必须时间
├─ statusstring必须状态

订单详情

基本信息

Path: /adminapi/order/info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ orderInfoobject非必须订单详情
├─ idnumber非必须订单id
├─ order_idstring非必须订单号
├─ uidnumber非必须用户uid
├─ real_namestring非必须收货姓名
├─ user_phonestring非必须收货电话号码
├─ user_addressstring非必须收货地址
├─ cart_idnumber []非必须购物车id

item 类型: number

├─ 非必须
├─ freight_pricestring非必须运费金额
├─ total_numnumber非必须商品总数
├─ total_pricestring非必须总金额
├─ total_postagestring非必须总邮费
├─ pay_pricestring非必须支付金额
├─ pay_postagestring非必须支付邮费
├─ deduction_pricestring非必须抵扣金额
├─ coupon_idnumber非必须优惠卷id
├─ coupon_pricestring非必须优惠卷金额
├─ paidnumber非必须是否支付
├─ pay_timenumber非必须支付时间
├─ pay_typestring非必须支付类型
├─ add_timenumber非必须订单生生成时间
├─ statusnumber非必须订单状态(-1 : 申请退款 -2 : 退货成功 0:待发货;1:待收货;2:已收货;3:待评价;-1:已退款)
├─ refund_statusnumber非必须0 未退款 1 申请中 2 已退款
├─ refund_reason_wap_imgnull非必须退款图片
├─ refund_reason_wap_explainnull非必须退款用户说明
├─ refund_reason_timenull非必须退款时间
├─ refund_reason_wapnull非必须前台退款原因
├─ refund_reasonnull非必须不退款的理由
├─ refund_pricestring非必须退款金额
├─ delivery_namestring非必须快递名称/送货人姓名
├─ delivery_typestring非必须发货类型
├─ delivery_idstring非必须快递单号/手机号
├─ gain_integralstring非必须消费赚取积分
├─ use_integralstring非必须使用积分
├─ back_integralnull非必须给用户退了多少积分
├─ markstring非必须备注
├─ is_delnumber非必须是否删除
├─ uniquestring非必须唯一id(md5加密)类似id
├─ remarknull非必须管理员备注
├─ mer_idnumber非必须商户ID
├─ is_mer_checknumber非必须是否审核
├─ combination_idnumber非必须拼团产品id
├─ pink_idnumber非必须拼团订单号
├─ coststring非必须成本价
├─ seckill_idnumber非必须秒杀
├─ bargain_idnumber非必须砍价
├─ verify_codestring非必须核销码
├─ store_idnumber非必须门店id
├─ shipping_typenumber非必须配送方式 1=快递 ,2=门店自提
├─ is_channelnumber非必须支付渠道(0微信公众号1微信小程序)
├─ is_remindnumber非必须新订单提醒
├─ is_system_delnumber非必须管理员是否删除
├─ _statusobject非必须
├─ _typestring非必须订单状态
├─ _payTypestring非必须余额支付
├─ _deliveryTypestring非必须配送方式
├─ _pay_timestring非必须格式化后的支付时间
├─ _add_timestring必须格式化后的添加时间
├─ userInfoobject非必须订单用户详情
├─ uidnumber非必须用户uid
├─ accountstring非必须用户名
├─ real_namestring非必须真实姓名
├─ birthdaynumber非必须生日
├─ card_idstring非必须身份证号码
├─ markstring非必须用户备注
├─ partner_idnumber非必须合伙人id
├─ group_idnumber非必须用户分组id
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ phonenull非必须手机号码
├─ add_timenumber非必须添加时间
├─ last_timenumber非必须最后一次登录时间
├─ now_moneystring非必须用户余额
├─ brokerage_pricestring非必须佣金金额
├─ integralstring非必须用户剩余积分
├─ sign_numnumber非必须连续签到天数
├─ statusnumber非必须1为正常,0为禁止
├─ levelnumber非必须等级
├─ spread_uidnumber非必须推广元id
├─ spread_timenumber非必须推广员关联时间
├─ user_typestring非必须用户类型
├─ is_promoternumber非必须是否为推广员
├─ pay_countnumber非必须用户购买次数
├─ spread_countnumber非必须下级人数
├─ clean_timenumber非必须清理会员时间
├─ addresstring非必须详细地址
├─ adminidnumber非必须管理员编号
├─ spread_namestring非必须推广员昵称

获取配送信息表单

基本信息

Path: /adminapi/order/distribution/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ multipleboolean非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuestring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改配送信息

基本信息

Path: /adminapi/order/distribution/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

Body

参数名称 参数类型 是否必须 示例 备注
delivery_name text 是 快递名称
delivery_id text 是 快递单号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取不退款表单

基本信息

Path: /adminapi/order/no_refund/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改不退款理由

基本信息

Path: /adminapi/order/no_refund/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
refund_reason text 是 不退款原因

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 = 正确
msgstring非必须提示语

订单核销

基本信息

Path: /adminapi/order/write

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
code text 是 核销码
confirm text 否 是否确认核销 0 = 验证确认,1=核销订单

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusnumber非必须订单状态
├─ uidnumber非必须用户uid
├─ order_idstring非必须订单号
├─ nicknamestring非必须用户昵称

订单号核销

基本信息

Path: /adminapi/order/write_update/:order_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
order_id wx0999999 订单号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

线下支付(立即支付)

基本信息

Path: /adminapi/order/pay_offline/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 =只正确
msgstring非必须提示语

获取退积分表单

基本信息

Path: /adminapi/order/refund_integral/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ minnumber非必须
├─ precisionnumber非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改退积分

基本信息

Path: /adminapi/order/refund_integral/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

Body

参数名称 参数类型 是否必须 示例 备注
back_integral text 是 可退积分

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=正确
msgstring非必须提示语

修改备注信息

基本信息

Path: /adminapi/order/remark/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

Body

参数名称 参数类型 是否必须 示例 备注
remark text 是 备注

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=正确
msgstring非必须提示语

获取订单状态记录

基本信息

Path: /adminapi/order/status/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 10 展示条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ oidnumber非必须
├─ change_typestring非必须
├─ change_messagestring非必须
├─ change_timestring非必须

伪删除订单

基本信息

Path: /adminapi/order/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=成功
msgstring非必须提示语

小票打印

基本信息

Path: /adminapi/order/print/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取配送员列表

基本信息

Path: /adminapi/order/delivery/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ avatarstring必须
├─ wx_namestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ phonestring必须
├─ nicknamestring必须
├─ countnumber非必须

电子面单模板

基本信息

Path: /adminapi/adminapi/order/express/temp

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
com 是 zhaijisong 快递公司编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须
├─ codestring必须
├─ picstring必须
├─ temp_idstring必须

发送货

基本信息

Path: /adminapi/order/delivery/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

Body

参数名称 参数类型 是否必须 示例 备注
type text 是 1=发货,2=送货,3=虚拟发货 类型
delivery_name text 是 快递公司
delivery_id text 是 单号
delivery_code text 是 快递公司编码
sh_delivery_id text 否 送货人电话
sh_delivery_name text 否 送货人姓名
sh_delivery_uid text 是 送货人uid
express_record_type text 是 2 发货记录类型
express_temp_id text 是 电子面单模版
to_name text 是 寄件人姓名
to_tel text 是 寄件人电话
to_addr text 是 寄件人地址
fictitious_content text 是 虚拟发货备注

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取物流公司列表

基本信息

Path: /adminapi/order/express_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ valuestring必须
├─ codestring必须

确认收货

基本信息

Path: /adminapi/order/take/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须200 = 成功,400 = 错误
msgstring非必须备注

获取电子面单打印默认数据

基本信息

Path: /adminapi/order/sheet_info

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ express_temp_idstring非必须
├─ idstring非必须
├─ to_namestring非必须
├─ to_telstring非必须
├─ to_addstring非必须
├─ export_openboolean非必须

电子面单打印

基本信息

Path: /adminapi/order/order_dump/:order_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
order_id wx0999999 订单号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

订单->收银订单

收银订单列表

基本信息

Path: /adminapi/order/scan_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
order_id 否 订单号
name 否 用户名
add_time 否 创建时间
page 否 1 页数
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ typenumber必须
├─ order_idstring必须
├─ member_typestring必须
├─ codestring必须
├─ pay_typestring必须
├─ paidnumber必须
├─ pay_pricestring必须
├─ member_pricestring必须
├─ pay_timestring必须
├─ trade_nostring必须
├─ channel_typestring必须
├─ is_freenumber必须
├─ is_permanentnumber必须
├─ overdue_timenumber必须
├─ is_delnumber必须
├─ vip_daynumber必须
├─ add_timestring必须
├─ moneystring必须
├─ phonestring,null必须
├─ nicknamestring,null必须
├─ true_pricestring必须
├─ countnumber非必须

收款二维码

基本信息

Path: /adminapi/order/offline_scan

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 是否生成画布

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ wechatstring非必须
├─ routinestring非必须

订单->售后退款

售后退款列表

基本信息

Path: /adminapi/refund/list?page=1&limit=15&order_id=&time=&refund_type=0

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
order_id 是 订单id
time 是 时间选择
refund_type 是 退款状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ order_idstring必须
├─ trade_nostring必须
├─ uidnumber必须
├─ real_namestring必须
├─ user_phonestring必须
├─ user_addressstring必须
├─ cart_idstring []必须

item 类型: string

├─ 非必须
├─ freight_pricestring必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ total_postagestring必须
├─ pay_pricestring必须
├─ pay_postagestring必须
├─ deduction_pricestring必须
├─ coupon_idnumber必须
├─ coupon_pricestring必须
├─ paidnumber必须
├─ pay_timenumber必须
├─ pay_typestring必须
├─ add_timestring必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ refund_typenumber必须
├─ refund_expressstring必须
├─ refund_reason_wap_imgstring必须
├─ refund_reason_wap_explainstring必须
├─ refund_reason_timenumber必须
├─ refund_reason_wapstring必须
├─ refund_reasonnull,string必须
├─ refund_pricestring必须
├─ delivery_namenull,string必须
├─ delivery_codestring必须
├─ delivery_typenull,string必须
├─ delivery_idnull,string必须
├─ fictitious_contentstring必须
├─ delivery_uidnumber必须
├─ gain_integralstring必须
├─ use_integralstring必须
├─ back_integralnull必须
├─ spread_uidnumber必须
├─ one_brokeragestring必须
├─ two_brokeragestring必须
├─ markstring必须
├─ is_delnumber必须
├─ uniquestring必须
├─ remarknull必须
├─ mer_idnumber必须
├─ is_mer_checknumber必须
├─ combination_idnumber必须
├─ pink_idnumber必须
├─ coststring必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ verify_codestring必须
├─ store_idnumber必须
├─ shipping_typenumber必须
├─ clerk_idnumber必须
├─ is_channelnumber必须
├─ is_remindnumber必须
├─ is_system_delnumber必须
├─ channel_typestring必须
├─ provincestring必须
├─ express_dumpstring必须
├─ nicknamestring必须
├─ phonestring必须
├─ spread_nicknamenull,string必须
├─ _infoobject必须
├─ 79136781854014439424object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 79136782009711198208object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 79136780265862201344object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 7136542965014200320object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136536042781016064object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136535153085251584object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 1136129035737497600object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136524359647887360object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136523931757576192object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 7136505345638924288object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136523637241937920object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 115136522412270288896object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 7136521379842359296object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 7136509747154124800object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ 7136507866461765632object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ pricestring非必须
├─ postagestring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ costnumber非必须
├─ temp_idnumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ _refund_timestring必须
├─ _pay_timestring必须
├─ pink_namestring必须
├─ colorstring必须
├─ pay_type_namestring必须
├─ status_nameobject必须
├─ status_namestring非必须
├─ picsstring []非必须

item 类型: string

├─ 非必须
├─ _statusnumber必须
├─ clerk_namestring必须
├─ countnumber非必须
├─ numobject []非必须

item 类型: object

├─ namestring必须
├─ numnumber必须

用户->用户管理

发送图文消息

基本信息

Path: /adminapi/app/wechat/push

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 58 要发送的图文id
user_ids text 是 1,2,3 接受消息的用户id 拼接的字符串

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取会员列表头(已废弃)

基本信息

Path: /adminapi/user/user/type_header

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ user_typestring必须会员类型
├─ namestring必须会员名称
├─ countnumber必须数量

用户列表

基本信息

Path: /adminapi/user/user

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
nickname 否 jack 用户昵称
status 否 1为正常,0为禁止 用户状态
pay_count 否 -1:0 0:1+ 1:2+ 2:3+ 3:4+ 4:5+ 消费情况
is_promoter 否 0-普通会员 1-推广员 是否为推广员
order 否 a.id-desc,a.id-asc,a.order_id-desc,a.add_time-desc 排序
data 是 today 时间
user_type 否 wechat-微信公众号 routine-微信小程序 h5-H5 用户类型
country 否 domestic:中国 abroad:外国 国家
province 否 陕西省 省份
city 否 西安市 城市
user_time_type 否 visitno-时间段未访问 visit-时间段访问过 add_time-首次访问 访问情况
user_time 否 2019-11-06 - 2019-12-10 访问时间段
sex 否 1-男 2-女 0-保密 性别
level 是 1 等级
group_id 是 1 分组id
label_id 是 1 标签id
now_money 是 asc desc normal 余额排序
field_key 是 uid nickname user_type phone 准确搜索字段
isMember 是 1 是否付费会员

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber必须
├─ real_namestring必须
├─ birthdaystring必须
├─ card_idstring必须
├─ markstring必须
├─ partner_idnumber必须
├─ group_idstring必须
├─ nicknamestring必须
├─ avatarstring必须
├─ phonestring必须
├─ add_timenumber必须
├─ last_timenumber必须
├─ now_moneystring必须
├─ brokerage_pricestring必须
├─ integralnumber必须
├─ expstring必须
├─ sign_numnumber必须
├─ statusstring必须
├─ levelstring必须
├─ spread_opennumber必须
├─ spread_uidnumber必须
├─ spread_timenumber必须
├─ user_typestring必须
├─ is_promoternumber必须
├─ pay_countnumber必须
├─ spread_countnumber必须
├─ addresstring必须
├─ adminidnumber必须
├─ login_typestring必须
├─ record_phonestring必须
├─ is_money_levelnumber必须
├─ is_ever_levelnumber必须
├─ overdue_timenumber必须
├─ uniqidstring必须
├─ countrystring必须
├─ provincestring必须
├─ citystring必须
├─ sexstring必须
├─ unionidstring,null必须
├─ openidstring必须
├─ w_user_typestring必须
├─ groupidnumber必须
├─ tagid_listnull,string必须
├─ subscribenumber必须
├─ subscribe_timenull,number必须
├─ extract_count_pricenumber必须
├─ spread_uid_nicknamestring必须
├─ vip_nameboolean必须
├─ labelsstring必须
├─ isMembernumber必须

获取设置用户分组表单

基本信息

Path: /adminapi /user/set_group

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
uids text 是 [1,2] 用户ID
all text 是 0 1
where text 是 条件

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

保存用户分组

基本信息

Path: /adminapi/user/save_set_group

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
group_id 是 1 会员分组ID

Body

参数名称 参数类型 是否必须 示例 备注
group_id text 是 分组id
uids text 是 uids
all text 是 0 1
where text 是 条件

返回数据

名称类型是否必须默认值备注其他信息
statusstring必须
msgstring必须

获取设置用户标签表单

基本信息

Path: /adminapi/user/set_label

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
uids text 是 [1,2] 用户ID
all text 是 0 1
where text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

保存用户标签

基本信息

Path: /adminapi/user/save_set_label

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
uids text 是 1,2 用户ID
label_id text 是 1,2 标签ID
all text 是 0 1
where text 是 条件

返回数据

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

同步用户

基本信息

Path: /adminapi/user/user/syncUsers

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

添加用户表单

基本信息

Path: /adminapi/user/user/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ editableboolean非必须
├─ multipleboolean非必须
├─ filterableboolean非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ infostring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加用户

基本信息

Path: /adminapi/user/user/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
is_promoter text 是 推广员权限是否开启
real_name text 是 姓名
card_id text 是 身份证号
birthday text 是 生日
mark text 是 备注
status text 是 状态
level text 是 等级
phone text 是 手机号
addres text 是 地址
label_id text 是 标签id
group_id text 是 分组id
pwd text 是 密码
true_pwd text 是 确认密码
spread_open text 是 是否禁用推广员

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑用户表单

基本信息

Path: /adminapi/user/user/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuearray,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ editableboolean非必须
├─ multipleboolean非必须
├─ filterableboolean非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ infostring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改用户状态

基本信息

Path: /adminapi/user/set_status/:status/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
status 1 要修改的状态 0-禁用 1-解禁
id 1 会员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=正确
msgstring非必须

编辑用户

基本信息

Path: /adminapi/user/user/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 会员id

Body

参数名称 参数类型 是否必须 示例 备注
money_status text 是 余额改变类型
is_promoter text 是 推广员权限
real_name text 是 姓名
card_id text 是 身份证
birthday text 是 生日
mark text 是 备注
money text 是 余额变动数
integration_status text 是 积分改变类型
integration text 是 积分变动数
status text 是 状态
level text 是 等级
phone text 是 手机号
addess text 是 地址
label_id text 是 标签
group_id text 是 分组
pwd text 是 密码
true_pwd text 是 确认密码
spread_open text 是 禁用推广员

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户详情中(积分、消费、签到等信息)

基本信息

Path: /adminapi/user/one_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

Query

参数名称 是否必须 示例 备注
type 是 spread:推广下线; order:订单列表; integral:积分列表; sign:签到明细; coupon:持有优惠劵; balance_change:余额变动记录 类别
page 否 1 页码
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ countnumber非必须

用户详情

基本信息

Path: /adminapi/user/user/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 97 uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ uidnumber非必须
├─ userinfoobject []非必须

item 类型: object

├─ namestring必须
├─ valuestring,number必须
├─ headerListobject []非必须

item 类型: object

├─ titlestring必须
├─ valuestring,number必须
├─ keystring必须
├─ countnumber []非必须

item 类型: number

├─ 非必须
├─ ps_infoobject非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须

获取编辑其他表单

基本信息

Path: /adminapi/user/edit_other/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber必须
├─ titlestring必须
├─ propsobject必须
├─ placeholderstring非必须
├─ minnumber非必须
├─ precisionnumber非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑其他

基本信息

Path: /adminapi/user/update_other/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 会员id

Body

参数名称 参数类型 是否必须 示例 备注
money_status text 是
money text 是
integration_status text 是
integration text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

赠送付费会员时长表单

基本信息

Path: /adminapi/user/give_level_time/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ valuestring非必须
├─ titlestring非必须
├─ propsobject非必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

执行赠送付费会员

基本信息

Path: /adminapi/user/save_give_level_time/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
days text 是 天数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取赠送会员等级表单(已废弃)

基本信息

Path: /adminapi/user/give_level/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ value string非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validatestring []非必须

item 类型: string

├─ 非必须
├─ colstring []非必须

item 类型: string

├─ 非必须
titlestring非必须
actionstring非必须
methodstring非必须

赠送会员等级(已废弃)

基本信息

Path: /adminapi/user/save_give_level/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 会员id

Body

参数名称 参数类型 是否必须 示例 备注
level_id text 是 1 会员等级id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

清除会员等级(已废弃)

基本信息

Path: /adminapi/user/del_level/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 会员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取某用户推广下线(已废弃)

基本信息

Path: /adminapi/user/spread_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 10 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=正确
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ uidnumber非必须用户id
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像地址
├─ add_timestring非必须创建时间

获取某用户的订单列表(已废弃)

基本信息

Path: /adminapi/user/order_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 会员id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 10 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ order_idstring非必须订单号
├─ real_namestring非必须用户真实姓名
├─ total_numnumber非必须订单商品总数
├─ total_pricenumber非必须订单总价
├─ pay_pricenumber非必须实际支付金额
├─ pay_timestring非必须支付时间
├─ paidnumber非必须支付状态
├─ pay_typestring非必须支付方式
├─ pink_idnumber非必须拼团id 0没有拼团
├─ seckill_idnumber非必须秒杀产品ID
├─ bargain_idstring非必须砍价id

获取某用户的积分列表(已废弃)

基本信息

Path: /adminapi/user/integral_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 10 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
magstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ titlestring非必须账单标题
├─ numbernumber非必须明细数字
├─ balancenumber非必须剩余
├─ markstring非必须备注
├─ add_timestring非必须添加时间

获取某用户的签到明细(已废弃)

基本信息

Path: /adminapi/user/sign_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 10 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须签到说明
├─ numbernumber非必须获得积分
├─ markstring非必须备注
├─ add_timestring非必须添加时间

获取某用户的优惠券列表(已废弃)

基本信息

Path: /adminapi/user/coupon_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ _add_timestring非必须优惠券创建时间
├─ _end_timestring非必须优惠券结束时间
├─ use_min_pricenumber非必须最低消费多少金额可用优惠券
├─ coupon_pricenumber非必须优惠券的面值
├─ _typestring非必须0-普通 1-超过一年 2-未超过一年
├─ _msgstring非必须状态 (已失效 可使用 已使用 已过期)

获取某用户的余额变动记录(已废弃)

基本信息

Path: /adminapi/user/balance_change_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ add_timestring非必须添加时间
├─ titlestring非必须账单标题
├─ typestring非必须明细类型
├─ markstring非必须备注
├─ numbernumber非必须明细数字
├─ balancenumber非必须剩余
├─ pmstring非必须类型:支出 获得
├─ statusstring非必须状态:待确定 有效 无效

用户->用户分组

分组列表

基本信息

Path: /adminapi/user/user_group/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1
limit 是 15

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countnumber必须
├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ group_namestring必须

删除分组

基本信息

Path: /adminapi/user/user_group/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分组ID

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

添加/修改分组

基本信息

Path: /adminapi/user/user_group/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 新增时为0,修改时为当前ID
group_name 是 分组名称

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 分组ID 新增为0
group_name text 是 测试分组 分组名称

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

添加/修改分组表单

基本信息

Path: /adminapi/user/user_group/add/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 分组ID 新增为0

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring非必须
├─ propsobject非必须
├─ typestring非必须
├─ placeholderstring非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

用户->用户标签

用户标签列表

基本信息

Path: /adminapi/user/user_label

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页数
limit 是 15 条数
label_cate 否 1 标签分类

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ label_catenumber必须
├─ label_namestring必须
├─ countnumber非必须

用户标签添加/编辑表单

基本信息

Path: /adminapi/user/user_label/add/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 添加为0 ,修改为标签ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring必须
├─ titlestring必须
├─ propsobject必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ typestring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber非必须
├─ labelstring非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加、编辑用户标签

基本信息

Path: /adminapi/user/user_label/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 添加为0 修改为标签ID
label_name text 是 标签 标签名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除用户标签

基本信息

Path: /adminapi/user/user_label/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 标签ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取标签分类(分页)

基本信息

Path: /adminapi/user/user_label_cate

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 分页
limit 否 截取条数
name 否 分类名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ countnumber非必须

获取标签分类(全部)

基本信息

Path: /adminapi/user/user_label_cate/all

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ pidnumber非必须
├─ owner_idnumber非必须
├─ namestring非必须
├─ sortnumber非必须
├─ typenumber非必须
├─ otherstring非必须
├─ add_timenumber非必须

获取用户标签分类创建表单

基本信息

Path: /adminapi/user/user_label_cate/create

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

保存用户标签分类

基本信息

Path: /adminapi/user/user_label_cate

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 111 分类名称
sort text 是 0 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取用户标签分类编辑表单

基本信息

Path: /adminapi/user/user_label_cate/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑用户标签分类

基本信息

Path: /adminapi/user_label_cate/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分类名称
sort text 是 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除用户标签分类

基本信息

Path: /adminapi/user/user_label_cate/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取用户标签

基本信息

Path: /adminapi/user/label/:uid

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

路径参数

参数名称 示例 备注
uid 用户uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须分类名
├─ labelobject []必须标签列表

item 类型: object

├─ idnumber必须标签id
├─ label_catenumber必须
├─ label_namestring必须标签名
├─ disabledboolean必须是否已经拥有标签

保存和取消用户标签

基本信息

Path: /adminapi/user/label/:uid

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

路径参数

参数名称 示例 备注
uid

Body

参数名称 参数类型 是否必须 示例 备注
label_ids text 是 选中用户标签id
un_label_ids text 是 取消用户标签id

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
statusnumber非必须

用户->用户等级

等级列表

基本信息

Path: /adminapi/user/user_level/vip_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 10 每页条数
title 否 青铜会员 等级名称
is_show 否 0-否 1-是 是否显示

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mer_idnumber必须
├─ namestring必须
├─ moneystring必须
├─ valid_datenumber必须
├─ is_forevernumber必须
├─ is_paynumber必须
├─ is_shownumber必须
├─ gradenumber必须
├─ discountnumber必须
├─ imagestring必须
├─ iconstring必须
├─ explainstring必须
├─ add_timestring必须
├─ is_delnumber必须
├─ exp_numnumber必须
├─ countnumber非必须

创建等级表单

基本信息

Path: /adminapi/user/user_level/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 等级id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ colobject必须
├─ spannumber非必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ minnumber非必须
├─ precisionnumber非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

会员等级添加或者修改

基本信息

Path: /adminapi/user/user_level

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 否 0 修改的等级id 添加时为0
name text 是 黄金会员 会员名称
is_forever text 是 0-否 1-是 是否为永久会员
money text 是 10.00 购买金额
is_pay text 是 1-购买 0-不购买 是否购买
valid_date text 是 10 有效时间(天)
grade text 是 2 等级
discount text 是 98.00 折扣
icon text 否 http://datong.crmeb.net/public/uploads/attach/2019/03/28/5c9ccca8bc1e0.png 会员图标
image text 否 http://datong.crmeb.net/public/uploads/attach/2019/03/28/5c9ccca8cd632.jpg 会员卡背景
is_show text 否 1 是否显示 1-*显示 0-隐藏
explain text 否 测试等级 说明

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除会员等级(假删)

基本信息

Path: /adminapi/user/user_level/delete/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 等级id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须状态 400 =错误,200 = 正确
msgstring非必须提示

设置等级的显示和隐藏

基本信息

Path: /adminapi/user/user_level/set_show/:id/:is_show

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 等级id
is_show 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=成功
msgstring非必须

等级列表快速编辑

基本信息

Path: /adminapi/user/user_level/set_value/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 等级id

Body

参数名称 参数类型 是否必须 示例 备注
field text 是 name name-会员名称 grade-等级 discount-折扣
value text 是 钻石会员 field对应的值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=成功
msgstring非必须提示

等级任务列表(已废弃)

基本信息

Path: /adminapi/user/user_level/task/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 2 等级id

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 10 每页条数
name 否 累计签到20天 任务名称
is_show 否 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ idinteger非必须任务id
├─ namestring非必须任务名称
├─ real_namestring非必须配置原名
├─ task_typestring非必须任务类型
├─ numberstring非必须限定数
├─ level_idinteger非必须等级id
├─ sortinteger非必须排序
├─ is_showinteger非必须是否显示
├─ is_mustinteger非必须是否务必达成任务,1务必达成,0=满足其一
├─ illustratestring非必须任务说明
├─ add_timestring非必须新增时间
├─ level_namestring非必须等级名称

快速编辑等级任务(已废弃)

基本信息

Path: /adminapi/user/user_level/set_task/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 任务id

Body

参数名称 参数类型 是否必须 示例 备注
field text 是 sort 排序
value text 是 4 field对应的值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=成功
msgstring非必须提示

设置等级任务的显示和隐藏(已废弃)

基本信息

Path: /adminapi/user/user_level/set_task_show/:id/:is_show

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 任务id
is_show 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400=错误,200=成功
msgstring非必须提示

设置任务是否务必达成(已废弃)

基本信息

Path: /adminapi/user/user_level/set_task_must/:id/:is_must

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 任务id
is_must 1 是否务必达成 1=务必达成,0=满足其一

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须状态 400 =错误,200 = 正确
msgstring非必须提示

生成任务表单(已废弃)

基本信息

Path: /adminapi/user/user_level/create_task

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 任务id
level_id 否 1 等级id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ lablestring非必须
├─ valuestring非必须
├─ validatestring []非必须

item 类型: string

├─ 非必须
├─ colobject非必须
├─ spanstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

保存或修改任务(已废弃)

基本信息

Path: /adminapi/user/user_level/save_task

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 否 1 任务id 修改时必需
level_id text 是 1 等级id
task_type text 是 SatisfactionIntegral 任务类型
number text 是 200 限定数
is_show text 是 1 1-显示 0-隐藏
sort text 是 5 排序
is_must text 是 1 是否务必达成任务,1务必达成,0=满足其一
illustrate text 是 初级任务 任务说明

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 = 正确
msgstring非必须提示

等级详情(已废弃)

基本信息

Path: /adminapi/user/user_level/read/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idinteger非必须等级id
├─ mer_idinteger非必须商户id
├─ namestring非必须等级名称
├─ moneynumber非必须购买金额
├─ valid_dateinteger非必须有效时间
├─ is_foreverinteger非必须是否为永久会员 1-是 0-否
├─ is_payinteger非必须是否购买,1=购买,0=不购买
├─ is_showinteger非必须是否显示 1=显示,0=隐藏
├─ gradeinteger非必须会员等级
├─ discountnumber非必须享受折扣
├─ imagestring非必须会员卡背景
├─ iconstring非必须会员图标
├─ explainstring非必须说明
├─ add_timestring非必须添加时间
├─ is_delinteger非必须是否删除.1=删除,0=未删除

删除任务(已废弃)

基本信息

Path: /adminapi/user/user_level/delete_task/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 任务id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户->付费会员->会员类型

会员卡类型编辑

基本信息

Path: /adminapi/user/member_ship/save/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
pre_price 是 优惠价
price 是 原价
vip_day 是 有限期(天)
type 是 month free quarter year ever 会员卡类型
sort 是 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

会员类型列表

基本信息

Path: /adminapi/user/member/ship

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ typestring必须
├─ titlestring必须
├─ vip_daynumber必须
├─ pricestring必须
├─ pre_pricestring必须
├─ sortnumber必须
├─ is_delnumber必须
├─ add_timenumber必须
├─ countnumber非必须

会员类型启用|禁用

基本信息

Path: /adminapi/user/member_ship/set_ship_status

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 会员类型id
is_del 是 是否删除

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户->付费会员->会员权益

会员权益

基本信息

Path: /adminapi/user/member/right

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ right_typestring必须
├─ titlestring必须
├─ show_titlestring必须
├─ imagestring必须
├─ explainstring必须
├─ numbernumber必须
├─ sortnumber必须
├─ statusnumber必须
├─ add_timenumber必须
├─ countnumber非必须

修改会员权益

基本信息

Path: /adminapi/user/member_right/save/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
title 是 名称
show_title 是 展示名称
image 是 图标
right_type 是 权益类型
explain 是 简介
number 是 倍数
sort 是 排序
status 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户->付费会员->会员协议

获取会员协议

基本信息

Path: /adminapi/user/member/agreement

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ typenumber非必须
├─ titlestring非必须
├─ contentstring非必须
├─ sortnumber非必须
├─ statusnumber非必须
├─ add_timenumber非必须

设置会员协议

基本信息

Path: /adminapi/user/member_agreement/save/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
title 是 标题
content 是 内容
status 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户->付费会员->卡密会员

批次卡列表

基本信息

Path: /adminapi/adminapi/user/member_batch/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
title 否 第一批次 批次卡名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须
├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ titlestring必须名称
├─ total_numnumber必须卡数量
├─ use_start_timestring必须
├─ use_end_timestring必须
├─ use_daynumber必须体验天数
├─ use_numnumber必须已经领取张数
├─ statusnumber必须状态
├─ sortnumber必须
├─ qrcodestring必须二维码
├─ remarkstring必须备注
├─ add_timestring必须
├─ countnumber必须

生成批次卡

基本信息

Path: /adminapi/adminapi/member_batch/save/0

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
title 是 第一批次卡 批次名称
use_day 是 体验天数 10
total_num 是 100 生成卡数量
remark 否 这是生成的第一批卡 备注
status 否 批次状态 0:禁用,1:启用

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

会员卡导出

基本信息

Path: /adminapi/adminapi/export/memberCard/45

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring []必须

item 类型: string

├─ 非必须

列表操作(启用,名称修改)

基本信息

Path: /adminapi/adminapi/member_batch/set_value/34

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
field 是 title 修改key
value 是 把第一次变为第二次 修改值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

会员卡列表

基本信息

Path: /adminapi/adminapi/user/member_card/index/:card_batch_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
card_batch_id

Query

参数名称 是否必须 示例 备注
page 否 1 页数
limit 否 20 条数
card_number 否 卡号
phone 否 领卡人手机号
is_use 否 1 是否领取 0:未领取,1:已领取

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ card_batch_idnumber必须
├─ card_numberstring必须
├─ card_passwordstring必须
├─ use_uidnumber必须
├─ use_timenumber必须
├─ statusnumber必须
├─ usernamestring必须
├─ phonestring必须
├─ countnumber非必须

修改会员卡状态

基本信息

Path: /adminapi/user/member_card/set_status

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
card_id 是 会员卡id
status 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

会员卡列表单字段修改

基本信息

Path: /adminapi/user/member_batch/set_value/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
field 是 字段
value 是 值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

兑换会员卡二维码

基本信息

Path: /adminapi/user/member_scan

Method: GET

接口描述:

请求参数

用户->付费会员->会员记录

会员卡记录

基本信息

Path: /adminapi/user/member/record

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
phone 否 用户电话
member_type 否 会员卡类型

分销->分销设置

获取配置表单

基本信息

Path: /adminapi/setting/config/edit_basics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
tab_id 是 1 配置分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber必须
├─ titlestring必须
├─ infostring必须
├─ colobject必须
├─ spannumber非必须
├─ propsobject必须
├─ controlobject []非必须

item 类型: object

├─ valuenumber非必须
├─ ruleobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuearray,number必须
├─ titlestring必须
├─ infostring必须
├─ colobject必须
├─ spannumber非必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ rowsnumber非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ optionsobject []必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ controlobject []非必须

item 类型: object

├─ valuenumber非必须
├─ ruleobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ valuestring非必须
├─ titlestring非必须
├─ infostring非必须
├─ colobject非必须
├─ spannumber非必须
├─ propsobject非必须
├─ typestring非必须
├─ placeholderstring非必须
├─ optionsobject []必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

保存配置

基本信息

Path: /adminapi/setting/config/save_basics

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

分销->分销员管理

分销员列表头部统计

基本信息

Path: /adminapi/agent/statistics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 否 时间选择
nickname 否 用户昵称/id/手机号码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ resobject []非必须

item 类型: object

├─ namestring必须
├─ countnumber必须
├─ classNamestring必须
├─ colnumber必须

分销员列表

基本信息

Path: /adminapi/agent/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
nickname 否 用户昵称/用户id/手机号码
data 否 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber必须
├─ real_namestring必须
├─ birthdaynumber必须
├─ card_idstring必须
├─ markstring必须
├─ partner_idnumber必须
├─ group_idnumber必须
├─ nicknamestring必须
├─ avatarstring必须
├─ phonestring必须
├─ add_timenumber必须
├─ last_timenumber必须
├─ now_moneystring必须
├─ brokerage_pricestring必须
├─ integralnumber必须
├─ expstring必须
├─ sign_numnumber必须
├─ statusnumber必须
├─ levelnumber必须
├─ spread_opennumber必须
├─ spread_uidnumber必须
├─ spread_timenumber必须
├─ user_typestring必须
├─ is_promoternumber必须
├─ pay_countnumber必须
├─ spread_countnumber必须
├─ addresstring必须
├─ adminidnumber必须
├─ login_typestring必须
├─ record_phonestring必须
├─ is_money_levelnumber必须
├─ is_ever_levelnumber必须
├─ overdue_timenumber必须
├─ uniqidstring必须
├─ headimgurlstring必须
├─ extract_count_pricenumber必须
├─ extract_count_numnumber必须
├─ spread_namestring必须
├─ order_pricenumber必须
├─ order_countnumber必须
├─ broken_commissionstring必须
├─ brokerage_moneynumber必须
├─ new_moneystring必须

分销员导出

基本信息

Path: /adminapi/export/userAgent

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
nickname 否 用户昵称/用户id/手机号码
data 否 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

推广人列表

基本信息

Path: /adminapi/agent/stair

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
uid 否 用户id
data 否 时间选择
nickname 否 用户昵称/用户id/手机号码
type 否 用户类型 1-一级推广人 2-二级推广人

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber必须
├─ real_namestring必须
├─ birthdaynumber必须
├─ card_idstring必须
├─ markstring必须
├─ partner_idnumber必须
├─ group_idnumber必须
├─ nicknamestring必须
├─ avatarstring必须
├─ phonestring必须
├─ add_timestring必须
├─ last_timenumber必须
├─ now_moneystring必须
├─ brokerage_pricestring必须
├─ integralnumber必须
├─ expstring必须
├─ sign_numnumber必须
├─ statusnumber必须
├─ levelnumber必须
├─ spread_opennumber必须
├─ spread_uidnumber必须
├─ spread_timenumber必须
├─ user_typestring必须
├─ is_promoternumber必须
├─ pay_countnumber必须
├─ spread_countnumber必须
├─ addresstring必须
├─ adminidnumber必须
├─ login_typestring必须
├─ record_phonestring必须
├─ is_money_levelnumber必须
├─ is_ever_levelnumber必须
├─ overdue_timenumber必须
├─ uniqidstring必须
├─ orderobject []必须

item 类型: object

├─ order_pricestring必须
├─ order_countnumber必须
├─ uidnumber必须
├─ spreadCountobject []必须

item 类型: object

├─ spread_countnumber非必须
├─ spread_uidnumber非必须
├─ spreadUserobject必须
├─ uidnumber非必须
├─ phonestring非必须
├─ nicknamestring非必须
├─ order_countnumber必须
├─ promoter_namestring必须
├─ countnumber非必须

推广人列表头部

基本信息

Path: /adminapi/agent/stair/statistics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uid 否 用户id
data 否 时间选择
nickname 否 用户昵称
type 否 用户类型 1-一级推广人 2-二级推广人

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ resobject []非必须

item 类型: object

├─ colstring非必须
├─ countstring非必须
├─ namestring非必须

推广订单列表

基本信息

Path: /adminapi/agent/stair/order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
uid 否 用户id
data 否 时间选择
order_id 否 订单号
type 否 订单类型 1-一级推广人订单 2-二级推广人订单

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ order_idstring必须
├─ trade_nostring必须
├─ uidnumber必须
├─ real_namestring必须
├─ user_phonestring必须
├─ user_addressstring必须
├─ cart_idstring []必须

item 类型: string

├─ 非必须
├─ freight_pricestring必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ total_postagestring必须
├─ pay_pricestring必须
├─ pay_postagestring必须
├─ deduction_pricestring必须
├─ coupon_idnumber必须
├─ coupon_pricestring必须
├─ paidnumber必须
├─ pay_timenumber,null必须
├─ pay_typestring必须
├─ add_timenumber必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ refund_reason_wap_imgnull,string必须
├─ refund_reason_wap_explainnull,string必须
├─ refund_reason_timenull,number必须
├─ refund_reason_wapnull,string必须
├─ refund_reasonnull必须
├─ refund_pricestring必须
├─ delivery_namenull必须
├─ delivery_codestring必须
├─ delivery_typestring,null必须
├─ delivery_idnull必须
├─ fictitious_contentstring必须
├─ delivery_uidnumber必须
├─ gain_integralstring必须
├─ use_integralstring必须
├─ back_integralnull,string必须
├─ markstring必须
├─ is_delnumber必须
├─ uniquestring必须
├─ remarknull必须
├─ mer_idnumber必须
├─ is_mer_checknumber必须
├─ combination_idnumber必须
├─ pink_idnumber必须
├─ coststring必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ verify_codestring必须
├─ store_idnumber必须
├─ shipping_typenumber必须
├─ clerk_idnumber必须
├─ is_channelnumber必须
├─ is_remindnumber必须
├─ is_system_delnumber必须
├─ channel_typestring必须
├─ provincestring必须
├─ express_dumpstring必须
├─ user_infostring必须
├─ avatarstring必须
├─ spread_infostring必须
├─ brokerage_pricestring,number必须
├─ _pay_timestring必须
├─ _add_timestring必须
├─ take_timestring必须
├─ countnumber非必须

推广订单列表头部

基本信息

Path: /adminapi/agent/stair/statistics_1576892465988

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uid 否 用户id
data 否 时间选择
order_id 否 订单号
type 否 订单类型 1-一级推广人订单 2-二级推广人订单

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ resobject []非必须

item 类型: object

├─ colstring非必须
├─ countstring非必须
├─ namestring非必须

查看公众号推广二维码

基本信息

Path: /adminapi/agent/look_code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uid 是 用户id
action 是 wechant_code

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ code_srcstring非必须二维码链接

查看小程序推广二维码

基本信息

Path: /adminapi/agent/look_xcx_code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uid 是 用户id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ code_srcstring非必须二维码链接

查看h5推广二维码

基本信息

Path: /adminapi/agent/look_h5_code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uid 是 1 uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ code_srcstring非必须

清除上级推广人

基本信息

Path: /adminapi/agent/stair/delete_spread/:uid

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
uid 1 分销员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改上级用户

基本信息

Path: /adminapi/agent/spread

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
uid text 是 当前用户uid
spread_uid text 是 推广人uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

取消推广资格

基本信息

Path: /adminapi/agent/stair/delete_system_spread/:uid

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
uid 1 用户uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

客服->客服列表

客服列表

基本信息

Path: /adminapi/app/wechat/kefu

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ avatarstring必须
├─ wx_namestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ phonestring必须
├─ nicknamestring必须
├─ countnumber非必须

添加客服选择用户

基本信息

Path: /adminapi/app/wechat/kefu/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
nickname 否 微信用户名称
data 否 时间选择
type 是 wechat 用户类型选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ nicknamestring必须
├─ uidnumber必须
├─ headimgurlstring必须
├─ subscribenumber必须
├─ provincestring必须
├─ countrystring必须
├─ citystring必须
├─ sexnumber必须
├─ user_typestring必须
├─ countnumber非必须

添加客服表单

基本信息

Path: /adminapi/app/wechat/kefu/add

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ srcKeystring非必须
├─ placeholderstring非必须
├─ trueValuenumber非必须
├─ falseValuenumber非必须
├─ slotobject非必须
├─ openstring非必须
├─ closestring非必须
├─ sizestring非必须
├─ colobject必须
├─ spannumber非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ controlobject []非必须

item 类型: object

├─ valuenumber非必须
├─ ruleobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber必须
├─ titlestring必须
├─ propsobject必须
├─ trueValuenumber非必须
├─ falseValuenumber非必须
├─ slotobject非必须
├─ openstring非必须
├─ closestring非必须
├─ sizestring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加客服

基本信息

Path: /adminapi/app/wechat/kefu

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
iamge text 是 选择用户图像
uid text 是 uid
avatar text 是 图像
customer text 是 订单管理状态
notify text 是 订单通知
phone text 是 手机号
account text 是 帐号
password text 是 密码
true_password text 是 确认密码
nickname text 是 名称
status text 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑客服表单

基本信息

Path: /adminapi/app/wechat/kefu/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 客服id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ placeholderstring非必须
├─ trueValuenumber非必须
├─ falseValuenumber非必须
├─ slotobject非必须
├─ openstring非必须
├─ closestring非必须
├─ sizestring非必须
├─ colobject必须
├─ spannumber非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ controlobject []非必须

item 类型: object

├─ valuenumber非必须
├─ ruleobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber必须
├─ titlestring必须
├─ propsobject必须
├─ trueValuenumber非必须
├─ falseValuenumber非必须
├─ slotobject非必须
├─ openstring非必须
├─ closestring非必须
├─ sizestring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑客服

基本信息

Path: /adminapi/app/wechat/kefu/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 客服id

Body

参数名称 参数类型 是否必须 示例 备注
avatar text 是 客服头像
nickname text 是 客服名称
status text 是 状态 1-显示 0-隐藏
notify text 是 订单通知1开启0关闭
customer text 是 是否展示统计管理
account text 是 帐号
phone text 是 手机号
password text 是 密码
true_password text 是 确认密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除客服

基本信息

Path: /adminapi/app/wechat/kefu/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 客服id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

聊天记录

基本信息

Path: /adminapi/app/wechat/kefu/record/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 客服id

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ uidstring非必须用户id
├─ nicknamestring非必须用户名称
├─ headimgurlstring非必须用户头像

查看对话

基本信息

Path: /adminapi/app/wechat/kefu/chat_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
uid 是 客服uid
to_uid 是 接收用户id
id 是 客服id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ nicknamestring非必须用户名称
├─ avatarstring非必须用户头像
├─ msnstring非必须消息内容
├─ add_timestring非必须发送时间

修改状态

基本信息

Path: /adminapi/app/wechat/kefu/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 客服id
status 1 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

登录客服平台

基本信息

Path: /adminapi/app/wechat/kefu/login/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须授权token
├─ exp_timenumber非必须过期时间
├─ kefuInfoobject非必须
├─ idnumber非必须
├─ uidnumber非必须关联uid
├─ accountstring非必须客服账号
├─ avatarstring非必须客服头像
├─ nicknamestring非必须客服昵称
├─ phonestring非必须客服手机号

客服->客服话术

话术列表

基本信息

Path: /adminapi/app/wechat/speechcraft

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 页码
limit 否 展示条数
cate_id 否 话术分类
title 是 标题
message 是 内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ kefu_idnumber必须
├─ cate_idnumber必须
├─ titlestring必须
├─ messagestring必须
├─ sortnumber必须
├─ add_timestring必须
├─ countnumber非必须

添加话术表单

基本信息

Path: /adminapi/app/wechat/speechcraft/create

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 授权token

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ typestring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加话术

基本信息

Path: /adminapi/app/wechat/speechcraft

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
cate_id text 是 分类id
title text 是 标题
message text 是 话术内容
sort text 是 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑话术表单

基本信息

Path: /adminapi/app/wechat/speechcraft/:id/edit

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 授权token

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑话术

基本信息

Path: /adminapi/app/wechat/speechcraft/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
cate_id text 是 分类id
title text 是 标题
message text 是 话术内容
sort text 是 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除话术

基本信息

Path: /adminapi/app/wechat/speechcraft/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取话术信息

基本信息

Path: /adminapi/app/wechat/speechcraft/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ kefu_idnumber非必须
├─ cate_idnumber非必须
├─ titlestring非必须
├─ messagestring非必须
├─ sortnumber非必须
├─ add_timestring非必须

获取话术分类

基本信息

Path: /adminapi/app/wechat/speechcraftcate

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
name 是 分类名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ owner_idnumber必须
├─ namestring必须
├─ sortnumber必须
├─ typenumber必须
├─ otherstring必须
├─ add_timenumber必须
├─ countnumber非必须

添加话术分类表单

基本信息

Path: /adminapi/app/wechat/speechcraftcate/create

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加话术分类

基本信息

Path: /adminapi/app/wechat/speechcraftcate

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分类名
sort text 是 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改话术分类表单

基本信息

Path: /adminapi/app/wechat/speechcraftcate/:id/edit

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

路径参数

参数名称 示例 备注
id 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改话术分类

基本信息

Path: /adminapi/app/wechat/speechcraftcate/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 分类id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分类名称
sort text 是 分类排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除话术分类

基本信息

Path: /adminapi/app/wechat/speechcraftcate/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

路径参数

参数名称 示例 备注
id 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

客服->用户留言

获取客服反馈列表

基本信息

Path: /adminapi/app/feedback

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
time 否 时间搜索
title 否 用户昵称,电话,留言内容搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ rela_namestring必须
├─ phonestring必须
├─ contentstring必须
├─ makestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ countnumber非必须

反馈备注表单

基本信息

Path: /adminapi/app/feedback/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ valuestring非必须
├─ titlestring非必须
├─ colobject非必须
├─ spannumber非必须
├─ propsobject非必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

反馈备注

基本信息

Path: /adminapi/app/feedback/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
make text 是 备注内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除反馈

基本信息

Path: /adminapi/app/feedback/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

营销->优惠券->优惠券列表

列表(已废弃)

基本信息

Path: /adminapi/marketing/coupon/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
status 否 1-开启 0-关闭
title 否 优惠券名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须优惠券名称
├─ integralnumber必须兑换消耗积分值
├─ coupon_pricestring必须兑换的优惠券面值
├─ use_min_pricestring必须最低消费多少金额可用优惠券
├─ coupon_timenumber必须优惠券有效期限
├─ sortnumber必须排序
├─ statusnumber必须状态
├─ add_timenumber必须兑换项目添加时间
├─ is_delnumber必须是否删除
├─ product_idstring必须所属商品id
├─ category_idnumber必须分类id
├─ typestring必须优惠券类型

新增表单(已废弃)

基本信息

Path: /adminapi/marketing/coupon/create/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 1 0通用卷 默认,1品类卷,2商品卷

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

新增(已废弃)

基本信息

Path: /adminapi/marketing/coupon/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 优惠券名称
coupon_price text 是 优惠券面值
use_min_price text 是 优惠券最低消费
coupon_time text 是 优惠券有效期限
sort text 是 排序
status text 是 状态
product_id text 否 商品卷商品ID
category_id text 否 分类卷分类ID
type text 是 优惠卷类型

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

编辑表单(已废弃)

基本信息

Path: /adminapi/marketing/coupon/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 优惠券id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

编辑(已废弃)

基本信息

Path: /adminapi/marketing/coupon/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 优惠券id

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 优惠券名称
coupon_price text 是 优惠券面值
use_min_price text 是 优惠券最低消费
coupon_time text 是 优惠券有效期限
sort text 是 排序
status text 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除(已废弃)

基本信息

Path: /adminapi/marketing/coupon/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

立即失效(已废弃)

基本信息

Path: /adminapi/marketing/coupon/status/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 优惠券id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

发布优惠券表单(已废弃)

基本信息

Path: /adminapi/marketing/coupon/issue/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 优惠券id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

发布优惠券(已废弃)

基本信息

Path: /adminapi/marketing/coupon/issue/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 优惠券id

Body

参数名称 参数类型 是否必须 示例 备注
range_date text 是 ['',''] 领取时间
count text 是 100 发布数量
status text 是 1 状态 1 正常 0 未开启 -1 已无效
is_permanent text 是 1 是否限量 1-是 0-否

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

优惠券列表

基本信息

Path: /adminapi/marketing/coupon/released

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
status 否 状态 1 正常 0 未开启 -1 已无效
coupon_title 否 优惠券名称
receive_type 否 领取方式
type 否 优惠券类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ cidnull必须
├─ coupon_titlestring必须
├─ start_timenumber必须
├─ end_timenumber必须
├─ total_countnumber必须
├─ remain_countnumber必须
├─ is_permanentnumber必须
├─ statusnumber必须
├─ is_give_subscribenumber必须
├─ is_full_givenumber必须
├─ full_reductionstring必须
├─ is_delnumber必须
├─ add_timenumber必须
├─ titlestring必须
├─ integralnumber必须
├─ coupon_pricestring必须
├─ use_min_pricestring必须
├─ coupon_timenumber必须
├─ product_idstring必须
├─ category_idnumber必须
├─ typenumber必须
├─ receive_typenumber必须
├─ start_use_timenumber必须
├─ end_use_timenumber必须
├─ sortnumber必须
├─ countnumber非必须

添加优惠券

基本信息

Path: /adminapi/marketing/coupon/save_coupon

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
coupon_title 是 优惠券名称
coupon_price 是 面值
use_min_price 是 使用门槛
coupon_time 是 使用时间(天数)
start_use_time 是 使用开始时间
end_use_time 是 使用结束时间
start_time 是 领取开始时间
end_time 是 领取结束时间
receive_type 是 发送方式
is_permanent 是 是否限量
total_count 是 发布数量
product_id 是 适用商品id
category_id 是 适用分类id
type 是 优惠券类型
sort 是 排序
status 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

一键复制优惠券

基本信息

Path: /adminapi/marketing/coupon/copy/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ cidnull非必须
├─ coupon_titlestring非必须
├─ start_timenumber非必须
├─ end_timenumber非必须
├─ total_countnumber非必须
├─ remain_countnumber非必须
├─ is_permanentnumber非必须
├─ statusnumber非必须
├─ is_give_subscribenumber非必须
├─ is_full_givenumber非必须
├─ full_reductionstring非必须
├─ is_delnumber非必须
├─ add_timenumber非必须
├─ titlestring非必须
├─ integralnumber非必须
├─ coupon_pricestring非必须
├─ use_min_pricestring非必须
├─ coupon_timenumber非必须
├─ product_idstring非必须
├─ category_idnumber非必须
├─ typenumber非必须
├─ receive_typenumber非必须
├─ start_use_timenumber非必须
├─ end_use_timenumber非必须
├─ sortnumber非必须

修改优惠券状态

基本信息

Path: /adminapi/marketing/coupon/status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 优惠券id
status 0 1

Body

参数名称 参数类型 是否必须 示例 备注
status text 是 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

某个优惠券领取记录

基本信息

Path: /adminapi/marketing/coupon/released/issue_log/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 已发布优惠券id

Query

参数名称 是否必须 示例 备注
page 否
limit 否

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber非必须
├─ issue_coupon_idnumber非必须
├─ add_timestring非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ countnumber非必须

删除优惠券

基本信息

Path: /adminapi/marketing/coupon/released/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 优惠券id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

发送优惠券列表

基本信息

Path: /adminapi/marketing/coupon/grant

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
status 否 1 状态 1-启用 0-禁用
title 否 优惠券名称
is_del 否 0 是否删除 1-是 0-否

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ titlestring非必须优惠券名称
├─ coupon_pricestring非必须优惠券面值
├─ use_min_pricestring非必须优惠券最低消费
├─ coupon_timestring非必须优惠券有效期限

发送优惠券

基本信息

Path: /adminapi/marketing/coupon/user/grant

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 22 优惠券id
uid text 是 1,2,3 用户id 拼接的字符串
all text 是 0 1
where text 是 条件

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

营销->优惠券->用户领取记录

用户领取优惠券记录

基本信息

Path: /adminapi/marketing/coupon/user

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
status 否 状态(0:未使用,1:已使用, 2:已过期)
coupon_title 否 优惠券名称
nickname 否 会员名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ cidnumber必须
├─ uidnumber必须
├─ coupon_titlestring必须
├─ coupon_pricestring必须
├─ use_min_pricestring必须
├─ add_timenumber必须
├─ start_timenumber必须
├─ end_timenumber必须
├─ use_timenumber必须
├─ typestring必须
├─ statusstring必须
├─ is_failnumber必须
├─ nicknamestring必须
├─ countnumber非必须

营销->砍价管理->砍价商品

修改状态

基本信息

Path: /adminapi/marketing/bargain/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1
status 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/marketing/bargain/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 砍价id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商品详情

基本信息

Path: /adminapi/marketing/bargain/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 砍价id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ product_idnumber非必须
├─ titlestring非必须
├─ imagestring非必须
├─ unit_namestring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ store_namenull非必须
├─ pricenumber非必须
├─ min_pricenumber非必须
├─ numnumber非必须
├─ bargain_max_pricenumber非必须
├─ bargain_min_pricenumber非必须
├─ bargain_numnumber非必须
├─ statusnumber非必须
├─ give_integralnumber非必须
├─ infostring非必须
├─ costnumber非必须
├─ sortnumber非必须
├─ is_hotnumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须
├─ is_postagenumber非必须
├─ postagenumber非必须
├─ rulestring非必须
├─ looknumber非必须
├─ sharenumber非必须
├─ temp_idnumber非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ people_numnumber非必须
├─ section_timestring []非必须

item 类型: string

├─ 非必须
├─ descriptionstring非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring非必须
├─ detailValuestring非必须
├─ attrHiddenboolean非必须
├─ detailstring []非必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string非必须
├─ detailobject非必须
├─ 规格string非必须
├─ picstring非必须
├─ pricenumber非必须
├─ min_pricenumber非必须
├─ costnumber非必须
├─ ot_pricenumber非必须
├─ stocknumber非必须
├─ quotanumber非必须
├─ bar_codestring非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ brokeragenumber非必须
├─ brokerage_twonumber非必须
├─ optboolean非必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring必须

开启砍价(已废弃)

基本信息

Path: /adminapi/marketing/goods_bargain

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 活动名称
info text 是 活动简介
store_name text 是 产品名称
unit_name text 是 单位名称
image text 是 活动图片
images text 是 产品轮播图
price text 是 砍价金额
min_price text 是 价商品最低价
bargain_max_price text 是 用户每次砍价的最大金额
bargain_min_price text 是 用户每次砍价的最小金额
bargain_num text 是 用户每次砍价的次数
stock text 是 库存
sales text 是 销量
sort text 是 排序
num text 是 每次购买的砍价产品数量
give_integral text 是 反多少积分
postage text 是 邮费
is_postage text 是 是否包邮
is_hot text 是 是否推荐
status text 是 砍价状态
product_id text 是 产品id
start_time text 是 开启时间
stop_time text 是 关闭时间

返回数据

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

新增/编辑/复制

基本信息

Path: /adminapi/marketing/bargain/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 砍价id 新建时为0

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 砍价活动名称
info text 是 砍价活动简介
unit_name text 是 件 单位
section_time text 是 [] 活动时间
image text 是 产品主图片
images text 是 [] 产品轮播图
bargain_max_price text 是 单次砍价的最大金额
bargain_min_price text 是 单次砍价的最小金额
bargain_num text 是 单次砍价的次数
sort text 是 排序
num text 是 单次允许购买数量
temp_id text 是 运费模版
is_hot text 是 热门推荐 1-是 0-否
status text 是 活动状态 1-是 0-否
product_id text 是 产品id
description text 是 内容
rule text 是 规格
attrs text 是 规格详情
items text 是 规格
copy text 是 是否是复制
people_num text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

砍价商品列表

基本信息

Path: /adminapi/marketing/bargain

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
status 否 状态 1-开启 0-关闭
store_name 否 产品名称或编号
start_status 否 活动状态进行中 未开始 已结束

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ titlestring必须
├─ imagestring必须
├─ unit_namestring必须
├─ stocknumber必须
├─ salesnumber必须
├─ imagesstring []必须

item 类型: string

├─ 非必须
├─ start_timenumber必须
├─ stop_timenumber必须
├─ store_namenull必须
├─ pricestring必须
├─ min_pricestring必须
├─ numnumber必须
├─ bargain_max_pricestring必须
├─ bargain_min_pricestring必须
├─ bargain_numnumber必须
├─ statusnumber必须
├─ give_integralstring必须
├─ infostring必须
├─ costnull必须
├─ sortnumber必须
├─ is_hotnumber必须
├─ is_delnumber必须
├─ add_timestring必须
├─ is_postagenumber必须
├─ postagenull必须
├─ rulestring必须
├─ looknumber必须
├─ sharenumber必须
├─ temp_idnumber必须
├─ weightstring必须
├─ volumestring必须
├─ quotanumber必须
├─ quota_shownumber必须
├─ people_numnumber必须
├─ count_people_allnumber必须
├─ count_people_helpnumber必须
├─ count_people_successnumber必须
├─ stop_statusnumber必须
├─ countnumber非必须

商铺砍价活动导出

基本信息

Path: /adminapi/export/storeBargain

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页数
limit 否 20 每页条数
status 否 状态
store_name 否 商铺名称
data 否 today 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

营销->砍价管理->砍价列表

砍价列表

基本信息

Path: /adminapi/marketing/bargain_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 砍价状态
data 否 时间
page 否 页数
limit 否 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ bargain_idnumber必须
├─ bargain_price_minstring必须
├─ bargain_pricestring必须
├─ pricestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ is_delnumber必须
├─ titlestring必须
├─ imagestring必须
├─ datatimestring必须
├─ people_numnumber必须
├─ avatarstring必须
├─ nicknamestring必须
├─ numnumber必须
├─ now_pricestring必须
├─ countnumber非必须

砍价详情

基本信息

Path: /adminapi/marketing/bargain_list_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 9 砍价id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber非必须
├─ pricestring非必须
├─ add_timestring非必须
├─ nicknamestring非必须
├─ avatarstring非必须

营销->拼团管理->拼团商品

拼团商品列表

基本信息

Path: /adminapi/marketing/combination

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
is_show 否 状态 1-开启 0-关闭
store_name 否 关键字 产品名称/产品id/拼团名称/拼团id
start_status 是 -1:已结束0未开始1进行中 活动状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ mer_idnumber必须
├─ imagestring必须
├─ imagesstring []必须

item 类型: string

├─ 非必须
├─ titlestring必须
├─ attrnull必须
├─ peoplenumber必须
├─ infostring必须
├─ pricestring必须
├─ sortnumber必须
├─ salesnumber必须
├─ stocknumber必须
├─ add_timestring必须
├─ is_hostnumber必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ combinationnumber必须
├─ mer_usenull必须
├─ is_postagenumber必须
├─ postagestring必须
├─ start_timenumber必须
├─ stop_timenumber必须
├─ effective_timenumber必须
├─ costnumber必须
├─ browsenumber必须
├─ unit_namestring必须
├─ temp_idnumber必须
├─ weightstring必须
├─ volumestring必须
├─ numnumber必须
├─ once_numnumber必须
├─ quotanumber必须
├─ quota_shownumber必须
├─ virtualnumber必须
├─ ot_pricestring必须
├─ product_pricestring必须
├─ count_peoplenumber必须
├─ count_people_allnumber必须
├─ count_people_pinknumber必须
├─ stop_statusnumber必须
├─ countnumber非必须

拼团商品详情

基本信息

Path: /adminapi/marketing/combination/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ product_idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ attrnull非必须
├─ peoplenumber非必须
├─ infostring非必须
├─ pricenumber非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ add_timestring非必须
├─ is_hostnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ combinationnumber非必须
├─ mer_usenull非必须
├─ is_postagenumber非必须
├─ postagenumber非必须
├─ effective_timenumber非必须
├─ costnumber非必须
├─ browsenumber非必须
├─ unit_namestring非必须
├─ temp_idnumber非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ numnumber非必须
├─ once_numnumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ virtualnumber非必须
├─ section_timestring []非必须

item 类型: string

├─ 非必须
├─ descriptionstring非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailValuestring必须
├─ attrHiddenboolean必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 颜色string非必须
├─ 尺码string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ quotanumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ _checkedboolean必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring非必须
├─ typenumber必须

添加/编辑/复制

基本信息

Path: /adminapi/marketing/combination/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 拼团id 新建时为0

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 产品id
title text 是 拼团名称
info text 是 拼团简介
unit_name text 是 单位
image text 是 产品主图片
images text 是 产品轮播图
section_time text 是 拼团时间
is_host text 是 热门推荐 1-是0-否
is_show text 是 状态 1-开启 0-关闭
num text 是 总购买数量
temp_id text 是 运费模板
effective_time text 是 拼团时效
people text 是 拼团人数
description text 是 内容
attrs text 是 规格详情
items text 是 规格
once_num text 是 一次购买数量
sort text 是 排序
copy text 是 是否复制
virtual text 是 虚拟成团比例

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商铺拼团导出

基本信息

Path: /adminapi/export/storeCombination

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
is_show 否 是否展示
store_name 否 商铺名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

修改拼团状态

基本信息

Path: /adminapi/marketing/combination/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 拼团id
status 1 状态 1-开启 0-状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/marketing/combination/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 拼团id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

开启拼团(已废弃)

基本信息

Path: /adminapi/marketing/goods_combination

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 标题
info text 是 简介
unit_name text 是 单位
image text 是 产品图片
images text 是 轮播图
effective_time text 是 拼团订单有效时间
postage text 是 邮费
people text 是 参团人数
price text 是 价格
sort text 是 排序
stock text 是 库存
sales text 是 销量
is_show text 是 产品状态
is_host text 是 推荐
is_postage text 是 否包邮

返回数据

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

导出(已废弃)

基本信息

Path: /adminapi/marketing/combination/export

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
is_show 是 状态 1-开启 0-关闭
store_name 是 关键字 产品名称/产品id/拼团名称/拼团id

返回数据

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

营销->拼团管理->拼团列表

拼团统计

基本信息

Path: /adminapi/marketing/combination/statistics

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ product_idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ attrnull非必须
├─ peoplenumber非必须
├─ infostring非必须
├─ pricenumber非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ add_timestring非必须
├─ is_hostnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ combinationnumber非必须
├─ mer_usenull非必须
├─ is_postagenumber非必须
├─ postagenumber非必须
├─ effective_timenumber非必须
├─ costnumber非必须
├─ browsenumber非必须
├─ unit_namestring非必须
├─ temp_idnumber非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ numnumber非必须
├─ once_numnumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ virtualnumber非必须
├─ section_timestring []非必须

item 类型: string

├─ 非必须
├─ descriptionstring非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailValuestring必须
├─ attrHiddenboolean必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 颜色string非必须
├─ 尺码string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ quotanumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ _checkedboolean必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring非必须
├─ typenumber必须

拼团列表

基本信息

Path: /adminapi/marketing/combination/combine/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 状态 1进行中2已完成3未完成
data 是 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ nicknamestring必须
├─ avatarstring必须
├─ order_idstring必须
├─ order_id_keynumber必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ cidnumber必须
├─ pidnumber必须
├─ peoplenumber必须
├─ pricestring必须
├─ add_timestring必须
├─ stop_timestring必须
├─ k_idnumber必须
├─ is_tplnumber必须
├─ is_refundnumber必须
├─ statusnumber必须
├─ is_virtualnumber必须
├─ titlestring必须
├─ count_peoplenumber必须
├─ countnumber非必须

拼团详情

基本信息

Path: /adminapi/marketing/combination/order_pink/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团列表id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ order_idstring非必须
├─ order_id_keynumber非必须
├─ total_numnumber非必须
├─ total_pricestring非必须
├─ cidnumber非必须
├─ pidnumber非必须
├─ peoplenumber非必须
├─ pricestring非必须
├─ add_timestring非必须
├─ stop_timestring非必须
├─ k_idnumber非必须
├─ is_tplnumber非必须
├─ is_refundnumber非必须
├─ statusnumber非必须
├─ is_virtualnumber非必须
├─ titlestring非必须

营销->秒杀管理->秒杀商品

秒杀商品列表

基本信息

Path: /adminapi/marketing/seckill

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
status 否 状态 1-开启 0-关闭
store_name 否 关键字 秒杀名称/秒杀id
start_status 是 -1:已结束0:未开始1:进行中 活动状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ imagestring必须
├─ imagesstring []必须

item 类型: string

├─ 非必须
├─ titlestring必须
├─ infostring必须
├─ pricestring必须
├─ coststring必须
├─ ot_pricestring必须
├─ give_integralstring必须
├─ sortnumber必须
├─ stocknumber必须
├─ salesnumber必须
├─ unit_namestring必须
├─ postagestring必须
├─ descriptionnull必须
├─ start_timestring必须
├─ stop_timestring必须
├─ add_timestring必须
├─ statusnumber必须
├─ is_postagenumber必须
├─ is_hotnumber必须
├─ is_delnumber必须
├─ numnumber必须
├─ is_shownumber必须
├─ time_idnumber必须
├─ temp_idnumber必须
├─ weightstring必须
├─ volumestring必须
├─ quotanumber必须
├─ quota_shownumber必须
├─ once_numnumber必须
├─ store_namestring必须
├─ start_namestring必须
├─ _stop_timestring必须
├─ stop_statusnumber必须
├─ countnumber非必须

秒杀时间段列表

基本信息

Path: /adminapi/marketing/seckill/time_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ timestring必须
├─ continuedstring必须
├─ slidearray,string必须

保存新增或编辑

基本信息

Path: /adminapi/marketing/seckill/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 秒杀id 新增时为0

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 产品id
title text 是 活动名称
info text 是 活动简介
unit_name text 是 单位
image text 是 商品主图片
images text 是 [] 商品轮播图
give_integral text 是 赠送积分
section_time text 是 [] 活动时间
is_hot text 是 热门推荐 1-是 0-否
status text 是 状态 1-开启 0-关闭
num text 是 限制总数
once_num text 是 单次都买次
time_id text 是 秒杀时间段
temp_id text 是 运费模版id
sort text 是 排序
description text 是 内容
attrs text 是 规格详情
items text 是 规格
copy text 是 是否复制

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

详情

基本信息

Path: /adminapi/marketing/seckill/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 秒杀id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ product_idnumber非必须
├─ imagestring非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ infostring非必须
├─ pricenumber非必须
├─ costnumber非必须
├─ ot_pricenumber非必须
├─ give_integralnumber非必须
├─ sortnumber非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ unit_namestring非必须
├─ postagenumber非必须
├─ descriptionstring非必须
├─ add_timestring非必须
├─ statusnumber非必须
├─ is_postagenumber非必须
├─ is_hotnumber非必须
├─ is_delnumber非必须
├─ numnumber非必须
├─ is_shownumber非必须
├─ time_idnumber非必须
├─ temp_idnumber非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ once_numnumber非必须
├─ section_timestring []非必须

item 类型: string

├─ 非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring非必须
├─ detailValuestring非必须
├─ attrHiddenboolean非必须
├─ detailstring []非必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string非必须
├─ detailobject非必须
├─ 规格string非必须
├─ picstring非必须
├─ pricenumber非必须
├─ costnumber非必须
├─ ot_pricenumber非必须
├─ stocknumber非必须
├─ quotanumber非必须
├─ bar_codestring非必须
├─ weightnumber非必须
├─ volumenumber非必须
├─ brokeragenumber非必须
├─ brokerage_twonumber非必须
├─ _checkedboolean非必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring非必须
├─ typenumber必须

获取商品规格-秒杀

基本信息

Path: /adminapi/product/product/attrs/:id/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 商品ID
type 1 1秒杀2砍价3拼团

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailValuestring必须
├─ attrHiddenboolean必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ attrsobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 大小string非必须
├─ 颜色string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring必须
├─ keystring必须

删除

基本信息

Path: /adminapi/marketing/seckill/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 秒杀id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改秒杀状态

基本信息

Path: /adminapi/marketing/seckill/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 秒杀id
status 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

秒杀商品导出

基本信息

Path: /adminapi/export/storeSeckill

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 状态
store_name 否 商铺名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须execl地址

导出(已废弃)

基本信息

Path: /adminapi/marketing/seckill/export

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 状态 1-开启 0-关闭
store_name 是 关键字 秒杀名称/秒杀id

返回数据

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

获取秒杀等详情(已废弃)

基本信息

Path: /adminapi/marketing/get_goods_field/:id?field=

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id?field= 商品id

Query

参数名称 是否必须 示例 备注
field 是 store_name,store_info,unit_name,image,slider_image,cost,stock,price,is_postage 查询字段

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ store_namestring非必须商品名称
├─ store_infostring非必须商品描述
├─ unit_namestring非必须单位
├─ imagestring非必须图片
├─ slider_imagestring非必须幻灯片
├─ coststring非必须成本价
├─ stocknumber非必须库存
├─ pricestring非必须价格
├─ is_postagenumber非必须是否包邮

开启秒杀(已废弃)

基本信息

Path: /adminapi/marketing/goods_seckill

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

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

营销->秒杀管理->秒杀配置

修改状态

基本信息

Path: /adminapi/setting/seckill_data/set_status/:id/:status

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 id
status 0 1

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/setting/seckill_data/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

添加表单

基本信息

Path: /adminapi/setting/seckill_data/create

Method: GET

接口描述:

请求参数

秒杀配置头部数据

基本信息

Path: /adminapi/setting/seckill_data/header

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 54 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ headerobject []非必须

item 类型: object

├─ keystring必须
├─ titlestring必须
├─ minWidthnumber必须
├─ typestring非必须
├─ slotstring必须
├─ fixedstring非必须

秒杀配置数据列表

基本信息

Path: /adminapi/setting/seckill_data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页
limit 是 20 每页条数
gid 是 54 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ gidnumber必须
├─ add_timenumber必须
├─ sortnumber必须
├─ statusnumber必须
├─ timestring必须
├─ continuedstring必须
├─ slidestring []必须

item 类型: string

├─ 非必须
├─ countnumber非必须
├─ typestring非必须

编辑表单

基本信息

Path: /adminapi/setting/seckill_data/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
gid 是 49 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

营销->积分管理->积分配置

保存配置

基本信息

Path: /adminapi/marketing/integral_config/save_basics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
integral_max_num 是 10 抵用上限
integral_ratio 是 2 积分抵用
order_give_integral 是 5 下单赠送积分

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取配置数据

基本信息

Path: /adminapi/marketing/integral_config/edit_basics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
tab_id 是 11 父类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring必须
├─ titlestring必须
├─ infostring必须
├─ colobject必须
├─ spannumber非必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

营销->积分管理->积分日志

积分日志列表

基本信息

Path: /adminapi/marketing/integral

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
start_time 否 2019-12-20 00:00:00 开始时间
end_time 否 2019-12-21 00:00:00 结束时间
nickname 否 用户昵称或用户id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ link_idstring必须
├─ pmnumber必须
├─ titlestring必须
├─ categorystring必须
├─ typestring必须
├─ numbernumber必须
├─ balancenumber必须
├─ markstring必须
├─ add_timestring必须
├─ statusnumber必须
├─ takenumber必须
├─ nicknamestring必须
├─ countnumber非必须

积分日志头部数据

基本信息

Path: /adminapi/marketing/integral/statistics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_time 否 开始时间
end_time 否 结束时间
nickname 否 用户昵称或id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ resobject []非必须

item 类型: object

├─ colnumber必须
├─ countnumber必须
├─ namestring必须

用户积分导出

基本信息

Path: /adminapi/export/userPoint

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_time 否 开始时间
end_time 否 结束时间
nikename 否 用户昵称会id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel 文件地址

积分日志导出(已废弃)

基本信息

Path: /adminapi/marketing/integral/export

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_time 否 开始时间
end_time 否 结束时间
nickname 否 用户昵称会id

返回数据

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

营销->积分管理->签到配置

修改状态

基本信息

Path: /adminapi/setting/sign_data/set_status/:id/:status

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 147 id
status 0 1

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/setting/sign_data/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 147 id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

标记表单

基本信息

Path: /adminapi/setting/sign_data/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
gid 是 55 分组id

添加表单

基本信息

Path: /adminapi/setting/sign_data/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 55 分组id

返回数据

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

签到配置头部数据

基本信息

Path: /adminapi/setting/sign_data/header

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 45 分组id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ headerobject []非必须

item 类型: object

├─ keystring必须
├─ titlestring必须
├─ minWidthnumber必须
├─ slotstring必须
├─ fixedstring非必须

签到配置数据列表

基本信息

Path: /adminapi/setting/sign_data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
limit 否 20 每页条数
gid 是 45 分组id
status 否 1 是否显示

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ gidnumber必须
├─ add_timenumber必须
├─ sortnumber必须
├─ statusnumber必须
├─ daystring必须
├─ sign_numstring必须
├─ ppstring []必须

item 类型: string

├─ 非必须
├─ llstring []必须

item 类型: string

├─ 非必须
├─ countnumber非必须
├─ typestring非必须

营销->积分管理->积分商品

积分商品列表

基本信息

Path: /adminapi/marketing/integral_product

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
integral_time 是
is_show 是
store_name 是
page 是
limit 是
start_status 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须编号
├─ imagestring必须主图
├─ product_idnumber必须商品ID
├─ imagesstring []必须轮播图

item 类型: string

├─ 非必须
├─ titlestring必须标题
├─ pricenumber必须价格
├─ sortnumber必须排序
├─ salesnumber必须销量
├─ unit_namestring必须单位
├─ stocknumber必须库存
├─ add_timestring必须添加时间
├─ is_hostnumber必须是否推荐
├─ is_shownumber必须是否显示
├─ is_delnumber必须是否删除
├─ numnumber必须购买总数
├─ quotanumber必须限量
├─ once_numnumber必须单词购买
├─ quota_shownumber必须限量显示
├─ countnumber非必须

积分商品订单列表

基本信息

Path: /adminapi/marketing/integral/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
status 是
pay_type 是
data 是
real_name 是
field_key 是
type 是
product_id 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ order_idstring非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ user_phonestring非必须
├─ user_addressstring非必须
├─ product_idnumber非必须
├─ imagestring非必须
├─ store_namestring非必须
├─ sukstring非必须
├─ total_numnumber非必须
├─ pricestring非必须
├─ total_pricestring非必须
├─ add_timestring非必须
├─ statusnumber非必须
├─ delivery_namestring非必须
├─ delivery_codestring非必须
├─ delivery_typestring非必须
├─ delivery_idstring非必须
├─ fictitious_contentstring非必须
├─ delivery_uidnumber非必须
├─ markstring非必须
├─ is_delnumber非必须
├─ remarkstring非必须
├─ mer_idnumber非必须
├─ is_mer_checknumber非必须
├─ is_remindnumber非必须
├─ is_system_delnumber非必须
├─ channel_typestring非必须
├─ provincestring非必须
├─ express_dumpstring非必须
├─ verify_codestring非必须
├─ nicknamestring非必须
├─ phonestring非必须
├─ spread_uidnumber非必须
├─ status_namestring非必须
├─ countnumber非必须
├─ batch_urlstring非必须

积分商品详情

基本信息

Path: /adminapi/marketing/integral/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ product_idnumber非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ pricenumber非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ unit_namestring非必须
├─ stocknumber非必须
├─ add_timestring非必须
├─ is_hostnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ numnumber非必须
├─ quotanumber非必须
├─ once_numnumber非必须
├─ quota_shownumber非必须
├─ descriptionstring非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailValuestring必须
├─ attrHiddenboolean必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 颜色string非必须
├─ 尺码string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ quotanumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ _checkedboolean必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring非必须
├─ typenumber必须

积分订单统计数据

基本信息

Path: /adminapi/marketing/integral/order/chart

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是
product_id 是
data 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusAllstring非必须
├─ unshippedstring非必须
├─ untakestring非必须
├─ completestring非必须

营销->预售管理->预售管理

预售商品列表

基本信息

Path: /adminapi/marketing/advance/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是
time_type 是
title 是
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ product_idnumber非必须
├─ imagestring非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ infostring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ sortnumber非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ unit_namestring非必须
├─ start_timestring非必须
├─ stop_timestring非必须
├─ add_timestring非必须
├─ statusnumber非必须
├─ is_delnumber非必须
├─ typenumber非必须
├─ depositstring非必须
├─ pay_start_timestring非必须
├─ pay_stop_timestring非必须
├─ deliver_timenumber非必须
├─ numnumber非必须
├─ temp_idnumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ once_numnumber非必须
├─ cate_idnull非必须
├─ countnumber非必须

预售商品详情

基本信息

Path: /adminapi/marketing/advance/info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ product_idnumber非必须
├─ imagestring非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ infostring非必须
├─ pricenumber非必须
├─ ot_pricenumber非必须
├─ sortnumber非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ unit_namestring非必须
├─ start_timestring非必须
├─ stop_timestring非必须
├─ add_timestring非必须
├─ statusnumber非必须
├─ is_delnumber非必须
├─ typenumber非必须
├─ depositstring非必须
├─ pay_start_timestring非必须
├─ pay_stop_timestring非必须
├─ deliver_timenumber非必须
├─ numnumber非必须
├─ temp_idnumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ once_numnumber非必须
├─ section_timestring []非必须

item 类型: string

├─ 非必须
├─ pay_timestring []非必须

item 类型: string

├─ 非必须
├─ descriptionstring非必须
├─ attrsobject非必须
├─ itemsobject []非必须

item 类型: object

├─ valuestring必须
├─ detailValuestring必须
├─ attrHiddenboolean必须
├─ detailstring []必须

item 类型: string

├─ 非必须
├─ valueobject []非必须

item 类型: object

├─ value1string必须
├─ value2string必须
├─ detailobject必须
├─ 颜色string非必须
├─ 尺码string非必须
├─ picstring必须
├─ pricenumber必须
├─ costnumber必须
├─ ot_pricenumber必须
├─ stocknumber必须
├─ quotanumber必须
├─ bar_codestring必须
├─ weightnumber必须
├─ volumenumber必须
├─ brokeragenumber必须
├─ brokerage_twonumber必须
├─ _checkedboolean必须
├─ headerobject []非必须

item 类型: object

├─ titlestring必须
├─ keystring必须
├─ alignstring必须
├─ minWidthnumber必须
├─ slotstring非必须
├─ typenumber必须

营销->直播管理->直播间管理

直播列表

基本信息

Path: /adminapi/live/room/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
kerword 否 张三 关键词
status 否 1 状态
page 否 1 页数
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ room_idnumber必须
├─ namestring必须
├─ cover_imgstring必须
├─ share_imgstring必须
├─ start_timestring必须
├─ end_timestring必须
├─ anchor_namestring必须
├─ anchor_wechatstring必须
├─ phonestring必须
├─ typenumber必须
├─ screen_typenumber必须
├─ close_likenumber必须
├─ close_goodsnumber必须
├─ close_commentnumber必须
├─ error_msgstring必须
├─ statusnumber必须
├─ live_statusnumber必须
├─ markstring必须
├─ replay_statusnumber必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ add_timestring必须

添加直播间

基本信息

Path: /adminapi/live/room/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
name 是 张三的直播间 直播间名称
cover_img 是 背景图地址
share_img 是 分享图地址
anchor_name 是 张三 主播名称
anchor_wechat 是 wx_dddddd 主播微信号
phone 是 13572809876 主播手机号
start_time 是 [10000000000,1000000000] 直播预计开始、结束时间
type 是 1 直播间类型 【1: 推流,0:手机直播】
screen_type 是 1 横屏、竖屏 【1:横屏,0:竖屏】
close_like 是 是否关闭点赞
close_goods 是 是否关闭货架
close_comment 是 是否关闭评论
sort 否 100 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring必须

直播间删除

基本信息

Path: /adminapi/live/room/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

直播间添加商品

基本信息

Path: /adminapi/live/room/add_goods

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
room_id 是 100 直播间列表主键id
goods_ids 是 [100,102,222] 直播商品列表主键ids

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring必须

直播间设置是否显示

基本信息

Path: /adminapi/live/room/set_show/:id/:is_show

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 100 直播间id
is_show 0 1

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

直播间详情

基本信息

Path: /adminapi/live/room/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 6 直播间id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ room_idnumber非必须
├─ namestring非必须
├─ cover_imgstring非必须
├─ share_imgstring非必须
├─ start_timestring非必须
├─ end_timestring非必须
├─ anchor_namestring非必须
├─ anchor_wechatstring非必须
├─ phonestring非必须
├─ typenumber非必须
├─ screen_typenumber非必须
├─ close_likenumber非必须
├─ close_goodsnumber非必须
├─ close_commentnumber非必须
├─ error_msgstring非必须
├─ statusnumber非必须
├─ live_statusnumber非必须
├─ markstring非必须
├─ replay_statusnumber非必须
├─ sortnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须

同步直播间状态

基本信息

Path: /adminapi/live/room/syncRoom

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

营销->直播管理->直播商品管理

直播商品列表

基本信息

Path: /adminapi/live/goods/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
kerword 否 张三 关键词搜索
status 否 0 1
page 否 1 页数
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ goods_idnumber必须
├─ audit_idnumber必须
├─ product_idnumber必须
├─ namestring必须
├─ cover_imgstring必须
├─ urlstring必须
├─ price_typenumber必须
├─ cost_pricestring必须
├─ pricestring必须
├─ price2string必须
├─ audit_statusnumber必须
├─ third_part_tagnumber必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ add_timestring必须
├─ productobject必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须

直播商品详情

基本信息

Path: /adminapi/adminapi/live/goods/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 2 直播商品id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ goods_idnumber非必须
├─ audit_idnumber非必须
├─ product_idnumber非必须
├─ namestring非必须
├─ cover_imgstring非必须
├─ urlstring非必须
├─ price_typenumber非必须
├─ cost_pricestring非必须
├─ pricestring非必须
├─ price2string非必须
├─ audit_statusnumber非必须
├─ third_part_tagnumber非必须
├─ sortnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须
├─ productobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须

直播商品删除

基本信息

Path: /adminapi/adminapi/live/goods/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 2 直播商品id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

生成直播商品(直播商品添加准备数据)

基本信息

Path: /adminapi/adminapi/live/goods/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
product_id 是 [59,60] 商品ids

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ imagestring必须
├─ store_namestring必须
├─ pricestring必须
├─ cost_pricestring必须
├─ stocknumber必须

直播商品添加

基本信息

Path: /adminapi/adminapi/live/goods/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
goods_info 是 [['product_id'=>1,'name'=>'name','cover_img'=>'iamge_url','price'=>'直播价','cost_price'=>'原价']]

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

直播商品设置是否显示

基本信息

Path: /adminapi/adminapi/live/goods/set_show/:id/:is_show

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 2 直播商品id
is_show 0 1

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

同步直播商品审核状态(未启用)

基本信息

Path: /adminapi/adminapi/live/goods/syncGoods

Method: GET

接口描述:

请求参数

返回数据

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

营销->直播管理->主播管理

主播列表

基本信息

Path: /adminapi/adminapi/live/anchor/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
kerword 否 张三
page 否 1 页面
limit 否 20 每页条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ cover_imgstring必须
├─ wechatstring必须
├─ phonestring必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ add_timestring必须

主播添加/修改保存数据

基本信息

Path: /adminapi/adminapi/live/anchor/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 否 1 添加表单传0
name 是 张三 主播昵称
wechat 是 zhangsan 主播微信号
phone 是 13609879876 主播手机号
cover_img 是 主播图像

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须

主播添加/修改获取表单

基本信息

Path: /adminapi/adminapi/live/anchor/add/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 添加id传0

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ maxlengthnumber非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

删除主播

基本信息

Path: /adminapi/adminapi/live/anchor/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 主播id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须

设置主播是否显示

基本信息

Path: /adminapi/adminapi/live/anchor/set_show/:id/:is_show

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id
is_show

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须

营销->九宫格抽奖->九宫格抽奖

抽奖列表

基本信息

Path: /adminapi/marketing/lottery/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_status 是
status 是
store_name 是
export 是
page 是
factor 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ descstring非必须
├─ imagestring非必须
├─ factornumber非必须
├─ factor_numnumber非必须
├─ attends_usernumber非必须
├─ user_levelnumber []非必须

item 类型: number

├─ 非必须
├─ user_labelstring []非必须

item 类型: string

├─ 非必须
├─ is_svipnumber非必须
├─ prize_numnumber非必须
├─ start_timestring非必须
├─ end_timestring非必须
├─ lottery_num_termnumber非必须
├─ lottery_numnumber非必须
├─ spread_numnumber非必须
├─ is_all_recordnumber非必须
├─ is_personal_recordnumber非必须
├─ is_contentnumber非必须
├─ contentstring非必须
├─ statusnumber非必须
├─ sortnumber非必须
├─ is_delnumber非必须
├─ add_timenumber非必须
├─ prizeobject []非必须

item 类型: object

├─ idnumber必须
├─ typenumber必须
├─ lottery_idnumber必须
├─ namestring必须
├─ promptstring必须
├─ imagestring必须
├─ chancenumber必须
├─ totalnumber必须
├─ coupon_idnumber必须
├─ product_idnumber必须
├─ uniquestring必须
├─ numnumber必须
├─ sortnumber必须
├─ statusnumber必须
├─ is_delnumber必须
├─ add_timenumber必须
├─ lottery_typestring非必须
├─ lottery_allnumber非必须
├─ lottery_peoplenumber非必须
├─ lottery_winnumber非必须
├─ lottery_statusstring非必须
├─ countnumber非必须

抽奖记录

基本信息

Path: /adminapi/marketing/lottery/record/list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

Query

参数名称 是否必须 示例 备注
keyword 是
page 是
limit 是
lottery_id 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ lottery_idnumber必须
├─ prize_idnumber必须
├─ typenumber必须
├─ is_receivenumber必须
├─ receive_timenumber必须
├─ receive_infostring []必须

item 类型: string

├─ 非必须
├─ is_delivernumber必须
├─ deliver_timenumber必须
├─ deliver_infostring []必须

item 类型: string

├─ 非必须
├─ add_timestring必须
├─ lotteryobject必须
├─ idnumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ descstring非必须
├─ imagestring非必须
├─ factornumber非必须
├─ factor_numnumber非必须
├─ attends_usernumber非必须
├─ user_levelnumber []非必须

item 类型: number

├─ 非必须
├─ user_labelstring []非必须

item 类型: string

├─ 非必须
├─ is_svipnumber非必须
├─ prize_numnumber非必须
├─ start_timenumber非必须
├─ end_timenumber非必须
├─ lottery_num_termnumber非必须
├─ lottery_numnumber非必须
├─ spread_numnumber非必须
├─ is_all_recordnumber非必须
├─ is_personal_recordnumber非必须
├─ is_contentnumber非必须
├─ contentstring非必须
├─ statusnumber非必须
├─ sortnumber非必须
├─ is_delnumber非必须
├─ add_timenumber非必须
├─ prizeobject必须
├─ idnumber非必须
├─ typenumber非必须
├─ lottery_idnumber非必须
├─ namestring非必须
├─ promptstring非必须
├─ imagestring非必须
├─ chancenumber非必须
├─ totalnumber非必须
├─ coupon_idnumber非必须
├─ product_idnumber非必须
├─ uniquestring非必须
├─ numnumber非必须
├─ sortnumber非必须
├─ statusnumber非必须
├─ is_delnumber非必须
├─ add_timenumber非必须
├─ userobject必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ nicknamestring非必须
├─ phonestring非必须
├─ countnumber非必须

财务->财务操作->提现申请

保存编辑

基本信息

Path: /adminapi/finance/extract/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 记录id

Body

参数名称 参数类型 是否必须 示例 备注
real_name text 是 真实姓名
mark text 否 备注
extract_price text 是 提现金额
alipay_code text 是 支付宝账号
wechat text 是 微信号
bank_code text 是 银行卡号
bank_address text 是 开户行

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

列表

基本信息

Path: /adminapi/finance/extract

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 页码
status 是 -1 未通过 0 审核中 1 已提现 提现状态
extract_type 否 bank = 银行卡 alipay = 支付宝wx=微信 提现方式
nireid 否 等风来,随风去 微信昵称/姓名/支付宝账号/银行卡号
date 否 2019/12/02-2019/12/06 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ extract_statisticsobject非必须
├─ pricestring非必须待提现金额
├─ brokerage_countstring非必须佣金总金额
├─ pricedstring非必须已提现金额
├─ brokerage_notstring非必须未提现金额
├─ listobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ nicknamestring非必须用户昵称
├─ idstring非必须提现申请记录id
├─ uidstring非必须用户id
├─ real_namestring非必须名称
├─ extract_typestring非必须bank = 银行卡 alipay = 支付宝wx=微信
├─ bank_codestring非必须银行卡
├─ bank_addressstring非必须开户地址
├─ alipay_codestring非必须支付宝账号
├─ extract_pricestring非必须提现金额
├─ markstring非必须备注
├─ balancestring非必须剩余
├─ fail_msgstring非必须无效原因
├─ fail_timestring非必须拒绝时间
├─ add_timestring非必须记录时间
├─ statusstring非必须-1 未通过 0 审核中 1 已提现
├─ wechatstring非必须微信号

拒绝申请

基本信息

Path: /adminapi/finance/extract/refuse/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 记录id

Body

参数名称 参数类型 是否必须 示例 备注
message text 是 拒绝原因

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/finance/extract/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 申请记录id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ precisionnumber非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

通过申请

基本信息

Path: /adminapi/finance/extract/adopt/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 记录id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

财务->财务操作->发票管理

发票列表

基本信息

Path: /adminapi/order/invoice/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 状态
real_name 否 搜索
header_type 否 抬头类型
type 否 发票类型
data 否 时间
fileld_key 否 order_id uid real_name phone 准确搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ invoice_idnumber必须
├─ order_idstring必须
├─ header_typenumber必须
├─ typenumber必须
├─ namestring必须
├─ duty_numberstring必须
├─ drawer_phonestring必须
├─ emailstring必须
├─ tellstring必须
├─ addressstring必须
├─ bankstring必须
├─ card_numberstring必须
├─ is_invoicenumber必须
├─ invoice_numberstring必须
├─ invoice_reamrkstring必须
├─ invoice_timenumber必须
├─ invoice_add_timestring必须
├─ orderobject必须
├─ idnumber非必须
├─ order_idstring非必须
├─ pay_pricestring非必须
├─ add_timenumber非必须
├─ real_namestring非必须
├─ user_phonestring非必须
├─ statusnumber非必须
├─ refund_statusnumber非必须
├─ idnumber必须
├─ pay_pricestring必须
├─ real_namestring必须
├─ user_phonestring必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ add_timestring必须
├─ countnumber非必须

发票头部统计

基本信息

Path: /adminapi/order/invoice/chart

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 是 时间
type 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ allstring非必须
├─ noOpenedstring非必须
├─ openedstring非必须
├─ refundstring非必须

开票详情

基本信息

Path: /adminapi/order/invoice_order_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 120 开票id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ orderInfoobject非必须
├─ idnumber非必须
├─ order_idstring非必须
├─ trade_nostring非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ user_phonestring非必须
├─ user_addressstring非必须
├─ cart_idstring []非必须

item 类型: string

├─ 非必须
├─ freight_pricestring非必须
├─ total_numnumber非必须
├─ total_pricestring非必须
├─ total_postagestring非必须
├─ pay_pricestring非必须
├─ pay_postagestring非必须
├─ deduction_pricestring非必须
├─ coupon_idnumber非必须
├─ coupon_pricestring非必须
├─ paidnumber非必须
├─ pay_timenumber非必须
├─ pay_typestring非必须
├─ add_timestring非必须
├─ statusnumber非必须
├─ refund_statusnumber非必须
├─ refund_reason_wap_imgnull非必须
├─ refund_reason_wap_explainnull非必须
├─ refund_reason_timenull非必须
├─ refund_reason_wapnull非必须
├─ refund_reasonnull非必须
├─ refund_pricestring非必须
├─ delivery_namenull非必须
├─ delivery_codestring非必须
├─ delivery_typestring非必须
├─ delivery_idnull非必须
├─ fictitious_contentstring非必须
├─ delivery_uidnumber非必须
├─ gain_integralstring非必须
├─ use_integralstring非必须
├─ back_integralnull非必须
├─ markstring非必须
├─ is_delnumber非必须
├─ uniquestring非必须
├─ remarknull非必须
├─ mer_idnumber非必须
├─ is_mer_checknumber非必须
├─ combination_idnumber非必须
├─ pink_idnumber非必须
├─ coststring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ verify_codestring非必须
├─ store_idnumber非必须
├─ shipping_typenumber非必须
├─ clerk_idnumber非必须
├─ is_channelnumber非必须
├─ is_remindnumber非必须
├─ is_system_delnumber非必须
├─ channel_typestring非必须
├─ provincestring非必须
├─ express_dumpstring非必须
├─ cartInfoobject []非必须

item 类型: object

├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ uniquestring非必须
├─ is_replynumber非必须
├─ class_namestring非必须
├─ _statusobject非必须
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _deliveryTypestring非必须
├─ _pay_timestring非必须
├─ _add_timestring非必须
├─ stop_timenumber非必须
├─ status_picstring非必须
├─ offlinePayStatusnumber非必须
├─ order_logobject非必须
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须
├─ vip_true_pricenumber非必须
├─ _store_namestring非必须
├─ userInfoobject非必须
├─ uidnumber非必须
├─ accountstring非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ clean_timenumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须
├─ spread_namestring非必须
├─ invoiceobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ categorystring非必须
├─ order_idnumber非必须
├─ invoice_idnumber非必须
├─ header_typenumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ duty_numberstring非必须
├─ drawer_phonestring非必须
├─ emailstring非必须
├─ tellstring非必须
├─ addressstring非必须
├─ bankstring非必须
├─ card_numberstring非必须
├─ is_paynumber非必须
├─ is_refundnumber非必须
├─ is_invoicenumber非必须
├─ invoice_numberstring非必须
├─ remarkstring非必须
├─ invoice_timenumber非必须
├─ add_timestring非必须

设置发票状态

基本信息

Path: /adminapi/order/invoice/set/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
is_invoice text 是 是否开票
invoice_number text 是 开票号
remark text 是 备注

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须

财务->财务记录->充值记录

充值记录列表

基本信息

Path: /adminapi/finance/recharge

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
data 否 today 时间选择 today 今天 week month year yesterday quarter lately7 lately30
paid 否 1 支付类型 0-未支付 1-已支付
nickname 否 4558 姓名/电话/uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ order_idstring必须
├─ pricestring必须
├─ give_pricestring必须
├─ recharge_typestring必须
├─ paidnumber必须
├─ pay_timenull,number必须
├─ add_timenumber必须
├─ refund_pricestring必须
├─ channel_typestring必须
├─ nicknamestring,null必须
├─ avatarstring,null必须
├─ _recharge_typestring必须
├─ _pay_timestring必须
├─ _add_timestring必须
├─ paid_typestring必须
├─ countnumber非必须

获取用户充值数据

基本信息

Path: /adminapi/finance/recharge/user_recharge

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 否 时间选择
paid 否 是否支付 0-否 1-是
nickname 否 姓名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ namestring必须
├─ fieldstring必须
├─ countnumber必须
├─ classNamestring必须
├─ colnumber必须

删除

基本信息

Path: /adminapi/finance/recharge/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 记录id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

退款表单

基本信息

Path: /adminapi/finance/recharge/:id/refund_edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 记录id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

退款

基本信息

Path: /adminapi/finance/recharge/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 记录id

Body

参数名称 参数类型 是否必须 示例 备注
refund_price text 是 0 1

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户充值记录导出

基本信息

Path: /adminapi/export/userRecharge

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 否 today 时间选择 today 今天 week month year yesterday quarter lately7 lately30
paid 否 1 支付类型 0-未支付 1-已支付
nickname 否 4558 姓名/电话/uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

财务->财务记录->资金监控

筛选类型

基本信息

Path: /adminapi/finance/finance/bill_type

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ titlestring必须
├─ typestring必须

资金记录

基本信息

Path: /adminapi/finance/finance/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
start_time 否
end_time 否
nickname 否 昵称/ID
type 否 筛选类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ link_idstring必须
├─ pmnumber必须
├─ titlestring必须
├─ categorystring必须
├─ typestring必须
├─ numberstring必须
├─ balancestring必须
├─ markstring必须
├─ add_timestring必须
├─ statusnumber必须
├─ takenumber必须
├─ nicknamestring必须
├─ countnumber非必须

导出

基本信息

Path: /adminapi/finance/finance/export

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_time 是
end_time 是
nickname 是
type 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须

item 类型: string

├─ 非必须

用户资金导出(已废弃)

基本信息

Path: /adminapi/export/userFinance

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_time 否 开始时间
end_time 否 结束时间
nickname 否 昵称
type 否 类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

财务->佣金记录->佣金记录

佣金记录

基本信息

Path: /adminapi/finance/finance/commission_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
nickname 否 昵称/id
price_max 否 佣金最大值
price_min 否 佣金最小值
brokerage_price 否 asc desc nomal 排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ sum_numberstring必须
├─ nicknamestring必须
├─ phonestring必须
├─ uidnumber必须
├─ now_moneystring必须
├─ brokerage_pricestring必须
├─ extract_pricenumber,string必须

佣金详情用户信息

基本信息

Path: /adminapi/finance/finance/user_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ user_infoobject []非必须

item 类型: object

├─ nicknamestring非必须用户昵称
├─ spread_uidstring非必须推广员id
├─ now_moneystring非必须用户余额
├─ add_timestring非必须添加时间
├─ numberstring非必须佣金总收入
├─ spread_namestring非必须上级推广人

佣金提现记录个人列表

基本信息

Path: /adminapi/finance/finance/extract_list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 用户id

Query

参数名称 是否必须 示例 备注
page 是
limit 是
start_time 是
end_time 是
nickname 是 昵称/订单号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ link_idstring必须
├─ pmnumber必须
├─ titlestring必须
├─ categorystring必须
├─ typestring必须
├─ numberstring必须
├─ balancestring必须
├─ markstring必须
├─ add_timestring必须
├─ statusnumber必须
├─ takenumber必须
├─ nicknamestring必须
├─ _add_timestring必须
├─ countnumber非必须

用户佣金导出

基本信息

Path: /adminapi/export/userCommission

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页数
limit 否 20 每页条数
nickname 否 昵称
price_max 否 金额大
price_min 否 金额小

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

内容->文章管理

文章列表

基本信息

Path: /adminapi/cms/cms

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 15 每页条数
pid 否 1 分类id
title 否 互联网 关键字搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ cidstring必须
├─ titlestring必须
├─ authorstring必须
├─ image_inputstring []必须

item 类型: string

├─ 非必须
├─ synopsisstring必须
├─ share_titlestring必须
├─ share_synopsisstring必须
├─ visitstring必须
├─ sortnumber必须
├─ urlstring必须
├─ statusnumber必须
├─ add_timestring必须
├─ hidenumber必须
├─ admin_idnumber必须
├─ mer_idnumber必须
├─ product_idnumber必须
├─ is_hotnumber必须
├─ is_bannernumber必须
├─ contentstring必须
├─ catenamestring必须
├─ storeInfoobject必须
├─ store_namestring非必须
├─ imagestring非必须
├─ pricestring非必须
├─ idnumber非必须
├─ ot_pricestring非必须
├─ store_namenull,string必须
├─ countnumber非必须

文章详情

基本信息

Path: /adminapi/cms/cms/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 文章id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ cidnumber非必须
├─ titlestring非必须
├─ authorstring非必须
├─ image_inputstring []非必须

item 类型: string

├─ 非必须
├─ synopsisstring非必须
├─ share_titlestring非必须
├─ share_synopsisstring非必须
├─ visitstring非必须
├─ sortnumber非必须
├─ urlstring非必须
├─ statusnumber非必须
├─ add_timestring非必须
├─ hidenumber非必须
├─ admin_idnumber非必须
├─ mer_idnumber非必须
├─ product_idnumber非必须
├─ is_hotnumber非必须
├─ is_bannernumber非必须
├─ contentstring非必须
├─ catenamestring非必须
├─ store_infonull非必须
├─ storeInfonull非必须

新增或修改

基本信息

Path: /adminapi/cms/cms

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 文章id
cid text 是 1 分类id
title text 是 小米也产业互联网了 文章标题
author text 是 PingWest 作者
image_input text 是 http://crmeb.my/uploads/attach/2019/11/20191120/3f9a2e407414fd6d6489a43ffac78800.jpg 文章图片
content text 是 文章内容
synopsis text 是 文章简介
share_title text 否 文章分享标题
share_synopsis text 否 文章分享简介
visit text 否 浏览次数
sort text 否 排序
url text 否 原文链接
is_banner text 否 是否轮播图(小程序)
is_hot text 否 是否热门(小程序)
status text 否 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除文章

基本信息

Path: /adminapi/cms/cms/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 文章id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

关联产品

基本信息

Path: /adminapi/cms/cms/relation/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 文章id

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 1 产品id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

取消关联

基本信息

Path: /adminapi/cms/cms/unrelation/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 文章id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

上传图文图片(已废弃)

基本信息

Path: /adminapi/cms/cms/upload

Method: POST

接口描述:

请求参数

Headers

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

Body

参数名称 参数类型 是否必须 示例 备注
file file 是 上传的图片文件

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须
├─ urlstring必须图片路径

内容->文章分类

修改状态

基本信息

Path: /adminapi/cms/category/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类
status 1 状态 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

分类列表

基本信息

Path: /adminapi/cms/category

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 0 展示形式 0-列表形式(默认) 1-树形形式
page 否 1 页码
limit 否 15 每页条数
status 否 1 状态 1-展示 0-隐藏
title 否 科技 文章分类标题关键字搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ titlestring必须
├─ intrstring必须
├─ imagestring必须
├─ statusnumber必须
├─ sortnumber必须
├─ is_delnumber必须
├─ add_timestring必须
├─ hiddennumber必须
├─ countnumber非必须

删除分类

基本信息

Path: /adminapi/cms/category/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增分类

基本信息

Path: /adminapi/cms/category

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 分类名称
intr text 是 文章分类简介
image text 是 [v1/1.jpg,v1/2.png] 图片地址
sort text 是 2 排序
status text 是 1 状态

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

新增分类表单

基本信息

Path: /adminapi/cms/category/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ maxlengthnumber非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑分类

基本信息

Path: /adminapi/cms/category/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 分类名称
intr text 是 文章分类简介
image text 是 [v1/1.jpg,v1/2.png] 图片地址
sort text 是 2 排序
status text 是 1 状态
id text 是 1 id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑分类表单

基本信息

Path: /adminapi/cms/category/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ maxlengthnumber非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

统计->商品统计

商品基础统计

基本信息

Path: /adminapi/adminapi/statistic/product/get_basic

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwcm8uY3JtZWIubXkiLCJhdWQiOiJwcm8uY3JtZWIubXkiLCJpYXQiOjE2MDQwNDUxNzEsIm5iZiI6MTYwNDA0NTE3MSwiZXhwIjoxNjA0MDU1OTcxLCJqdGkiOnsiaWQiOjEsInR5cGUiOiJhZG1pbiJ9fQ.rNL3MWbqmN9GTk_o1eRNgfL4DWi56zancJof8ZSH_9U

Query

参数名称 是否必须 示例 备注
data 是 2019/10/27-2020/10/26 时间区间

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ browseobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ userobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ cartobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ orderobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ payobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ payPriceobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ costobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ refundPriceobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ refundobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ payPercentobject非必须
├─ numstring非必须
├─ percentstring非必须

商品排行

基本信息

Path: /adminapi/adminapi/statistic/product/get_product_ranking

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 是 2020/9/28-2020/10/30
sort 是 visit 访问量
user 访客
cart 购物车
orders 下单数
price 金额
profit 毛利率
collect 收藏
changes 转化率
repeats 复购率
排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ product_idnumber必须
├─ visitstring必须
├─ usernumber必须
├─ cartstring必须
├─ ordersstring必须
├─ paystring必须
├─ pricestring必须
├─ coststring必须
├─ profitstring,number必须
├─ collectstring必须
├─ changesstring必须
├─ repeatsstring,number必须
├─ store_namestring必须
├─ imagestring必须

商品统计数据导出

基本信息

Path: /adminapi/statistic/product/get_excel

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 是 2020/11/24-2020/12/23

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlstring []非必须

item 类型: string

├─ 非必须

商品趋势

基本信息

Path: /adminapi/adminapi/statistic/product/get_trend

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwcm8uY3JtZWIubXkiLCJhdWQiOiJwcm8uY3JtZWIubXkiLCJpYXQiOjE2MDQwNDUxNzEsIm5iZiI6MTYwNDA0NTE3MSwiZXhwIjoxNjA0MDU1OTcxLCJqdGkiOnsiaWQiOjEsInR5cGUiOiJhZG1pbiJ9fQ.rNL3MWbqmN9GTk_o1eRNgfL4DWi56zancJof8ZSH_9U

Query

参数名称 是否必须 示例 备注
data 是 2020/5/27-2020/10/26

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ xAxisstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ datanumber []必须

item 类型: number

├─ 非必须
├─ typestring必须
├─ smoothstring必须
├─ yAxisIndexnumber必须

统计->用户统计

微信用户地域

基本信息

Path: /adminapi/adminapi/statistic/user/get_region

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 是 2020/7/1-2020/10/31
channel_type 是 wechat

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ allNumnumber必须
├─ provincestring必须
├─ newNumnumber必须
├─ visitNumnumber必须
├─ payPricenumber必须

微信用户性别

基本信息

Path: /adminapi/adminapi/statistic/user/get_sex

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 wechat
data 是 2020/1/1-2020/10/31

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ valuenumber必须
├─ namestring必须
├─ name_keynumber必须

微信用户统计

基本信息

Path: /adminapi/adminapi/statistic/user/get_wechat

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 wechat routine h5 pc
data 是 2020/7/1-2020/10/31

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ subscribeobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ unSubscribeobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ increaseSubscribeobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ cumulativeSubscribeobject非必须
├─ numnumber非必须
├─ percentstring非必须
├─ cumulativeUnSubscribeobject非必须
├─ numnumber非必须
├─ percentstring非必须

微信用户趋势

基本信息

Path: /adminapi/adminapi/statistic/user/get_wechat_trend

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 wechat routine h5 pc
data 是 2020/7/1-2020/10/31

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ xAxisstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ valuenumber []必须

item 类型: number

├─ 非必须

用户基础统计

基本信息

Path: /adminapi/adminapi/statistic/user/get_basic

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 wechat 公众号 routine 小程序 h5 pc
data 是 2020/10/1-2020/10/31

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ peopleobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ browseobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ newUserobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ payPeopleobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ payPercentobject非必须
├─ numstring非必须
├─ last_numstring非必须
├─ percentstring非必须
├─ payUserobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ rechargePeopleobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ payPriceobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ cumulativeUserobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ cumulativePayUserobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ cumulativeRechargePeopleobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须
├─ cumulativePayPeopleobject非必须
├─ numnumber非必须
├─ last_numnumber非必须
├─ percentstring非必须

用户统计数据导出

基本信息

Path: /adminapi/statistic/user/get_excel

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 用户渠道
data 是 时间 2020/11/30-2020/12/30

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlstring []非必须

item 类型: string

├─ 非必须

用户趋势

基本信息

Path: /adminapi/adminapi/statistic/user/get_trend

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
channel_type 是 wechat routine h5 pc
data 是 2020/7/1-2020/10/31

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ xAxisstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ valuenumber []必须

item 类型: number

├─ 非必须

统计->交易统计

交易统计上面数据

基本信息

Path: /adminapi/statistic/trade/top_trade

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
time 是 today/yestoday 今天昨天

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ leftobject非必须
├─ namestring非必须
├─ xstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ moneynumber必须
├─ valuestring []必须

item 类型: string

├─ 非必须
├─ rightobject非必须
├─ todayobject非必须
├─ xstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ now_moneynumber必须
├─ last_moneynumber必须
├─ ratenumber必须
├─ valuenumber []必须

item 类型: number

├─ 非必须
├─ monthobject []非必须

item 类型: object

├─ namestring必须
├─ now_moneynumber必须
├─ last_moneynumber必须
├─ ratestring必须
├─ valueobject必须
├─ 2021-01-01number非必须
├─ 2021-01-02number非必须
├─ 2021-01-03number非必须
├─ 2021-01-04number非必须
├─ 2021-01-05number非必须
├─ 2021-01-06number非必须
├─ 2021-01-07number非必须
├─ 2021-01-08number非必须
├─ 2021-01-09number非必须
├─ 2021-01-10number非必须
├─ 2021-01-11number非必须
├─ 2021-01-12number非必须
├─ 2021-01-13number非必须
├─ 2021-01-14number非必须
├─ 2021-01-15number非必须
├─ 2021-01-16number非必须
├─ 2021-01-17number非必须
├─ 2021-01-18number非必须
├─ 2021-01-19number非必须
├─ 2021-01-20number非必须
├─ 2021-01-21number非必须
├─ 2021-01-22number非必须
├─ 2021-01-23number非必须
├─ 2021-01-24number非必须
├─ 2021-01-25number非必须
├─ 2021-01-26number非必须
├─ 2021-01-27number非必须
├─ 2021-01-28number非必须
├─ 2021-01-29number非必须
├─ 2021-01-30number非必须
├─ 2021-01-31number非必须

交易统计下部分数据

基本信息

Path: /adminapi/statistic/trade/bottom_trade

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
data 是 今天:today
昨天:yestoday
本月:month
上月:last_month
今年:year
最近7天:7
最近30天:30
自由时间:['start_time' =>开始时间, 'end_time' => 结束时间]

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ xstring []非必须

item 类型: string

├─ 非必须
├─ seriesobject []非必须

item 类型: object

├─ namestring必须
├─ moneystring,number必须
├─ typenumber必须
├─ ratenumber必须
├─ valuestring []必须

item 类型: string

├─ 非必须
├─ exportstring非必须

设置->系统设置

基础配置头部

基本信息

Path: /adminapi/setting/config/header_basics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 0 类型 0-系统 1-应用 2-支付 3-其他

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ config_tabobject []非必须

item 类型: object

├─ valuestring非必须配置分类id
├─ labelstring非必须配置分类名称
├─ iconstring非必须图标
├─ typestring非必须配置类型

设置->一号通

获取验证码

基本信息

Path: /adminapi/serve/captcha

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
phone text 是 手机号码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须

item 类型: string

├─ 非必须

检测验证码

基本信息

Path: /adminapi/serve/checkCode

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
phone text 是 手机号
verify_code text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

注册服务

基本信息

Path: /adminapi/serve/register

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
phone text 是 手机号码
account text 是 账号
password text 是 密码
verify_code text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须

登录平台

基本信息

Path: /adminapi/serve/login

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 账号
password text 是 密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ access_tokenstring非必须token
├─ expires_innumber非必须过期时间

获取平台用户信息

基本信息

Path: /adminapi/serve/info

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ accountstring非必须
├─ phonestring非必须
├─ consumestring非必须
├─ smsobject非必须
├─ numnumber非必须
├─ surpnumber非必须
├─ signstring非必须
├─ opennumber非必须
├─ queryobject非必须
├─ numnumber非必须
├─ surpnumber非必须
├─ opennumber非必须
├─ dumpobject非必须
├─ numnumber非必须
├─ surpnumber非必须
├─ opennumber非必须
├─ copyobject非必须
├─ numnumber非必须
├─ surpnumber非必须
├─ opennumber非必须

开通电子面单

基本信息

Path: /adminapi/serve/opn_express

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
com text 是 快递公司
temp_id text 是 打印模板
to_name text 是 寄件人
to_tel text 是 寄件人电话
siid text 是 云打印机编号
to_address text 是 寄件人详细地址

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

开通短信服务

基本信息

Path: /adminapi/serve/sms/open

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
sign 是 签名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改短信签名

基本信息

Path: /adminapi/serve/sms/sign

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
sign text 是 短信签名
phone text 是 手机号
code text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取短信模板

基本信息

Path: /adminapi/serve/sms/temps

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
page 是
limit 是
temp_type 是 1 模板类型:1,验证码;2,通知;3,营销短信

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ temp_idstring必须
├─ titlestring必须
├─ contentstring必须
├─ temp_typenumber必须
├─ statusnumber必须
├─ templateidstring必须
├─ typestring必须
├─ countnumber非必须

申请短信模板表单

基本信息

Path: /adminapi/notify/sms/temp/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

申请模板

基本信息

Path: /adminapi/notify/sms/temp

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 模板名称
content text 是 【您的短信签名】您的验证码是:{$code},有效期为{$time}分钟。如非本人操作,可不用理会。模板中的{$code}和{$time}需要替换成对应的变量,请开发者知晓。修改此项无效! 模板内容示例
type text 是 1 模板类型 1-验证码 2-通知 3-推广

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

申请模板(已废弃)

基本信息

Path: /adminapi/serve/sms/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 短信名
content text 是 短信内容
type text 是 模板类型:1,验证码;2,通知;3,营销短信

返回数据

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

获取申请记录

基本信息

Path: /adminapi/serve/sms/apply_record

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
page 是 页码
limit 是 展示调试
temp_type 是 模板类型:1,验证码;2,通知;3,营销短信

开通其他服务

基本信息

Path: /adminapi/serve/open

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
type 是 1=开通复制商品,0=开通物流查询

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取用量列表

基本信息

Path: /adminapi/serve/record

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
page 是
limit 是
type 是 1 = 短信,2= 电子面单,3 = 物流查询,4 = 复制商品

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber必须
├─ dataobject必须电子面单
├─ from_namestring必须发货人
├─ to_namestring必须收货人
├─ codestring必须快递公司编码
├─ numstring必须快递单号
├─ order_idstring必须订单号
├─ add_timestring必须电子面单打印时间
├─ _resultcodestring必须状态
├─ data_1object必须快递查询
├─ contentobject必须快递查询结果内容
├─ ischeckstring必须快递状态
├─ comstring必须快递公司编码
├─ numstring必须快递单号
├─ contentobject必须数组对象
├─ timestring必须时间
├─ statusstring必须描述
├─ codestring必须快递公司编码
├─ add_timestring必须添加时间
├─ _resultcodestring必须状态
├─ data_2object []必须复制商品

item 类型: object

├─ add_timestring必须添加时间
├─ _resultcodestring必须请求状态
├─ urlstring必须复制URL

全部物流公司

基本信息

Path: /adminapi/serve/export_all

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须快递公司名称
├─ codestring必须快递公司编码
├─ markstring必须备注
├─ partner_idnumber必须
├─ partner_keynumber必须
├─ netnumber必须
├─ countnumber非必须

快递公司面板

基本信息

Path: /adminapi/serve/export_temp

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
page 否
limit 否
com 是 快递公司编码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ titlestring非必须标题
├─ codestring非必须快递公司编码
├─ temp_idstring非必须模板编号
├─ picstring非必须模板图片
├─ countnumber非必须

修改密码

基本信息

Path: /adminapi/serve/modify

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 账号
password text 是 新密码
phone text 是 手机号
verify_code text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改手机号

基本信息

Path: /adminapi/serve/update_phone

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 账号
phone text 是 手机号
verify_code text 是 验证码
password text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取套餐

基本信息

Path: /adminapi/serve/meal_list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
type 是 套餐类型:sms,短信;expr_query,物流查询;dump,电子面单;copy,产品复制

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须
├─ pricestring必须
├─ numnumber必须
├─ typestring必须
├─ countnumber非必须

获取支付码

基本信息

Path: /adminapi/serve/pay_meal

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
Authori-zation 是

Body

参数名称 参数类型 是否必须 示例 备注
meal_id text 是
price text 是
num text 是
type text 是
pay_type text 是 支付方式:weixin:微信;alipay:支付宝;

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ qr_codestring非必须
├─ code_urlstring非必须
├─ invalidstring非必须

获取当前一号通账户是否开通电子面单

基本信息

Path: /adminapi/serve/dump_open

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ isOpenboolean非必须true = 开通,false=未开通

设置->页面管理->页面设计

模板列表

基本信息

Path: /adminapi/diy/get_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 1 类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ is_diynumber必须
├─ template_namestring必须
├─ idnumber必须
├─ titlestring必须
├─ namestring必须
├─ typenumber必须
├─ add_timestring必须
├─ update_timestring必须
├─ statusnumber必须
├─ countnumber非必须

添加表单

基本信息

Path: /adminapi/diy/create

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 默认模板 模板名称
template_name text 是 moren 页面类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取商品

基本信息

Path: /adminapi/diy/get_product

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ mer_idnumber必须
├─ imagestring必须
├─ recommend_imagestring必须
├─ slider_imagestring []必须

item 类型: string

├─ 非必须
├─ store_namestring必须
├─ store_infostring必须
├─ keywordstring必须
├─ bar_codestring必须
├─ cate_idstring必须
├─ pricestring必须
├─ vip_pricestring必须
├─ ot_pricestring必须
├─ postagestring必须
├─ unit_namestring必须
├─ sortnumber必须
├─ salesnumber必须
├─ stocknumber必须
├─ is_shownumber必须
├─ is_hotnumber必须
├─ is_benefitnumber必须
├─ is_bestnumber必须
├─ is_newnumber必须
├─ add_timenumber必须
├─ is_postagenumber必须
├─ is_delnumber必须
├─ mer_usenumber必须
├─ give_integralstring必须
├─ coststring必须
├─ is_seckillnumber必须
├─ is_bargainnull必须
├─ is_goodnumber必须
├─ is_subnumber必须
├─ is_vipnumber必须
├─ fictinumber必须
├─ browsenumber必须
├─ code_pathstring必须
├─ soure_linkstring必须
├─ video_linkstring必须
├─ temp_idnumber必须
├─ spec_typenumber必须
├─ activitystring必须
├─ spustring必须
├─ label_idstring必须
├─ command_wordstring必须
├─ descriptionstring必须
├─ couponIdobject []必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ issue_coupon_idnumber必须
├─ add_timenumber必须
├─ titlestring必须

获取商品列表

基本信息

Path: /adminapi/diy/get_product_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mer_idnumber必须
├─ imagestring必须
├─ recommend_imagestring必须
├─ slider_imagestring []必须

item 类型: string

├─ 非必须
├─ store_namestring必须
├─ store_infostring必须
├─ keywordstring必须
├─ bar_codestring必须
├─ cate_idstring必须
├─ pricenumber必须
├─ vip_pricenumber必须
├─ ot_pricenumber必须
├─ postagenumber必须
├─ unit_namestring必须
├─ sortnumber必须
├─ salesnumber必须
├─ stocknumber必须
├─ is_shownumber必须
├─ is_hotnumber必须
├─ is_benefitnumber必须
├─ is_bestnumber必须
├─ is_newnumber必须
├─ add_timenumber必须
├─ is_postagenumber必须
├─ is_delnumber必须
├─ mer_usenumber必须
├─ give_integralnumber必须
├─ costnumber必须
├─ is_seckillnumber必须
├─ is_bargainnull必须
├─ is_goodnumber必须
├─ is_subnumber必须
├─ is_vipnumber必须
├─ fictinumber必须
├─ browsenumber必须
├─ code_pathstring必须
├─ soure_linkstring必须
├─ video_linkstring必须
├─ temp_idnumber必须
├─ spec_typenumber必须
├─ activitystring必须
├─ spustring必须
├─ label_idstring必须
├─ command_wordstring必须
├─ descriptionstring必须
├─ couponIdobject []必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ issue_coupon_idnumber必须
├─ add_timenumber必须
├─ titlestring必须
├─ cate_namestring必须
├─ is_product_typenumber必须

获取添加表单

基本信息

Path: /adminapi/diy/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

设置默认数据

基本信息

Path: /adminapi/diy/set_recovery/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 页面模板id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

页面链接(新)

基本信息

Path: /adminapi/diy/get_page_category

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须编号
├─ pidnumber必须上级ID
├─ typestring必须类型
├─ namestring必须名称
├─ titlestring必须标题
├─ expandboolean必须
├─ childrenobject []必须下级

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ typestring必须
├─ namestring必须
├─ titlestring必须
├─ expandboolean必须
├─ childrenstring []必须

item 类型: string

├─ 非必须

模版详情

基本信息

Path: /adminapi/diy/get_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 模版id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ versionstring非必须
├─ namestring非必须
├─ titlestring非必须
├─ template_namestring非必须
├─ valueobject非必须
├─ 1609988537085000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ swiperConfigobject非必须
├─ titlestring非必须
├─ maxListnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring非必须
├─ infoobject []非必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ tipsstring非必须
├─ maxnumber必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring必须
├─ colorobject []非必须

item 类型: object

├─ itemstring必须
├─ lrConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ itemEdgeobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ docConfigobject非必须
├─ cnamestring非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ imgConfigobject非必须
├─ cnamestring非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ 1609989263787000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ titlestring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring必须
├─ activeValuestring必须
├─ listStyleobject非必须
├─ cnamestring非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ itemConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ 1609988577773000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ themeColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ itemStyleobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ lrConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ idsstring []非必须

item 类型: string

├─ 非必须
├─ 1609990421445000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ themeColorobject非必须
├─ titlestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ 1609991031373000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ titleConfigobject非必须
├─ titlestring非必须
├─ valuestring非必须
├─ maxnumber非必须
├─ desConfigobject非必须
├─ titlestring非必须
├─ valuestring非必须
├─ maxnumber非必须
├─ menuConfigobject非必须
├─ titlestring非必须
├─ maxListnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ tipsstring必须
├─ maxnumber必须
├─ themeColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring必须
├─ colorobject []非必须

item 类型: object

├─ itemstring必须
├─ boxColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ 1609991361201000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ countDownColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ themeColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ numberConfigobject非必须
├─ valnumber非必须
├─ lrConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ imgConfigobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ 1609991370825000object非必须
├─ namestring非必须
├─ timestampstring非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ txtColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ themeColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ mbConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ lrConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ minnumber非必须
├─ imgConfigobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ 1609991382160000object非必须
├─ namestring非必须
├─ txtColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ activeTxtColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ menuListobject []非必须

item 类型: object

├─ imgListstring []必须

item 类型: string

├─ 非必须
├─ namestring必须
├─ linkstring必须
├─ default_valuestring非必须
├─ add_timestring非必须
├─ update_timestring非必须
├─ statusnumber非必须
├─ typenumber非必须
├─ is_diynumber非必须
├─ is_delnumber非必须

保存DIY数据

基本信息

Path: /adminapi/diy/save/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 修改模板ID

Body

参数名称 参数类型 是否必须 示例 备注
version text 是 v1 版本号
name text 是 测试模板 模板名称
value text 是 {} 模板值
type text 是 1 模板类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须

删除DIY模板

基本信息

Path: /adminapi/diy/del/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 删除模板ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

使用模板

基本信息

Path: /adminapi/diy/set_status/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 使用模板ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

一键恢复默认

基本信息

Path: /adminapi/diy/recovery/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取商品分类

基本信息

Path: /adminapi/diy/get_category

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须

获取页面链接

基本信息

Path: /adminapi/diy/get_url

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlobject []非必须

item 类型: object

├─ namestring必须
├─ urlstring必须
├─ parameterstring []必须

item 类型: string

├─ 非必须
├─ examplestring必须

获取门店自提开启状态

基本信息

Path: /adminapi/diy/get_store_status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ store_statusstring非必须

获取所有二级商品分类

基本信息

Path: /adminapi/diy/get_by_category

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ cate_namestring必须
├─ pidnumber必须
├─ picstring必须

设置->页面管理->数据配置

获取所有组合数据

基本信息

Path: /adminapi/setting/group_all

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须

获取列表头

基本信息

Path: /adminapi/setting/group_data/header

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 1 组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ headerobject []非必须

item 类型: object

├─ keystring必须
├─ titlestring必须
├─ minWidthnumber必须
├─ typestring非必须
├─ slotstring必须
├─ fixedstring非必须

数据列表

基本信息

Path: /adminapi/setting/group_data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 1 组合数据id
page 否 1 页码
limit 否 15 每页条数
status 否 1 是否显示 1-显示 0-不显示

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ gidnumber非必须
├─ add_timenumber非必须
├─ sortnumber非必须
├─ statusnumber非必须
├─ imgstring []非必须

item 类型: string

├─ 非必须
├─ commentstring非必须
├─ linkstring非必须
├─ countnumber非必须
├─ typestring非必须

新建表单

基本信息

Path: /adminapi/setting/group_data/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gid 是 1 组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

新增数据

基本信息

Path: /adminapi/setting/group_data

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
gid text 是 1 组合数据id
banner/img/name/pic/info/time text 是 数据字段对应的数据值
sort text 是 排序
status text 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/setting/group_data/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 数据id

Query

参数名称 是否必须 示例 备注
gid 是 1 组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑数据

基本信息

Path: /adminapi/setting/group_data/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
banner/img/name/pic/info/time text 是 (banner)v1/test.png 数据字段对应的数据值
sort text 是 2 排序
status text 是 1 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/setting/group_data/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改状态

基本信息

Path: /adminapi/setting/group_data/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 数据id
status 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

设置->页面管理->客服广告

获取客服广告

基本信息

Path: /adminapi/setting/get_kf_adv

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ contentstring非必须

设置客服广告

基本信息

Path: /adminapi/setting/set_kf_adv

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
content 是 协议内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

设置->管理权限->角色管理

保存新建或编辑

基本信息

Path: /adminapi/setting/role/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 身份id 新增时为0

Body

参数名称 参数类型 是否必须 示例 备注
role_name text 是 身份名称
status text 是 状态
checked_menus text 是 [1.2.3] 选中的菜单id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改状态

基本信息

Path: /adminapi/setting/role/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类
status 1 状态 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

列表

基本信息

Path: /adminapi/setting/role

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
status 否 1 状态
role_name 否 身份昵称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ role_namestring必须
├─ rulesstring必须
├─ levelnumber必须
├─ statusnumber必须

删除

基本信息

Path: /adminapi/setting/role/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 身份id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

权限列表

基本信息

Path: /adminapi/setting/role/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ menusobject []非必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenstring []必须

item 类型: string

├─ 非必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须

编辑详情

基本信息

Path: /adminapi/setting/role/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 身份id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ roleobject非必须
├─ idnumber非必须
├─ role_namestring非必须
├─ rulesstring非必须
├─ levelnumber非必须
├─ statusnumber非必须
├─ menusobject []非必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenobject []必须

item 类型: object

├─ pidnumber必须
├─ idnumber必须
├─ titlestring必须
├─ childrenstring []必须

item 类型: string

├─ 非必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须
├─ expandboolean必须

设置->管理权限->管理员列表

管理员列表

基本信息

Path: /adminapi/setting/admin

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 10 展示条数
name 否 管理员姓名
roles 否 权限
status 否 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ accountstring必须
├─ head_picstring必须
├─ pwdstring必须
├─ real_namestring必须
├─ rolesstring必须
├─ last_ipstring必须
├─ last_timenumber必须
├─ add_timenumber必须
├─ login_countnumber必须
├─ levelnumber必须
├─ statusnumber必须
├─ is_delnumber必须
├─ _add_timestring必须
├─ _last_timestring必须
├─ countnumber非必须

管理员添加表单

基本信息

Path: /adminapi/setting/admin/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuearray,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ multipleboolean非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

管理员添加

基本信息

Path: /adminapi/setting/admin

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 管理员账号之能为英文加数字
conf_pwd text 是 确认密码
pwd text 是 密码
roles text 是 权限
status text 是 状态
real_name text 是 管理员姓名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 = 正确
msgstring非必须提示

获取修改管理员表单

基本信息

Path: /adminapi/setting/admin/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 管理员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuearray,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ multipleboolean非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改管理员信息

基本信息

Path: /adminapi/setting/admin/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 管理员id

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 管理员账号
conf_pwd text 否 确认密码 不填写不修改密码
pwd text 否 密码 不填写不修改密码
real_name text 否 姓名
roles text 是 权限
status text 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 = 正确
msgstring非必须提示语

删除管理员

基本信息

Path: /adminapi/setting/admin/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 管理员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须400 = 错误,200 = 正确
msgstring非必须提示

获取当前登陆管理员信息

基本信息

Path: /adminapi/setting/info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须管理员id
├─ accountstring非必须管理员账号
├─ head_picstring非必须头像
├─ real_namestring非必须姓名
├─ rolesstring []非必须权限

item 类型: string

├─ 非必须
├─ last_ipstring非必须最近访问ip
├─ last_timenumber非必须最近访问时间戳
├─ add_timenumber非必须添加时间戳
├─ login_countnumber非必须登陆次数
├─ levelnumber非必须等级

修改当前管理员信息

基本信息

Path: /adminapi/setting/update_admin

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
real_name text 是 管理员姓名
head_pic text 是 头像
pwd text 否 旧密码 填写则修改密码
new_pwd text 否 新密码 填写则修改密码
conf_pwd text 否 确认密码 填写则修改密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须200 = 成功,400 = 错误
msgstring非必须提示语

修改状态

基本信息

Path: /adminapi/setting/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 管理员id
status 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

设置->管理权限->权限规则

获取权限列表

基本信息

Path: /adminapi/setting/menus

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
is_show 否 是否显示
keyword 否 搜索词

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ iconstring必须
├─ menu_namestring必须
├─ modulestring必须
├─ controllerstring必须
├─ actionstring必须
├─ api_urlstring必须
├─ methodsstring必须
├─ paramsstring必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_show_pathnumber必须
├─ accessnumber必须
├─ menu_pathstring必须
├─ pathstring必须
├─ auth_typenumber必须
├─ headerstring必须
├─ is_headernumber必须
├─ unique_authstring必须
├─ is_delnumber必须
├─ heࡡderstring非必须

获取权限规则表单

基本信息

Path: /adminapi/setting/menus/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring []必须

item 类型: string

├─ 非必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ multipleboolean非必须
├─ filterableboolean非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ heightstring非必须
├─ dataobject []非必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuenumber必须
├─ pidnumber必须
├─ labelstring必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加权限

基本信息

Path: /adminapi/setting/menus

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
menu_name text 是 菜单明 中英文
controller text 是 控制器名 英文
module text 是 模型名 英文
action text 是 方法名
icon text 是 图标类名
params text 是 参数
path text 是 路径
menu_path text 是 路由地址 提供前台使用
api_url text 是 接口地址
methods text 是 方法
unique_auth text 是 唯一标识前台权限使用
header text 是 头部
is_header text 是 是否头部
pid text 是 父级id
sort text 是 排序
auth_type text 是 1 = 菜单,2= 接口
access text 是 子管理员是否能用
is_show text 是 是否显示
is_show_path text 是 显示路径

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须200 = 添加成功,400 = 失败
msgstring非必须提示语

修改权限规则表单(已废弃)

基本信息

Path: /adminapi/setting/menus/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 规则id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ titlestring必须
├─ valuestring,number必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ requiredboolean非必须
├─ multipleboolean非必须
├─ filterableboolean非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ heightstring非必须
├─ validateobject []必须

item 类型: object

├─ requiredboolean必须
├─ triggerstring必须
├─ typestring必须
├─ messagestring必须
├─ colstring []必须

item 类型: string

├─ 非必须
├─ optionsobject []必须

item 类型: object

├─ labelstring必须
├─ valuestring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

修改权限规则

基本信息

Path: /adminapi/setting/menus/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 权限id

Body

参数名称 参数类型 是否必须 示例 备注
menu_name text 是 菜单名称
controller text 是 控制器名称 英文
module text 是 模块名称
action text 是 方法名称
params text 是 参数
icon text 是 字体图标class
menu_path text 是 路由地址 前台使用
unique_auth text 是 唯一权限 前台使用
path text 是 路径
sort text 是 排序
pid text 是 上级id
is_header text 是 是否头部
header text 是 头部
auth_type text 是 1=菜单,2=接口
access text 是 子管理员是否能用
is_show text 是 是否显示
is_show_path text 是 显示路径

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除规则

基本信息

Path: /adminapi/setting/menus/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 规则id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取单个规则

基本信息

Path: /adminapi/setting/menus/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 规则id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ pidnumber非必须
├─ iconstring非必须
├─ menu_namestring非必须
├─ modulestring非必须
├─ controllerstring非必须
├─ actionstring非必须
├─ api_urlstring非必须
├─ methodsstring非必须
├─ paramsstring非必须
├─ sortnumber非必须
├─ is_shownumber非必须
├─ is_show_pathnumber非必须
├─ accessnumber非必须
├─ menu_pathstring非必须
├─ pathnumber []非必须

item 类型: number

├─ 非必须
├─ auth_typenumber非必须
├─ headerstring非必须
├─ is_headernumber非必须
├─ unique_authstring非必须
├─ is_delnumber非必须

修改显示

基本信息

Path: /adminapi/setting/menus/show/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 规则id

Body

参数名称 参数类型 是否必须 示例 备注
is_show text 是 1 = 显示 ,0 = 隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

设置->发货设置->配送员管理

配送员列表

基本信息

Path: /adminapi/order/delivery/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ avatarstring必须
├─ wx_namestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ phonestring必须
├─ nicknamestring必须
├─ countnumber非必须

新增配送员表单

基本信息

Path: /adminapi/order/delivery/add

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ srcKeystring非必须
├─ placeholderstring非必须
├─ maxlengthnumber非必须
├─ colobject必须
├─ spannumber非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加

基本信息

Path: /adminapi/order/delivery/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
image text 是 用户头像
uid text 是 用户uid
avatar text 是 图像
phone text 是 电话号码
nickname text 是 名称
status text 是 账号状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑配送员表单

基本信息

Path: /adminapi/order/delivery/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 配送员id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ placeholderstring非必须
├─ maxlengthnumber非必须
├─ colobject必须
├─ spannumber非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑

基本信息

Path: /adminapi/order/delivery/update/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

Body

参数名称 参数类型 是否必须 示例 备注
avatar text 是 头像
nickname text 是 姓名
phone text 是 电话
status text 是 账号状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除

基本信息

Path: /adminapi/order/delivery/del/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

修改配送员状态

基本信息

Path: /adminapi/order/delivery/set_status/:id/:status

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id
status

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须

新增配送员选择用户列表(已废弃)

基本信息

Path: /adminapi/adminapi/order/delivery/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
nickname 是 昵称搜索
data 是 时间搜索
type 是 用户类型搜索(详见客服)

返回数据

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

订单时获取所有配送员列表(已废弃)

基本信息

Path: /adminapi/adminapi/order/delivery/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ avatarstring必须
├─ wx_namestring必须
├─ statusnumber必须
├─ add_timestring必须
├─ phonestring必须
├─ nicknamestring必须
├─ countnumber非必须

编辑配送员表单(已废弃)

基本信息

Path: /adminapi/adminapi/order/delivery/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

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

列表修改账号状态(已废弃)

基本信息

Path: /adminapi/adminapi/order/delivery/set_status/:id/:status

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id
status

设置->发货设置->提货点设置->提货点

获取地图key

基本信息

Path: /adminapi/merchant/store/address

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ keystring非必须

门店列表分类数量

基本信息

Path: /adminapi/merchant/store/get_header

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countobject非必须
├─ showobject非必须
├─ namestring非必须
├─ numnumber非必须
├─ hideobject非必须
├─ namestring非必须
├─ numnumber非必须
├─ recycleobject非必须
├─ namestring非必须
├─ numnumber非必须

门店列表

基本信息

Path: /adminapi/merchant/store

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
keywords 是
type 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ introductionstring必须
├─ phonestring必须
├─ addressstring必须
├─ detailed_addressstring必须
├─ imagestring必须
├─ latitudestring必须
├─ longitudestring必须
├─ valid_timestring必须
├─ day_timestring必须
├─ add_timenumber必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ countnumber非必须

获取门店详情

基本信息

Path: /adminapi/merchant/store/get_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 门店id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ introductionstring非必须
├─ phonestring非必须
├─ addressstring非必须
├─ detailed_addressstring非必须
├─ imagestring非必须
├─ oblong_imagestring非必须
├─ latitudestring非必须
├─ longitudestring非必须
├─ valid_timestring非必须
├─ day_timestring非必须
├─ add_timenumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ latlngstring非必须
├─ dataValstring []非必须

item 类型: string

├─ 非必须
├─ timeValstring []非必须

item 类型: string

├─ 非必须
├─ address2string []非必须

item 类型: string

├─ 非必须

保存或修改门店

基本信息

Path: /adminapi/merchant/store/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 门店名称
introduction text 否 门店简介
image text 是 门店logo
phone text 是 门店电话
address text 是 [陕西,西安,未央区] 地址
detailed_address text 是 启航大厦 详细地址
latlng text 是 34.29318,108.94712 经纬度
day_time text 是 [08:00:00,18:00:00] 营业时间

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

门店设置显示或隐藏

基本信息

Path: /adminapi/merchant/store/set_show/:id/:is_show

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 门店ID
is_show 1显示0隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除门店

基本信息

Path: /adminapi/merchant/store/del/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 门店ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

商铺提货点导出(已废弃)

基本信息

Path: /adminapi/export/storeMerchant

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
keywords 否 名称 关键字
type 否 显示、隐藏、回收站

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel地址

设置->发货设置->提货点设置->核销员

搜索门店列表

基本信息

Path: /adminapi/merchant/store_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须门店id
├─ namestring非必须门店名称

核销员列表

基本信息

Path: /adminapi/merchant/store_staff

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
store_id 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ avatarstring必须
├─ store_idnumber必须
├─ staff_namestring必须
├─ phonestring必须
├─ verify_statusnumber必须
├─ statusnumber必须
├─ add_timestring必须
├─ namestring必须
├─ nicknamestring必须
├─ countnumber非必须

新增核销员表单

基本信息

Path: /adminapi/merchant/store_staff/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ srcKeystring非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ colobject必须
├─ spannumber非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

修改核销员表单

基本信息

Path: /adminapi/merchant/store_staff/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ colobject必须
├─ spannumber非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

保存店员

基本信息

Path: /adminapi/merchant/store_staff/save/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 店员ID 新增为0

Body

参数名称 参数类型 是否必须 示例 备注
image text 是 图像
avatar text 是 核销员图像
uid text 是 uid
store_id text 是 提货点id
staff_name text 是 名称
phone text 是 手机号
verify_status text 是 核销开关
status text 是 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除店员

基本信息

Path: /adminapi/merchant/store_staff/del/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 店员ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

店员设置显示隐藏

基本信息

Path: /adminapi/merchant/store_staff/set_show/:id/:is_show

Method: PUT

接口描述:

请求参数

Headers

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

路径参数

参数名称 示例 备注
id 店员ID
is_show

Body

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

设置->发货设置->提货点设置->核销订单

核销订单列表

基本信息

Path: /adminapi/merchant/verify_order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
data 是 时间
real_name 是 筛选条件
store_id 是 门店ID
type 是 类型
field_key 是 order_id uid user_phone real_namet title 准确搜索字段

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须
├─ order_idstring必须
├─ trade_nostring必须
├─ uidnumber必须
├─ real_namestring必须
├─ user_phonestring必须
├─ user_addressstring必须
├─ cart_idstring []必须

item 类型: string

├─ 非必须
├─ freight_pricestring必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ total_postagestring必须
├─ pay_pricestring必须
├─ pay_postagestring必须
├─ deduction_pricestring必须
├─ coupon_idnumber必须
├─ coupon_pricestring必须
├─ paidnumber必须
├─ pay_timenumber必须
├─ pay_typestring必须
├─ add_timestring必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ refund_reason_wap_imgnull必须
├─ refund_reason_wap_explainnull必须
├─ refund_reason_timenull必须
├─ refund_reason_wapnull必须
├─ refund_reasonnull必须
├─ refund_pricestring必须
├─ delivery_namenull,string必须
├─ delivery_codestring必须
├─ delivery_typenull,string必须
├─ delivery_idnull,string必须
├─ fictitious_contentstring必须
├─ delivery_uidnumber必须
├─ gain_integralstring必须
├─ use_integralstring必须
├─ back_integralnull必须
├─ markstring必须
├─ is_delnumber必须
├─ uniquestring必须
├─ remarknull必须
├─ mer_idnumber必须
├─ is_mer_checknumber必须
├─ combination_idnumber必须
├─ pink_idnumber必须
├─ coststring必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ verify_codestring必须
├─ store_idnumber必须
├─ shipping_typenumber必须
├─ clerk_idnumber必须
├─ is_channelnumber必须
├─ is_remindnumber必须
├─ is_system_delnumber必须
├─ channel_typestring必须
├─ provincestring必须
├─ express_dumpstring必须
├─ nicknamestring,null必须
├─ phonestring,null必须
├─ spread_uidnumber,null必须
├─ spread_nicknamestring,null必须
├─ store_namestring必须
├─ staff_uidnull,number必须
├─ staff_store_idnull,number必须
├─ clerk_namestring必须
├─ _infoobject必须
├─ 977443148082577408object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 35073415353039847424object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 35073391230100176896object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 35073389617792942080object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 78772333537298087936object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 78772332211101106176object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 78170576061502455808object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 569843927804411904object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 669740392135786496object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ 569015305552134144object非必须
├─ cart_infoobject非必须
├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ integral_pricenumber非必须
├─ _pay_timestring必须
├─ pink_namestring必须
├─ colorstring必须
├─ pay_type_namestring必须
├─ status_nameobject必须
├─ status_namestring非必须
├─ picsstring []非必须

item 类型: string

├─ 非必须
├─ _statusnumber必须
├─ badgeobject []非必须

item 类型: object

├─ namestring必须
├─ fieldstring必须
├─ countnumber,string,null必须
├─ classNamestring必须
├─ colnumber必须

核销订单头部(已废弃)

基本信息

Path: /adminapi/merchant/verify_badge

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ namestring必须名称
├─ fieldstring必须单位
├─ countnumber,null必须数量
├─ background_colorstring必须颜色
├─ colnumber必须

核销列表推荐人信息(已废弃)

基本信息

Path: /adminapi/merchant/verify/spread_info/:uid

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
uid 1 用户ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ spreadobject非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonenull非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须

设置->发货设置->运费模板

运费模板列表

基本信息

Path: /adminapi/setting/shipping_templates/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1
limit 是 15
name 是 测试模板 筛选模板名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ dataobject []非必须

item 类型: object

├─ idnumber非必须模板ID
├─ namestring非必须模板名称
├─ typestring非必须计费方式
├─ appointstring非必须是否开启指定包邮
├─ sortnumber非必须排序
├─ add_timestring非必须添加时间

添加/修改运费模板

基本信息

Path: /adminapi/setting/shipping_templates/save/:id

Method: POST

接口描述:

请求参数

Headers

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

路径参数

参数名称 示例 备注
id 1 修改模板ID 添加为0

Body

名称类型是否必须默认值备注其他信息
region_infoobject []非必须区域运费

item 类型: object

├─ regionobject []必须

item 类型: object

├─ city_idstring必须城市ID
├─ namestring必须城市名称
├─ childrenobject []必须下级

item 类型: object

├─ city_idstring必须城市ID
├─ namestring必须城市名称
├─ regionNamestring []必须显示城市名称

item 类型: string

├─ 非必须
├─ firststring必须首件件数
├─ pricestring必须首件金额
├─ continuestring必须续件件数
├─ continue_pricestring必须续件金额
├─ uniqidstring必须唯一值
appoint_infoobject []非必须区域包邮

item 类型: object

├─ placeobject []非必须

item 类型: object

├─ city_idstring非必须城市ID
├─ namestring非必须城市名称
├─ childrenobject []非必须下级

item 类型: object

├─ city_idstring非必须城市ID
├─ namestring非必须城市名称
├─ a_numstring非必须包邮件数
├─ a_pricestring非必须包邮金额
├─ placeNamestring []非必须城市显示名称

item 类型: string

├─ 非必须
sortstring非必须排序
typestring非必须运费模板类型
namestring非必须运费模板名称
appointstring非必须是否开启包邮

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除运费模板

基本信息

Path: /adminapi/setting/shipping_templates/del/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 运费模板ID

返回数据

名称类型是否必须默认值备注其他信息
statusstring必须
msgstring必须

获取城市数据

基本信息

Path: /adminapi/setting/shipping_templates/city_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ city_idnumber必须
├─ levelnumber必须
├─ parent_idnumber必须
├─ area_codestring必须
├─ namestring必须
├─ merger_namestring必须
├─ lngstring必须
├─ latstring必须
├─ is_shownumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ city_idnumber必须
├─ levelnumber必须
├─ parent_idnumber必须
├─ area_codestring必须
├─ namestring必须
├─ merger_namestring必须
├─ lngstring必须
├─ latstring必须
├─ is_shownumber必须

修改运费模板数据(已废弃)

基本信息

Path: /adminapi/setting/shipping_templates/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 运费模板ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ appointListobject []非必须包邮地区

item 类型: object

├─ placeobject []非必须包邮地区

item 类型: object

├─ city_idnumber非必须省份ID
├─ namestring非必须省份名称
├─ childrenobject []非必须下级城市

item 类型: object

├─ city_idnumber非必须城市ID
├─ namestring非必须城市名称
├─ a_numstring非必须包邮件数
├─ a_pricestring非必须包邮金额
├─ placeNamestring []非必须显示省份

item 类型: string

├─ 非必须
├─ templateListobject []非必须运费地区

item 类型: object

├─ regionobject []非必须运费地区

item 类型: object

├─ city_idnumber非必须省份ID
├─ namestring非必须省份名称
├─ childrenobject []非必须下级城市

item 类型: object

├─ city_idnumber非必须城市ID
├─ namestring非必须城市名称
├─ regionNamestring []非必须显示省份

item 类型: string

├─ 非必须
├─ firststring非必须首件个数
├─ pricestring非必须首件金额
├─ continuestring非必须续件个数
├─ continue_pricestring非必须续件金额
├─ uniqidstring非必须唯一值
├─ formDataobject非必须
├─ namestring非必须模板名称
├─ typenumber非必须模板类型
├─ appoint_checknumber非必须是由包邮
├─ sortnumber非必须排序

设置->消息管理

消息管理

基本信息

Path: /adminapi/setting/notification/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 1 类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ markstring必须
├─ namestring必须
├─ titlestring必须
├─ is_systemnumber必须
├─ is_appnumber必须
├─ is_wechatnumber必须
├─ is_routinenumber必须
├─ is_smsnumber必须
├─ is_ent_wechatnumber必须
├─ system_titlestring必须
├─ system_textstring必须
├─ app_idnumber必须
├─ wechat_idstring必须
├─ routine_idstring必须
├─ sms_idnumber必须
├─ ent_wechat_textstring必须
├─ variablestring必须
├─ urlstring必须
├─ typenumber必须
├─ add_timenumber必须

编辑消息通知

基本信息

Path: /adminapi/setting/notification/info

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 通知id
type 是 通知类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ markstring非必须
├─ namestring非必须
├─ titlestring非必须
├─ is_systemnumber非必须
├─ is_appnumber非必须
├─ is_wechatnumber非必须
├─ is_routinenumber非必须
├─ is_smsnumber非必须
├─ is_ent_wechatnumber非必须
├─ system_titlestring非必须
├─ system_textstring非必须
├─ app_idnumber非必须
├─ wechat_idstring非必须
├─ routine_idstring非必须
├─ sms_idnumber非必须
├─ ent_wechat_textstring非必须
├─ variablestring非必须
├─ urlstring非必须
├─ typenumber非必须
├─ add_timenumber非必须
├─ contentstring非必须

应用->公众号->菜单

保存菜单

基本信息

Path: /adminapi/app/wechat/menu

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
button text 是 appid: "112"

name: "111"
pagepath: "3333"
sub_button: [{type: "click", name: "222", url: "123.com", key: "1212"},…]
0: {type: "click", name: "222", url: "123.com", key: "1212"}
1: {type: "view", name: "33", url: "http://crmeb.my"}
type: "view"
url: "http://crmeb.my" | type:click-关键字 view-跳转网页 miniprogram-小程序 |

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

获取菜单值

基本信息

Path: /adminapi/app/wechat/menu

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ menusobject []非必须

item 类型: object

├─ typestring必须
├─ namestring必须
├─ sub_buttonobject []必须

item 类型: object

├─ typestring必须
├─ namestring必须
├─ urlstring必须
├─ keystring必须
├─ appidstring非必须
├─ pagepathstring非必须
├─ keystring必须
├─ urlstring必须
├─ appidstring非必须
├─ pagepathstring非必须

应用->公众号->微信模板消息

修改状态

基本信息

Path: /adminapi/app/wechat/template/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id
status 1 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

列表

基本信息

Path: /adminapi/app/wechat/template

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
name 否 订单发货 模板名
status 否 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ industryobject非必须
├─ primary_industrystring非必须
├─ secondary_industrystring非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ typenumber必须
├─ tempkeystring必须
├─ namestring必须
├─ kidstring必须
├─ contentstring []必须

item 类型: string

├─ 非必须
├─ tempidstring必须
├─ add_timestring必须
├─ statusnumber必须

删除

基本信息

Path: /adminapi/app/wechat/template/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增操作

基本信息

Path: /adminapi/app/wechat/template

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
tempkey text 是 模板编号
tempid text 是 模板ID
name text 是 模板名
content text 是 回复内容
status text 是 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增表单

基本信息

Path: /adminapi/app/wechat/template/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑操作

基本信息

Path: /adminapi/app/wechat/template/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id

Body

参数名称 参数类型 是否必须 示例 备注
tempid text 是 模板id
status text 是 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/app/wechat/template/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 模板id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

应用->公众号->图文管理

保存图文

基本信息

Path: /adminapi/app/wechat/news

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 0 图文id 新增时为0
list text 是 list[0][id]: 0

list[0][title]: 文章标题
list[0][author]: admin
list[0][content]:


list[0][image_input]: http://cos.zhenglu.vip/fd391201911061021454043.jpg
list[0][synopsis]: 1521 | 文章数据数组 |

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

删除图文

基本信息

Path: /adminapi/app/wechat/news/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 图文id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

图文列表

基本信息

Path: /adminapi/app/wechat/news

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
cate_name 否 前景分析 图文名称模糊搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ cate_namestring必须
├─ sortnumber必须
├─ statusnumber必须
├─ new_idstring必须
├─ add_timestring必须
├─ newobject []必须

item 类型: object

├─ idnumber非必须
├─ cidstring非必须
├─ titlestring非必须
├─ authorstring非必须
├─ image_inputstring []非必须

item 类型: string

├─ 非必须
├─ synopsisstring非必须
├─ share_titlenull非必须
├─ share_synopsisnull非必须
├─ visitstring非必须
├─ sortnumber非必须
├─ urlnull非必须
├─ statusnumber非必须
├─ add_timestring非必须
├─ hidenumber非必须
├─ admin_idnumber非必须
├─ mer_idnumber非必须
├─ product_idnumber非必须
├─ is_hotnumber非必须
├─ is_bannernumber非必须

图文详情

基本信息

Path: /adminapi/app/wechat/news/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 图文id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ cate_namestring非必须
├─ sortnumber非必须
├─ statusnumber非必须
├─ new_idstring非必须
├─ add_timestring非必须
├─ newobject []非必须

item 类型: object

├─ idnumber非必须
├─ cidstring非必须
├─ titlestring非必须
├─ authorstring非必须
├─ image_inputstring []非必须

item 类型: string

├─ 非必须
├─ synopsisstring非必须
├─ share_titlenull非必须
├─ share_synopsisnull非必须
├─ visitstring非必须
├─ sortnumber非必须
├─ urlnull非必须
├─ statusnumber非必须
├─ add_timestring非必须
├─ hidenumber非必须
├─ admin_idnumber非必须
├─ mer_idnumber非必须
├─ product_idnumber非必须
├─ is_hotnumber非必须
├─ is_bannernumber非必须
├─ contentstring非必须

应用->公众号->自动回复->微信关注回复

获取(关注、无效关键词)回复内容

基本信息

Path: /adminapi/app/wechat/reply

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
key 是 default subscribe 关键词subscribe:关注 default :无效关键词

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idstring非必须
├─ keystring非必须关键词
├─ typestring非必须回复类型
├─ datastring非必须回复内容
├─ statusstring非必须状态 1-启用 0- 禁用
├─ hidestring非必须是否隐藏 0-否 1-是

添加/修改关键词

基本信息

Path: /adminapi/app/wechat/keyword/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 回复内容id 新增时传0

Body

参数名称 参数类型 是否必须 示例 备注
key text 是 测试,111,元旦,222 关键词字符串
type text 是 text 回复类型 text-文本 image-图片 news-图文 voice-语音
status text 是 1 状态
data text 是 {src: "/uploads/wechat/image/20191204/debd1617a9dd3dbcc601cbb2d9cc86cf.jpg"} 回复内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

应用->公众号->自动回复

修改关键词状态

基本信息

Path: /adminapi/app/wechat/keyword/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 回复内容id
status 1 状态 1-启用 0-禁用

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

关键词列表

基本信息

Path: /adminapi/app/wechat/keyword

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 15 每页条数
key 否 fs 关键词模糊搜索
type 否 text 回复类型 text-文本 image-图片 news-图文 voice-语音

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ typestring必须
├─ dataobject必须
├─ contentstring非必须
├─ statusnumber必须
├─ hidenumber必须
├─ keysstring必须
├─ typeNamestring必须
├─ keystring必须
├─ countnumber非必须

删除关键词

基本信息

Path: /adminapi/app/wechat/keyword/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 回复内容id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

回复详情

基本信息

Path: /adminapi/app/wechat/keyword/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 回复内容id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idnumber非必须
├─ typestring非必须
├─ dataobject非必须
├─ contentstring非必须
├─ statusnumber非必须
├─ hidenumber非必须
├─ keystring非必须

获取二维码

基本信息

Path: /adminapi/app/wechat/code_reply/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 关键词

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ third_typestring非必须
├─ third_idnumber非必须
├─ ticketstring非必须
├─ expire_secondsnumber非必须
├─ statusnumber非必须
├─ add_timestring非必须
├─ urlstring非必须
├─ qrcode_urlstring非必须
├─ scannumber非必须
├─ typenumber非必须

应用->公众号-->微信用户管理(已废弃)

修改分组

基本信息

Path: /adminapi/app/wechat/user_group/:openid

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
openid 用户openid

Body

参数名称 参数类型 是否必须 示例 备注
group_id text 是 12 分组id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改用户分组表单

基本信息

Path: /adminapi/app/wechat/user_group/:openid/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
openid 用户openid

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

修改用户标签

基本信息

Path: /adminapi/app/wechat/user_tag/:openid

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
openid openid

Body

参数名称 参数类型 是否必须 示例 备注
tag_id text 是 标签id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改用户标签表单

基本信息

Path: /adminapi/app/wechat/user_tag/:openid/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
openid 用户openid

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

分组列表

基本信息

Path: /adminapi/app/wechat/group

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ namestring非必须
├─ countstring非必须

删除分组

基本信息

Path: /adminapi/app/wechat/group/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分组id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除标签

基本信息

Path: /adminapi/app/wechat/tag/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 标签id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

同步标签

基本信息

Path: /adminapi/app/wechat/syn_tag/:openid

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
openid 用户openid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

操作名称列表

基本信息

Path: /adminapi/app/wechat/action/operate

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须

标签列表

基本信息

Path: /adminapi/app/wechat/tag

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ namestring非必须
├─ countstring非必须

添加分组

基本信息

Path: /adminapi/app/wechat/group

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分组名

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

添加分组表单

基本信息

Path: /adminapi/app/wechat/group/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

添加标签

基本信息

Path: /adminapi/app/wechat/tag

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 标签名

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

添加标签表单

基本信息

Path: /adminapi/app/wechat/tag/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

用户列表

基本信息

Path: /adminapi/app/wechat/user

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
nickname 否 阿杜 微信昵称
data 否 week 时间选择 today 今天 week month year yesterday quarter lately7 lately30
tagid_list 否 1,2,3 标签id组成的字符串
groupid 否 2 分组id
sex 否 1 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知
export 否 0 输出方式 1-导出 其他为列表
subscribe 否 1 是否关注 1-是 0-否

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ uidinteger非必须用户id
├─ openidstring非必须
├─ nicknamestring非必须微信昵称
├─ headimgurlstring非必须头像
├─ sexstring非必须性别
├─ countrystring非必须国家
├─ provincestring非必须省份
├─ citystring非必须城市
├─ subscribestring非必须是否关注
├─ groupidstring非必须分组id
├─ tagid_liststring非必须标签id
├─ groupListobject []非必须分组列表

item 类型: object

├─ idstring非必须分组id
├─ namestring非必须分组名称
├─ tagListobject []非必须标签列表

item 类型: object

├─ idstring非必须标签id
├─ namestring非必须标签名称

用户行为列表

基本信息

Path: /adminapi/app/wechat/action

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
limit 否 20
nickname 否 昵称
type 否 类型
data 否 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countinteger非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ nicknamestring非必须
├─ type_namestring非必须操作名称
├─ result_arrobject []非必须

item 类型: object

├─ msgstring非必须关联内容
├─ add_timestring非必须操作时间

编辑分组

基本信息

Path: /adminapi/app/wechat/group/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分组id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分组名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑分组表单

基本信息

Path: /adminapi/app/wechat/group/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 分组id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

编辑标签

基本信息

Path: /adminapi/app/wechat/tag/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 标签id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 标签名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑标签表单

基本信息

Path: /adminapi/app/wechat/tag/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 标签id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

获取用户分组和标签

基本信息

Path: /adminapi/app/wechat/user/tag_group

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ groupListobject []非必须分组列表

item 类型: object

├─ idstring非必须分组id
├─ namestring非必须分组名称
├─ tagListobject []非必须标签列表

item 类型: object

├─ idstring非必须标签id
├─ namestring非必须标签名称

微信用户导出

基本信息

Path: /adminapi/export/wechatUser

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页数
limit 否 20 每页条数
nickname 否
data 否
tagid_list 否
groupid 否
sex 否
subscribe 否

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject必须excel文件地址

应用->小程序->小程序订阅消息

一键同步订阅消息

基本信息

Path: /adminapi/app/routine/syncSubscribe

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改状态

基本信息

Path: /adminapi/app/routine/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id
status 1 开启

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

列表

基本信息

Path: /adminapi/app/routine

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 每页条数
name 否 发货提醒 模板名
status 否 1 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ industryobject非必须
├─ primary_industrystring非必须
├─ secondary_industrystring非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ typenumber必须
├─ tempkeystring必须
├─ namestring必须
├─ kidstring必须
├─ contentstring []必须

item 类型: string

├─ 非必须
├─ tempidstring必须
├─ add_timestring必须
├─ statusnumber必须

删除

基本信息

Path: /adminapi/app/routine/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

新增操作

基本信息

Path: /adminapi/app/routine

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
tempkey text 是 模板编号
tempid text 是 模板ID
name text 是 模板名
content text 是 回复内容
status text 是 状态 1-开启 0-关闭

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

新增表单

基本信息

Path: /adminapi/app/routine/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑操作

基本信息

Path: /adminapi/app/routine/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 模板id

Body

参数名称 参数类型 是否必须 示例 备注
tempid text 是 模板ID
status text 是 1-开启 0-关闭 状态

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/app/routine/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 模板id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring必须
├─ valuenumber必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

维护-开发配置-配置分类

修改配置分类状态

基本信息

Path: /adminapi/setting/config_class/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类
status 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除配置分类

基本信息

Path: /adminapi/setting/config_class/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增配置分类

基本信息

Path: /adminapi/setting/config_class

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
eng_title text 是 wechat 分类字段
status text 是 1 状态 1-显示 2-隐藏
title text 是 公众号配置 分类昵称
icon text 是 weixin 图标
type text 是 0 类型 0-系统 1-应用 2-支付 3-其他
sort text 是 排序
pid text 是 父类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增配置分类表单

基本信息

Path: /adminapi/setting/config_class/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ heightstring非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑配置分类

基本信息

Path: /adminapi/setting/config_class/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置id

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 公众号配置 分类昵称
status text 是 1 状态 1-显示 2-隐藏
eng_title text 是 wechat 分类字段
icon text 是 weixin 图标
type text 是 0 类型 0-系统 1-应用 2-支付 3-其他
sort text 是 排序
pid text 是 父类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑配置分类表单

基本信息

Path: /adminapi/setting/config_class/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 配置分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ typestring非必须
├─ maxLengthnumber非必须
├─ titlestring非必须
├─ srcstring非必须
├─ iconstring非必须
├─ heightstring非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

配置分类列表

基本信息

Path: /adminapi/setting/config_class

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 15 每页条数
status 否 1 状态 1-显示 0-不显示
title 否 商城 分类昵称模糊搜索

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ titlestring必须
├─ eng_titlestring必须
├─ statusnumber必须
├─ infonumber必须
├─ iconstring必须
├─ typenumber必须
├─ sortnumber必须
├─ childrenobject []必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ titlestring必须
├─ eng_titlestring必须
├─ statusnumber必须
├─ infonumber必须
├─ iconstring必须
├─ typenumber必须
├─ sortnumber必须
├─ countnumber非必须

配置列表

基本信息

Path: /adminapi/setting/config

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
tab_id 是 1 配置分类id
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ menu_namestring必须
├─ typestring必须
├─ input_typestring,null必须
├─ config_tab_idnumber必须
├─ parameternull,string必须
├─ upload_typenull,number必须
├─ requiredstring,null必须
├─ widthnumber必须
├─ highnull,number必须
├─ valuestring必须
├─ infostring必须
├─ descstring必须
├─ sortnumber必须
├─ statusnumber必须

配置详情

基本信息

Path: /adminapi/setting/config/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 配置id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idinteger非必须配置id
├─ menu_namestring非必须字段名称
├─ typestring非必须类型(文本框,单选按钮...)
├─ input_typestring非必须表单类型
├─ config_tab_idinteger非必须配置分类id
├─ parameterstring非必须规则 单选框和多选框
├─ upload_typeinteger非必须上传文件格式1单图2多图3文件
├─ requiredstring非必须规则
├─ widthstring非必须多行文本框的宽度
├─ highstring非必须多行文框的高度
├─ valuestring非必须默认值
├─ infostring非必须配置名称
├─ descstring非必须配置简介
├─ sortstring非必须排序
├─ statusstring非必须是否隐藏

新增配置表单

基本信息

Path: /adminapi/setting/config/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 0 类型 0-文本框 1-多行文本框 2-单选框 3-文件上传 4-多选框 5-下拉框
tab_id 否 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ typestring非必须
├─ autofocusboolean非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber,string必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

新增配置

基本信息

Path: /adminapi/setting/config

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
menu_name text 是
type text 是
input_type text 是
config_tab_id text 是
parameter text 是
upload_type text 是
required text 是
width text 是
high text 是
value text 是
info text 是
desc text 是
sort text 是
status text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑配置表单

基本信息

Path: /adminapi/setting/config/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 配置id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ disabledboolean非必须
├─ multipleboolean非必须
├─ autofocusboolean非必须
├─ optionsobject []必须

item 类型: object

├─ valuenumber,string必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

编辑配置

基本信息

Path: /adminapi/setting/config/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置id

Body

参数名称 参数类型 是否必须 示例 备注
type text 是 字段类型 text/upload
input_type text 是 表单类型
config_tab_id text 是 配置分类id
parameter text 是 0=>明文模式

1=>兼容模式
2=>安全模式 | 规则 单选框和多选框 |
| upload_type | text | 是 | 1 | 上传文件格式1单图2多图3文件 |
| required | text | 是 | required:true required:true,url:true | 规则 |
| value | text | 是 | | 默认值 |
| info | text | 是 | | 配置名称 |
| desc | text | 是 | | 配置简介 |
| sort | text | 是 | | 排序 |
| status | text | 是 | 0-隐藏 1-显示 | 是否隐藏 |

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

删除配置

基本信息

Path: /adminapi/setting/config/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改状态

基本信息

Path: /adminapi/setting/config/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 配置id
status 1 1-显示 0-隐藏

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

配置上传文件

基本信息

Path: /adminapi/setting/config/upload

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ filepathstring非必须文件路径

维护*开发配置-组合数据

删除

基本信息

Path: /adminapi/setting/group/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增

基本信息

Path: /adminapi/setting/group

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 数据组名称
config_name text 是 数据字段 key
info text 是 简介
typelist text 是 ['name':'value'] 数据组字段以及类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

组合数据列表

基本信息

Path: /adminapi/setting/group

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 15 每页条数
keyword 否 秒杀 搜索关键字 config_name name info

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ idinteger非必须组合数据ID
├─ namestring非必须数据组名称
├─ infostring非必须数据提示
├─ config_namestring非必须数据字段
├─ fieldsstring非必须数据组字段以及类型(json数据)

组合数据详情

基本信息

Path: /adminapi/setting/group/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ infoobject非必须
├─ idinteger非必须组合数据ID
├─ namestring非必须数据组名称
├─ infostring非必须数据提示
├─ config_namestring非必须数据字段
├─ fieldsstring非必须数据组字段以及类型(json数据)

编辑

基本信息

Path: /adminapi/setting/group/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 组合数据id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是
config_name text 是
info text 是
typelist text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

维护->安全维护->刷新缓存

刷新缓存

基本信息

Path: /adminapi/system/refresh_cache/cache

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

清除日志

基本信息

Path: /adminapi/system/refresh_cache/log

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

维护->安全维护->系统日志

系统日志管理员搜索条件

基本信息

Path: /adminapi/system/log/search_admin

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ infoobject []非必须

item 类型: object

├─ idnumber必须
├─ real_namestring必须

系统日志

基本信息

Path: /adminapi/system/log

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
pages 否 行为
path 否 链接
ip 否 ip
admin_id 否 管理员id
data 否 时间选择

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ admin_idnumber必须
├─ admin_namestring必须
├─ pathstring必须
├─ pagestring必须
├─ methodstring必须
├─ ipstring必须
├─ typestring必须
├─ add_timenumber必须
├─ merchant_idnumber必须
├─ countnumber非必须

维护->安全维护->文件校验

保存文件内容(已废弃)

基本信息

Path: /adminapi/system/file/savefile

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
comment text 是 文件内容
filepath text 是 文件路径

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

打开目录(已废弃)

基本信息

Path: /adminapi/system/file/opendir

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
dir 是 当前目录
superior 否 是否返回上级 是-非0
filedir 是 文件夹名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ filenamestring非必须文件/文件夹名
├─ pathnamestring非必须文件/文件夹路径
├─ sizestring非必须文件/文件夹大小
├─ isWritableboolean非必须是否可写
├─ mtimestring非必须更新时间
├─ isDirboolean非必须是否为文件夹 true-是
├─ pathstring非必须当前路径

文件校验

基本信息

Path: /adminapi/system/file

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ filenamestring必须
├─ cthashstring必须
├─ atimestring必须
├─ mtimestring必须
├─ ctimestring必须
├─ typestring必须

读取文件(已废弃)

基本信息

Path: /adminapi/system/file/openfile

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
filepath 是 文件路径

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ contentstring非必须文件内容
├─ modestring非必须文件类型
├─ filepathstring非必须文件路径

维护->安全维护->清除数据

更换域名

基本信息

Path: /adminapi/system/replace_site_url

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
url text 是 http://www.crmeb.com 替换域名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

清除数据

基本信息

Path: /adminapi/system/clear/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type temp--清除用户生成的临时附件;
recycle--清除回收站产品;
store-清除商城数据;
category-清除产品分类;
order-清除订单数据;
kefu-清除客服数据;
wechat-清除微信管理数据;
attachment-清除所有附件;
article-清除内容分类;
system-清除系统记录

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

维护->安全维护->数据备份

获取表列表

基本信息

Path: /adminapi/system/backup

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ enginestring必须
├─ versionnumber必须
├─ row_formatstring必须
├─ rowsnumber必须
├─ avg_row_lengthnumber必须
├─ data_lengthnumber必须
├─ max_data_lengthnumber必须
├─ index_lengthnumber必须
├─ data_freenumber必须
├─ auto_incrementnumber,null必须
├─ create_timestring必须
├─ update_timenull,string必须
├─ check_timenull必须
├─ collationstring必须
├─ checksumnull必须
├─ create_optionsstring必须
├─ commentstring必须
├─ countnumber非必须

获取备份记录列表

基本信息

Path: /adminapi/system/backup/file_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ listobject []非必须

item 类型: object

├─ filenamestring非必须
├─ partnumber非必须
├─ sizestring非必须
├─ compressstring非必须
├─ backtimestring非必须
├─ timenumber非必须

查看表结构详情

基本信息

Path: /adminapi/system/backup/read

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
tablename 是 表名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ TABLE_CATALOGstring必须
├─ TABLE_SCHEMAstring必须
├─ TABLE_NAMEstring必须
├─ COLUMN_NAMEstring必须
├─ ORDINAL_POSITIONnumber必须
├─ COLUMN_DEFAULTnull,string必须
├─ IS_NULLABLEstring必须
├─ DATA_TYPEstring必须
├─ CHARACTER_MAXIMUM_LENGTHnull,number必须
├─ CHARACTER_OCTET_LENGTHnull,number必须
├─ NUMERIC_PRECISIONnumber,null必须
├─ NUMERIC_SCALEnumber,null必须
├─ CHARACTER_SET_NAMEnull,string必须
├─ COLLATION_NAMEnull,string必须
├─ COLUMN_TYPEstring必须
├─ COLUMN_KEYstring必须
├─ EXTRAstring必须
├─ PRIVILEGESstring必须
├─ COLUMN_COMMENTstring必须
├─ countnumber非必须

优化表

基本信息

Path: /adminapi/system/backup/optimize

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
tables text 是 [eb_article,eb_article_category] 表名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修复表

基本信息

Path: /adminapi/system/backup/repair

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
tables text 是 [eb_article,eb_article_category] 表名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

备份表

基本信息

Path: /adminapi/system/backup/backup

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
tables text 是 [eb_article,eb_article_category] 表名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除备份记录

基本信息

Path: /adminapi/system/backup/del_file

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
filename text 是 文件名

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

导入备份记录表

基本信息

Path: /adminapi/system/backup/import

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
part text 是
start text 是
time text 是

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

下载备份记录表

基本信息

Path: /adminapi/backup/download

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
time 是 备份时间戳

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ keystring非必须

维护->物流公司

修改状态

基本信息

Path: /adminapi/freight/express/set_status/:id/:status

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 公司id
status 1 状态

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

列表

基本信息

Path: /adminapi/freight/express

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否
limit 否
keyword 否 物流公司名称或者编码

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ countstring非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ codestring非必须物流公司名称
├─ namestring非必须编码
├─ sortstring非必须排序
├─ is_showstring非必须是否显示

删除(已废弃)

基本信息

Path: /adminapi/freight/express/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

同步物流公司

基本信息

Path: /adminapi/freight/express/sync_express

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

新增表单(已废弃)

基本信息

Path: /adminapi/freight/express/create

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validateobject非必须
├─ colobject非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

新增(已废弃)

基本信息

Path: /adminapi/freight/express

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 公司名称
code text 是 编码
sort text 是 10 排序
is_show text 是 是否启用

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑

基本信息

Path: /adminapi/freight/express/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 物流公司id

Body

参数名称 参数类型 是否必须 示例 备注
account text 否 月结账号
key text 否 月结密钥
sort text 是 排序
is_show text 是 是否启用
net_name text 否 网点名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

编辑表单

基本信息

Path: /adminapi/freight/express/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 记录id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuestring,number必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ optionsobject []非必须

item 类型: object

├─ valuenumber必须
├─ labelstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

维护->城市数据

删除城市数据

基本信息

Path: /adminapi/setting/city/del/:city_id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
city_id 城市city_id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

城市修改表单

基本信息

Path: /adminapi/setting/city/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 城市编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ readonlyboolean非必须
├─ validateobject []必须

item 类型: object

├─ messagestring必须
├─ requiredboolean必须
├─ typestring必须
├─ triggerstring必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

城市列表

基本信息

Path: /adminapi/setting/city/list/:parent_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
parent_id 0 父级ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ city_idnumber必须
├─ levelnumber必须
├─ parent_idstring必须
├─ area_codestring必须
├─ namestring必须
├─ merger_namestring必须
├─ lngstring必须
├─ latstring必须
├─ is_shownumber必须

城市添加表单

基本信息

Path: /adminapi/setting/city/add/:parent_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
parent_id 0 上级ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring必须
├─ fieldstring必须
├─ valuenumber,string必须
├─ titlestring必须
├─ propsobject必须
├─ typestring非必须
├─ placeholderstring非必须
├─ readonlyboolean非必须
├─ validateobject []非必须

item 类型: object

├─ messagestring非必须
├─ requiredboolean非必须
├─ typestring非必须
├─ triggerstring非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须
├─ infostring非必须
├─ statusboolean非必须

添加/修改城市数据

基本信息

Path: /adminapi/setting/city/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 城市编号,新增为0
name text 是 城市名称
merger_name text 是 合并名称
area_code text 是 城市代码
lng text 是 经度
lat text 是 纬度
level text 是 上级城市等级
parent_id text 是 上级城市city_id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

清除城市数据缓存

基本信息

Path: /adminapi/setting/city/clean_cache

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

维护->附件管理->附件分类管理

修改分类

基本信息

Path: /adminapi/files/attachment_category/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 附件分类id

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分类名称
pid text 是 父级id

返回数据

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

分类列表

基本信息

Path: /adminapi/files/attachment_category

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 nopage 不分页参数

返回数据

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

删除分类

基本信息

Path: /adminapi/files/attachment_category/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

添加分类

基本信息

Path: /adminapi/files/attachment_category

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 分类名称
pid text 是 父级id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

维护->附件管理->附件图片管理

修改附件名称

基本信息

Path: /adminapi/file/file/update/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 附件att_id

Body

参数名称 参数类型 是否必须 示例 备注
real_name text 是 附件名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ srcstring非必须

附件列表

基本信息

Path: /adminapi/file/file

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pid 否 0 分类id
page 否 1 页码
limit 否 10 每页数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countstring非必须总数量
├─ listobject []非必须

item 类型: object

├─ att_idinteger非必须附件id
├─ namestring非必须附件名称
├─ real_namestring非必须附件原始名
├─ att_dirstring非必须附件路径
├─ satt_dirstring非必须压缩图片路径
├─ att_sizestring非必须附件大小
├─ att_typestring非必须附件类型
├─ pidinteger非必须分类ID0编辑器,1产品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图
├─ timeinteger非必须上传时间
├─ image_typeinteger非必须图片上传类型 1本地 2七牛云 3OSS 4COS
├─ module_typeinteger非必须图片上传模块类型 1 后台上传 2 用户生成

附件图片上传

基本信息

Path: /adminapi/files/attac_upload

Method: POST

接口描述:

请求参数

Headers

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

Body

参数名称 参数类型 是否必须 示例 备注
file file 是 上传对象

返回数据

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

附件删除

基本信息

Path: /adminapi/file/file/delete

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 1,2,3 图片id拼接成的字符串

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

图片上传

基本信息

Path: /adminapi/file/upload/:?upload_type

Method: POST

接口描述:

请求参数

Headers

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

路径参数

参数名称 示例 备注
?upload_type 0 上传类型

Body

参数名称 参数类型 是否必须 示例 备注
pid text 是 1 分类id
file file 是 要上传的图片

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
srcstring非必须

修改附件分类表单

基本信息

Path: /adminapi/file/file/move

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
images 是 1 图片id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validatestring []非必须

item 类型: string

├─ 非必须
├─ colstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

修改附件分类

基本信息

Path: /adminapi/file/file/do_move

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pid text 是 1 附件分类id
images text 是 1,2,3 附件id拼接成的字符串

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

附件分类列表

基本信息

Path: /adminapi/file/category

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
name 否 分类名称

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须附id
├─ pidstring非必须分类id
├─ namestring非必须分类名称
├─ ennamestring非必须分类目录
├─ childobject []非必须子分类信息

item 类型: object

├─ idstring非必须
├─ pidstring非必须
├─ namestring非必须
├─ enamestring非必须
├─ childstring []非必须

item 类型: string

├─ 非必须

新增分类表单

基本信息

Path: /adminapi/file/category/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validatestring []非必须

item 类型: string

├─ 非必须
├─ colstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

新增分类

基本信息

Path: /adminapi/file/category

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pid text 是 6 父级id
name text 是 分类名称

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

编辑分类表单

基本信息

Path: /adminapi/file/category/:id/edit

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
dataobject非必须
├─ rulesobject []非必须

item 类型: object

├─ typestring非必须
├─ fieldstring非必须
├─ titlestring非必须
├─ valuestring非必须
├─ propsobject非必须
├─ multipleboolean非必须
├─ placeholderstring非必须
├─ filterableboolean非必须
├─ optionsobject []非必须

item 类型: object

├─ labelstring非必须
├─ valuestring非必须
├─ validatestring []非必须

item 类型: string

├─ 非必须
├─ colstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ actionstring非必须
├─ methodstring非必须

编辑分类

基本信息

Path: /adminapi/file/category/:id

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类id

Body

参数名称 参数类型 是否必须 示例 备注
pid text 是 父级id
name text 是 分类名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

删除分类

基本信息

Path: /adminapi/file/category/:id

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id 1 分类id

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须

维护->商业授权

查询授权

基本信息

Path: /adminapi/auth

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusnumber非必须
├─ daynumber非必须

申请授权

基本信息

Path: /adminapi/auth_apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
company_name text 是 公司名称
domain_name text 是 授权域名
order_id text 是 订单id
label text 是 http://authorize.crmeb.net/api/auth_label 接口返回的id pro版本取值id=3
captcha text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须200申请成功,400申请失败
msgstring非必须提示语

验证授权

基本信息

Path: /adminapi/check_auth

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ daynumber非必须过期天数,非必须
├─ authboolean非必须是否授权

Build by YMFE.