更新记录
1.0.2(2023-05-29) 下载此版本
更改分类展示
1.0.1(2023-05-26) 下载此版本
1:添加产品包权益赠送
1.0.0(2023-05-26) 下载此版本
1:更改分销模式 2:新增产品包功能 3:新增中转仓功能
查看更多平台兼容性
Vue2 | Vue3 |
---|---|
√ | √ |
App | 快应用 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ小程序 |
---|---|---|---|---|---|---|
HBuilderX 3.8.3 | × | √ | × | × | × | × |
钉钉小程序 | 快手小程序 | 飞书小程序 | 京东小程序 |
---|---|---|---|
× | × | × | × |
H5-Safari | Android Browser | 微信浏览器(Android) | QQ浏览器(Android) | Chrome | IE | Edge | Firefox | PC-Safari |
---|---|---|---|---|---|---|---|---|
× | × | × | × | √ | √ | √ | √ | √ |
crmeb_java_front
crmeb_java_front
上传文件
图片上传
基本信息
Path: /api/front/user/upload/image
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | multipart/form-data | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
model | 否 | 模块 用户user,商品product,微信wechat,news文章 | |
pid | 否 | 分类ID 0编辑器,1商品图片,2拼团图片,3砍价图片,4秒杀图片,5文章图片,6组合数据图,7前台用户,8微信系列 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
multipart | file | 否 | multipart |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ extName | string | 非必须 | |||
├─ fileName | string | 非必须 | |||
├─ fileSize | integer | 非必须 | format: int64 | ||
├─ serverPath | string | 非必须 | |||
├─ type | string | 非必须 | |||
├─ url | string | 非必须 | |||
message | string | 非必须 |
二维码服务
获取二维码
基本信息
Path: /api/front/qrcode/get
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
远程图片转base64
基本信息
Path: /api/front/qrcode/base64
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
url | 是 | url |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
优惠券
分页列表
基本信息
Path: /api/front/coupons
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 | |
productId | 否 | productId | |
type | 否 | type |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ day | integer | 非必须 | 天数 | format: int32 | |
├─ id | integer | 非必须 | 优惠券表ID | format: int32 | |
├─ isDel | boolean | 非必须 | 是否删除 状态(0:否,1:是) | ||
├─ isFixedTime | boolean | 非必须 | 是否固定使用时间, 默认0 否, 1是 | ||
├─ isLimited | boolean | 非必须 | 是否限量, 默认0 不限量, 1限量 | ||
├─ isUse | boolean | 非必须 | 是否已领取未使用 | ||
├─ lastTotal | integer | 非必须 | 剩余数量 | format: int32 | |
├─ minPrice | number | 非必须 | 最低消费,0代表不限制 | ||
├─ money | number | 非必须 | 兑换的优惠券面值 | ||
├─ name | string | 非必须 | 优惠券名称 | ||
├─ primaryKey | string | 非必须 | 所属商品id / 分类id | ||
├─ receiveEndTime | string | 非必须 | 可领取结束时间 | format: date-time | |
├─ receiveStartTime | string | 非必须 | 可领取开始时间 | format: date-time | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态(0:关闭,1:开启) | ||
├─ total | integer | 非必须 | 发放总数 | format: int32 | |
├─ type | integer | 非必须 | 优惠券类型 0-通用 1 普通券, 2 新人券, 3 购买商品赠送券, 4 付费会员券 | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ useEndTime | string | 非必须 | 可使用时间范围 结束时间 | format: date-time | |
├─ useStartTime | string | 非必须 | 可使用时间范围 开始时间 | format: date-time | |
message | string | 非必须 |
当前购物车可用优惠券
基本信息
Path: /api/front/coupons/order
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
cartId | 是 | cartId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ cid | integer | 非必须 | 兑换的项目id | format: int32 | |
├─ couponId | integer | 非必须 | 优惠券发布id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ id | integer | 非必须 | id | format: int32 | |
├─ minPrice | number | 非必须 | 最低消费多少金额可用优惠券 | ||
├─ money | number | 非必须 | 优惠券的面值 | ||
├─ name | string | 非必须 | 优惠券名称 | ||
├─ primaryKey | string | 必须 | 主键id 商品id/分类id | ||
├─ receiveEndTime | string | 非必须 | 过期时间 | format: date-time | |
├─ receiveStartTime | string | 非必须 | 开始使用时间 | format: date-time | |
├─ status | integer | 非必须 | 状态(0:未使用,1:已使用, 2:已失效) | format: int32 | |
├─ type | string | 非必须 | 获取方式 | ||
├─ uid | integer | 非必须 | 领取人id | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ useTime | string | 非必须 | 使用时间 | format: date-time | |
├─ useType | integer | 非必须 | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32 | |
message | string | 非必须 |
商品
为你推荐
基本信息
Path: /api/front/product/hot
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
商品列表
基本信息
Path: /api/front/products
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
cid | 否 | 分类id | |
keyword | 否 | 搜索关键字 | |
limit | 否 | 每页数量 | |
news | 否 | 是否新品 | |
page | 否 | 页码 | |
priceOrder | 否 | 价格排序 | |
salesOrder | 否 | 销量排序 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
商品评论列表
基本信息
Path: /api/front/reply/list/{id}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | id |
Query
参数名称 | 是否必须 | 示例 | 备注 | |
---|---|---|---|---|
limit | 否 | 每页数量 | ||
page | 否 | 页码 | ||
type | 否 | 评价等级 | 0=全部,1=好评,2=中评,3=差评 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ avatar | string | 非必须 | 用户头像 | ||
├─ comment | string | 非必须 | 评论内容 | ||
├─ createTime | string | 非必须 | 评论时间 | format: date-time | |
├─ id | integer | 非必须 | 评论ID | format: int32 | |
├─ isDel | boolean | 非必须 | 0未删除1已删除 | ||
├─ isReply | boolean | 非必须 | 0未回复1已回复 | ||
├─ merchantReplyContent | string | 非必须 | 管理员回复内容 | ||
├─ merchantReplyTime | integer | 非必须 | 管理员回复时间 | format: int32 | |
├─ nickname | string | 非必须 | 用户名称 | ||
├─ oid | integer | 非必须 | 订单ID | format: int32 | |
├─ pics | string [] | 非必须 | 评论图片 | item 类型: string | |
├─ | 非必须 | ||||
├─ productId | integer | 非必须 | 商品id | format: int32 | |
├─ productScore | integer | 非必须 | 商品分数 | format: int32 | |
├─ replyType | string | 非必须 | 某种商品类型(普通商品、秒杀商品) | ||
├─ serviceScore | integer | 非必须 | 服务分数 | format: int32 | |
├─ storeProduct | object | 非必须 | 商品表 | ||
├─ activity | string | 非必须 | 活动显示排序1=秒杀,2=砍价,3=拼团 | ||
├─ addTime | integer | 非必须 | 添加时间 | format: int32 | |
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ browse | integer | 非必须 | 浏览量 | format: int32 | |
├─ cateId | string | 非必须 | 分类id | ||
├─ codePath | string | 非必须 | 商品二维码地址(用户小程序海报) | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ ficti | integer | 非必须 | 虚拟销量 | format: int32 | |
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isBargain | boolean | 非必须 | 砍价状态 0未开启 1开启 | ||
├─ isBenefit | boolean | 非必须 | 是否优惠 | ||
├─ isBest | boolean | 非必须 | 是否精品 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ isGood | boolean | 非必须 | 是否优品推荐 | ||
├─ isHot | boolean | 非必须 | 是否热卖 | ||
├─ isNew | boolean | 非必须 | 是否新品 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSeckill | boolean | 非必须 | 秒杀状态 0 未开启 1已开启 | ||
├─ isShow | boolean | 非必须 | 状态(0:未上架,1:上架) | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ merUse | boolean | 非必须 | 商户是否代理 0不可代理1可代理 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ soureLink | string | 非必须 | 淘宝京东1688类型 | ||
├─ specType | boolean | 非必须 | 规格 0单 1多 | ||
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ videoLink | string | 非必须 | 主图视频链接 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
├─ uid | integer | 非必须 | 用户ID | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
商品评论数量
基本信息
Path: /api/front/reply/config/{id}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 产品评价数量和好评度 | ||
├─ goodCount | integer | 非必须 | 好评总数 | format: int64 | |
├─ inCount | integer | 非必须 | 中评总数 | format: int64 | |
├─ poorCount | integer | 非必须 | 差评总数 | format: int64 | |
├─ replyChance | string | 非必须 | 好评率 | ||
├─ replyStar | integer | 非必须 | 评分星数 | format: int32 | |
├─ sumCount | integer | 非必须 | 评论总数 | format: int64 | |
message | string | 非必须 |
商品详情
基本信息
Path: /api/front/product/detail/{id}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 商品详情H5 | ||
├─ activity | object [] | 非必须 | 拼团,砍价,秒杀商品集合 | item 类型: object | |
├─ base64Image | string | 非必须 | 主图base64 | ||
├─ goodList | object [] | 非必须 | 优品推荐列表 | item 类型: object | |
├─ activity | object [] | 非必须 | 秒杀,团购,砍价 | item 类型: object | |
├─ checkCoupon | boolean | 非必须 | 可用优惠券 | ||
├─ id | integer | 非必须 | id | format: int32 | |
├─ image | string | 非必须 | img Url | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ priceName | string | 非必须 | 返佣金额区间 | ||
├─ productAttr | object [] | 非必须 | 产品属性 | item 类型: object | |
├─ productValue | object | 非必须 | 商品属性详情 | ||
├─ reply | object | 非必须 | 最新评价 | ||
├─ replyChance | integer | 非必须 | 好评率 | format: int32 | |
├─ replyCount | integer | 非必须 | 评价数量 | format: int32 | |
├─ storeInfo | object | 非必须 | 商品表 | ||
├─ activity | string | 非必须 | 活动显示排序1=秒杀,2=砍价,3=拼团 | ||
├─ addTime | integer | 非必须 | 添加时间 | format: int32 | |
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ browse | integer | 非必须 | 浏览量 | format: int32 | |
├─ cateId | string | 非必须 | 分类id | ||
├─ cateIds | integer [] | 非必须 | item 类型: integer | ||
├─ | 非必须 | ||||
├─ cateValues | string | 非必须 | 分类中文 | ||
├─ codePath | string | 非必须 | 商品二维码地址(用户小程序海报) | ||
├─ content | string | 非必须 | 商品描述 | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ ficti | integer | 非必须 | 虚拟销量 | format: int32 | |
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isBargain | boolean | 非必须 | 砍价状态 0未开启 1开启 | ||
├─ isBenefit | boolean | 非必须 | 是否优惠 | ||
├─ isBest | boolean | 非必须 | 是否精品 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ isGood | boolean | 非必须 | 是否优品推荐 | ||
├─ isHot | boolean | 非必须 | 是否热卖 | ||
├─ isNew | boolean | 非必须 | 是否新品 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSeckill | boolean | 非必须 | 秒杀状态 0 未开启 1已开启 | ||
├─ isShow | boolean | 非必须 | 状态(0:未上架,1:上架) | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ merUse | boolean | 非必须 | 商户是否代理 0不可代理1可代理 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ soureLink | string | 非必须 | 淘宝京东1688类型 | ||
├─ specType | boolean | 非必须 | 规格 0单 1多 | ||
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ userCollect | boolean | 非必须 | 收藏标识 | ||
├─ userLike | boolean | 非必须 | 点赞标识 | ||
├─ videoLink | string | 非必须 | 主图视频链接 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
message | string | 非必须 |
获取分类
基本信息
Path: /api/front/category
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ child | [] | 非必须 | |||
├─ | 非必须 | ||||
├─ extra | string | 非必须 | 扩展字段 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ name | string | 非必须 | 分类名称 | ||
├─ path | string | 非必须 | 路径 | ||
├─ pid | integer | 非必须 | 父级ID | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态, 0正常,1失效 | ||
├─ type | integer | 非必须 | 类型,类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置 | format: int32 | |
├─ url | string | 非必须 | 地址 | ||
message | string | 非必须 |
商品 -- 购物车
修改
基本信息
Path: /api/front/cart/num
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 是 | id | |
number | 是 | number |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
分页列表
基本信息
Path: /api/front/cart/list
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
isValid | 是 | isValid | |
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ addTime | string | 非必须 | |||
├─ attrStatus | boolean | 非必须 | 商品是否有效 | ||
├─ bargainId | integer | 非必须 | 砍价id | format: int32 | |
├─ brokerage | number | 非必须 | 一级分佣 | ||
├─ brokerageTwo | number | 非必须 | 二级分佣 | ||
├─ cartNum | integer | 非必须 | 商品数量 | format: int32 | |
├─ combinationId | integer | 非必须 | 拼团id | format: int32 | |
├─ costPrice | number | 非必须 | |||
├─ id | integer | 非必须 | 购物车表ID | format: int64 | |
├─ isNew | boolean | 非必须 | 是否为立即购买 | ||
├─ isReply | integer | 非必须 | format: int32 | ||
├─ productAttrUnique | string | 非必须 | 商品属性 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ productInfo | object | 非必须 | 商品信息,购物车列表使用 | ||
├─ attrInfo | object | 非必须 | 商品属性值表 | ||
├─ attrValue | string | 非必须 | 产品属性值和属性名对应关系 | ||
├─ barCode | string | 非必须 | 商品条码 | ||
├─ brokerage | number | 非必须 | 一级返佣 | ||
├─ brokerageTwo | number | 非必须 | 二级返佣 | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ id | integer | 非必须 | attrId | format: int32 | |
├─ image | string | 非必须 | 图片 | ||
├─ otPrice | number | 非必须 | 原价 | ||
├─ price | number | 非必须 | 属性金额 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ quota | integer | 非必须 | 活动限购数量 | format: int32 | |
├─ quotaShow | integer | 非必须 | 活动限购数量显示 | format: int32 | |
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ stock | integer | 非必须 | 属性对应的库存 | format: int32 | |
├─ suk | string | 非必须 | 商品属性索引值 (attr_value|attr_value[|....]) | ||
├─ type | integer | 非必须 | 活动类型 0=商品,1=秒杀,2=砍价,3=拼团 | format: int32 | |
├─ unique | string | 非必须 | 唯一值 | ||
├─ volume | number | 非必须 | 体积 | ||
├─ weight | number | 非必须 | 重量 | ||
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ cateId | string | 非必须 | 分类id | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
├─ seckillId | integer | 非必须 | 秒杀商品ID | format: int32 | |
├─ truePrice | number | 非必须 | |||
├─ trueStock | integer | 非必须 | format: int32 | ||
├─ type | string | 非必须 | 类型 | ||
├─ uid | integer | 非必须 | 用户ID | format: int32 | |
├─ vipTruePrice | number | 非必须 | |||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
删除
基本信息
Path: /api/front/cart/delete
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
ids | 是 | ids |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
数量
基本信息
Path: /api/front/cart/count
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
numType | 否 | numType |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
新增
基本信息
Path: /api/front/cart/save
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
cartNum | 是 | 商品数量 | |
isNew | 是 | 是否为立即购买 | |
productAttrUnique | 否 | 商品属性 -- attr 对象的id | |
productId | 是 | 商品ID |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
购物车重选提交
基本信息
Path: /api/front/cart/resetcart
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 非必须 | 购物车id | format: int64 | |
num | integer | 非必须 | 购物车数量 | format: int32 | |
productId | integer | 非必须 | 商品id | format: int32 | |
unique | integer | 非必须 | AttrValue Id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
城市服务
树形结构
基本信息
Path: /api/front/city/list
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
客服
客服列表
基本信息
Path: /api/front/user/service/lst
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ avatar | string | 非必须 | 客服头像 | ||
├─ createTime | string | 非必须 | 添加时间 | format: date-time | |
├─ customer | boolean | 非必须 | 是否展示统计管理 | ||
├─ id | integer | 非必须 | 客服id | format: int32 | |
├─ nickname | string | 非必须 | 代理名称 | ||
├─ notify | integer | 非必须 | 订单通知1开启0关闭 | format: int32 | |
├─ status | boolean | 非必须 | 0隐藏1显示 | ||
├─ uid | integer | 非必须 | 客服uid | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
message | string | 非必须 |
聊天记录
基本信息
Path: /api/front/user/service/record/{toUid}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
toUid | 聊天人编号 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ createTime | string | 非必须 | 添加时间 | format: date-time | |
├─ id | integer | 非必须 | 客服用户对话记录表ID | format: int32 | |
├─ msn | string | 非必须 | 消息内容 | ||
├─ msnType | boolean | 非必须 | 消息类型 1=文字 2=表情 3=图片 4=语音 | ||
├─ remind | boolean | 非必须 | 是否提醒过 | ||
├─ toUid | integer | 非必须 | 接收人uid | format: int32 | |
├─ type | boolean | 非必须 | 是否已读(0:否;1:是;) | ||
├─ uid | integer | 非必须 | 发送人uid | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
微信 -- 开放平台
小程序获取授权logo
基本信息
Path: /api/front/wechat/getLogo
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
微信登录公共号授权登录
基本信息
Path: /api/front/wechat/authorize/login
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
code | 是 | code |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ expiresTime | string | 非必须 | 用户登录密钥到期时间 | format: date-time | |
├─ token | string | 非必须 | 用户登录密钥 | ||
├─ user | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
微信登录小程序授权登录
基本信息
Path: /api/front/wechat/authorize/program/login
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
code | 是 | code |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
avatar | string | 必须 | 用户头像 | ||
city | string | 非必须 | 普通用户个人资料填写的城市 | ||
country | string | 非必须 | 国家,如中国为CN | ||
nickName | string | 必须 | 用户昵称 | ||
province | string | 非必须 | 用户个人资料填写的省份 | ||
sex | string | 必须 | 性别 | ||
spread_spid | integer | 必须 | 推广人id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ expiresTime | string | 非必须 | 用户登录密钥到期时间 | format: date-time | |
├─ token | string | 非必须 | 用户登录密钥 | ||
├─ user | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
获取微信公众号js配置
基本信息
Path: /api/front/wechat/config
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
url | 否 | 页面地址url |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
获取授权页面跳转地址
基本信息
Path: /api/front/wechat/authorize/get
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
详情
基本信息
Path: /api/front/wechat/info/{id}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 微信模板 | ||
├─ content | string | 非必须 | 回复内容 | ||
├─ createTime | string | 非必须 | 添加时间 | format: date-time | |
├─ id | integer | 非必须 | 模板id | format: int32 | |
├─ name | string | 非必须 | 模板名 | ||
├─ status | integer | 非必须 | 状态 | format: int32 | |
├─ tempId | string | 非必须 | 模板ID | ||
├─ tempKey | string | 非必须 | 模板编号 | ||
├─ type | boolean | 非必须 | 0=订阅消息,1=微信模板消息 | ||
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
message | string | 非必须 |
提货点
附近的提货点
基本信息
Path: /api/front/store/list
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
latitude | 否 | 经度 | |
limit | 否 | 每页数量 | |
longitude | 否 | 纬度 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 附近的门店 | ||
├─ list | object [] | 必须 | 附近的门店列表 | item 类型: object | |
├─ address | string | 非必须 | 省市区 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ dayTime | string | 非必须 | 每日营业开关时间 | ||
├─ detailedAddress | string | 非必须 | 详细地址 | ||
├─ distance | string | 非必须 | 距离,单位米 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ image | string | 非必须 | 门店logo | ||
├─ introduction | string | 非必须 | 简介 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ isShow | boolean | 非必须 | 是否显示 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ name | string | 非必须 | 门店名称 | ||
├─ phone | string | 非必须 | 手机号码 | ||
├─ updateTime | string | 非必须 | 修改时间 | format: date-time | |
├─ validTime | string | 非必须 | 核销有效日期 | ||
├─ tengXunMapKey | string | 非必须 | 腾讯地图key | ||
message | string | 非必须 |
文章
分类列表
基本信息
Path: /api/front/article/category/list
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ child | [] | 非必须 | |||
├─ | 非必须 | ||||
├─ extra | string | 非必须 | 扩展字段 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ name | string | 非必须 | 分类名称 | ||
├─ path | string | 非必须 | 路径 | ||
├─ pid | integer | 非必须 | 父级ID | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态, 0正常,1失效 | ||
├─ type | integer | 非必须 | 类型,类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置 | format: int32 | |
├─ url | string | 非必须 | 地址 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
分页列表
基本信息
Path: /api/front/article/list/{cid}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
cid | cid |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ adminId | integer | 非必须 | 管理员id | format: int32 | |
├─ author | string | 非必须 | 文章作者 | ||
├─ categoryName | string | 非必须 | 分类 | ||
├─ cid | string | 非必须 | 分类id | ||
├─ content | string | 非必须 | 文章内容 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ hide | boolean | 非必须 | 是否隐藏 | ||
├─ id | integer | 非必须 | 文章管理ID | format: int32 | |
├─ imageInput | string [] | 非必须 | 文章图片 前端用 | item 类型: string | |
├─ | 非必须 | ||||
├─ imageInputs | string | 非必须 | 文章图片 后端用 | ||
├─ isBanner | boolean | 非必须 | 是否轮播图(小程序) | ||
├─ isHot | boolean | 非必须 | 是否热门(小程序) | ||
├─ mediaId | string | 非必须 | 微信素材媒体id | ||
├─ merId | integer | 非必须 | 商户id | format: int32 | |
├─ productId | integer | 非必须 | 商品关联id | format: int32 | |
├─ shareSynopsis | string | 非必须 | 文章分享简介 | ||
├─ shareTitle | string | 非必须 | 文章分享标题 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态 | ||
├─ synopsis | string | 非必须 | 文章简介 | ||
├─ title | string | 非必须 | 文章标题 | ||
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ url | string | 非必须 | 原文链接 | ||
├─ visit | string | 非必须 | 浏览次数 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
热门列表
基本信息
Path: /api/front/article/hot/list
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ adminId | integer | 非必须 | 管理员id | format: int32 | |
├─ author | string | 非必须 | 文章作者 | ||
├─ categoryName | string | 非必须 | 分类 | ||
├─ cid | string | 非必须 | 分类id | ||
├─ content | string | 非必须 | 文章内容 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ hide | boolean | 非必须 | 是否隐藏 | ||
├─ id | integer | 非必须 | 文章管理ID | format: int32 | |
├─ imageInput | string [] | 非必须 | 文章图片 前端用 | item 类型: string | |
├─ | 非必须 | ||||
├─ imageInputs | string | 非必须 | 文章图片 后端用 | ||
├─ isBanner | boolean | 非必须 | 是否轮播图(小程序) | ||
├─ isHot | boolean | 非必须 | 是否热门(小程序) | ||
├─ mediaId | string | 非必须 | 微信素材媒体id | ||
├─ merId | integer | 非必须 | 商户id | format: int32 | |
├─ productId | integer | 非必须 | 商品关联id | format: int32 | |
├─ shareSynopsis | string | 非必须 | 文章分享简介 | ||
├─ shareTitle | string | 非必须 | 文章分享标题 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态 | ||
├─ synopsis | string | 非必须 | 文章简介 | ||
├─ title | string | 非必须 | 文章标题 | ||
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ url | string | 非必须 | 原文链接 | ||
├─ visit | string | 非必须 | 浏览次数 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
详情
基本信息
Path: /api/front/article/info
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 否 | 文章ID |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 文章管理表 | ||
├─ adminId | integer | 非必须 | 管理员id | format: int32 | |
├─ author | string | 非必须 | 文章作者 | ||
├─ categoryName | string | 非必须 | 分类 | ||
├─ cid | string | 非必须 | 分类id | ||
├─ content | string | 非必须 | 文章内容 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ hide | boolean | 非必须 | 是否隐藏 | ||
├─ id | integer | 非必须 | 文章管理ID | format: int32 | |
├─ imageInput | string [] | 非必须 | 文章图片 前端用 | item 类型: string | |
├─ | 非必须 | ||||
├─ imageInputs | string | 非必须 | 文章图片 后端用 | ||
├─ isBanner | boolean | 非必须 | 是否轮播图(小程序) | ||
├─ isHot | boolean | 非必须 | 是否热门(小程序) | ||
├─ mediaId | string | 非必须 | 微信素材媒体id | ||
├─ merId | integer | 非必须 | 商户id | format: int32 | |
├─ productId | integer | 非必须 | 商品关联id | format: int32 | |
├─ shareSynopsis | string | 非必须 | 文章分享简介 | ||
├─ shareTitle | string | 非必须 | 文章分享标题 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态 | ||
├─ synopsis | string | 非必须 | 文章简介 | ||
├─ title | string | 非必须 | 文章标题 | ||
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ url | string | 非必须 | 原文链接 | ||
├─ visit | string | 非必须 | 浏览次数 | ||
message | string | 非必须 |
轮播列表
基本信息
Path: /api/front/article/banner/list
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ adminId | integer | 非必须 | 管理员id | format: int32 | |
├─ author | string | 非必须 | 文章作者 | ||
├─ categoryName | string | 非必须 | 分类 | ||
├─ cid | string | 非必须 | 分类id | ||
├─ content | string | 非必须 | 文章内容 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ hide | boolean | 非必须 | 是否隐藏 | ||
├─ id | integer | 非必须 | 文章管理ID | format: int32 | |
├─ imageInput | string [] | 非必须 | 文章图片 前端用 | item 类型: string | |
├─ | 非必须 | ||||
├─ imageInputs | string | 非必须 | 文章图片 后端用 | ||
├─ isBanner | boolean | 非必须 | 是否轮播图(小程序) | ||
├─ isHot | boolean | 非必须 | 是否热门(小程序) | ||
├─ mediaId | string | 非必须 | 微信素材媒体id | ||
├─ merId | integer | 非必须 | 商户id | format: int32 | |
├─ productId | integer | 非必须 | 商品关联id | format: int32 | |
├─ shareSynopsis | string | 非必须 | 文章分享简介 | ||
├─ shareTitle | string | 非必须 | 文章分享标题 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态 | ||
├─ synopsis | string | 非必须 | 文章简介 | ||
├─ title | string | 非必须 | 文章标题 | ||
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ url | string | 非必须 | 原文链接 | ||
├─ visit | string | 非必须 | 浏览次数 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
物流公司
列表
基本信息
Path: /api/front/logistics
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ code | string | 非必须 | 快递公司简称 | ||
├─ id | integer | 非必须 | 快递公司id | format: int32 | |
├─ isShow | boolean | 非必须 | 是否显示 | ||
├─ name | string | 非必须 | 快递公司全称 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
用户 -- 充值
余额转入
基本信息
Path: /api/front/recharge/transferIn
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
price | 是 | price |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
充值额度选择
基本信息
Path: /api/front/recharge/index
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | c | ||
├─ giveMoney | string | 非必须 | 赠送金额 | ||
├─ id | integer | 非必须 | 充值模板id | format: int32 | |
├─ price | string | 非必须 | 充值金额 | ||
message | string | 非必须 |
公众号充值
基本信息
Path: /api/front/recharge/wechat
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
from | string | 非必须 | 来源 | public = 微信公众号, weixinh5 =微信H5支付, routine = 小程序 | ||
payType | string | 非必须 | 支付方式| weixin = 微信,alipay = 支付宝 | ||
price | number | 非必须 | 充值金额 | ||
rechar_id | integer | 非必须 | 选择金额组合数据id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 充值返回对象 | ||
├─ appId | string | 非必须 | 调用接口提交的公众账号ID | ||
├─ h5PayUrl | string | 非必须 | H5支付的跳转url | ||
├─ nonceStr | string | 非必须 | 随机字符串 | ||
├─ package | string | 非必须 | 订单详情扩展字符串 | ||
├─ paySign | string | 非必须 | 签名 | ||
├─ prepayId | string | 非必须 | 微信生成的预支付回话标识,用于后续接口调用中使用,该值有效期为2小时,针对H5支付此参数无特殊用途 | ||
├─ signType | string | 非必须 | 签名方式 | ||
├─ timeStamp | integer | 非必须 | 当前的时间,其他详见时间戳规则 | format: int32 | |
message | string | 非必须 |
小程序充值
基本信息
Path: /api/front/recharge/routine
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
from | string | 非必须 | 来源 | public = 微信公众号, weixinh5 =微信H5支付, routine = 小程序 | ||
payType | string | 非必须 | 支付方式| weixin = 微信,alipay = 支付宝 | ||
price | number | 非必须 | 充值金额 | ||
rechar_id | integer | 非必须 | 选择金额组合数据id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
用户 -- 地址
保存
基本信息
Path: /api/front/address/edit
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
address | object | 必须 | 用户地址城市 | ||
├─ city | string | 必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ district | string | 必须 | 收货人所在区 | ||
├─ province | string | 必须 | 收货人所在省 | ||
detail | string | 必须 | 收货人详细地址 | ||
id | integer | 非必须 | 用户地址id | format: int32 | |
isDefault | boolean | 必须 | 是否默认 | ||
phone | string | 必须 | 收货人电话 | ||
realName | string | 必须 | 收货人姓名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户地址表 | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
message | string | 非必须 |
列表
基本信息
Path: /api/front/address/list
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
删除
基本信息
Path: /api/front/address/del
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 非必须 | 用户地址id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
获取单个地址
基本信息
Path: /api/front/address/detail/{id}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户地址表 | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
message | string | 非必须 |
获取默认地址
基本信息
Path: /api/front/address/default
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户地址表 | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
message | string | 非必须 |
设置默认地址
基本信息
Path: /api/front/address/default/set
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 非必须 | 用户地址id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户地址表 | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
message | string | 非必须 |
用户 -- 点赞/收藏
取消收藏产品
基本信息
Path: /api/front/collect/del
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
category | string | 非必须 | 产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store) | ||
id | integer | 非必须 | 商品ID | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
批量收藏
基本信息
Path: /api/front/collect/all
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
category | string | 非必须 | 产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store) | ||
id | integer [] | 非必须 | 商品ID | item 类型: integer | |
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
添加收藏产品
基本信息
Path: /api/front/collect/add
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
category | string | 非必须 | 产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store) | ||
id | integer | 非必须 | 商品ID | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
获取收藏产品
基本信息
Path: /api/front/collect/user
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ activity | string | 非必须 | 活动显示排序1=秒杀,2=砍价,3=拼团 | ||
├─ addTime | integer | 非必须 | 添加时间 | format: int32 | |
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ browse | integer | 非必须 | 浏览量 | format: int32 | |
├─ cateId | string | 非必须 | 分类id | ||
├─ codePath | string | 非必须 | 商品二维码地址(用户小程序海报) | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ ficti | integer | 非必须 | 虚拟销量 | format: int32 | |
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isBargain | boolean | 非必须 | 砍价状态 0未开启 1开启 | ||
├─ isBenefit | boolean | 非必须 | 是否优惠 | ||
├─ isBest | boolean | 非必须 | 是否精品 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ isGood | boolean | 非必须 | 是否优品推荐 | ||
├─ isHot | boolean | 非必须 | 是否热卖 | ||
├─ isNew | boolean | 非必须 | 是否新品 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSeckill | boolean | 非必须 | 秒杀状态 0 未开启 1已开启 | ||
├─ isShow | boolean | 非必须 | 状态(0:未上架,1:上架) | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ merUse | boolean | 非必须 | 商户是否代理 0不可代理1可代理 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ soureLink | string | 非必须 | 淘宝京东1688类型 | ||
├─ specType | boolean | 非必须 | 规格 0单 1多 | ||
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ videoLink | string | 非必须 | 主图视频链接 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
用户 -- 用户中心
会员等级列表
基本信息
Path: /api/front/user/level/grade
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ discount | number | 非必须 | 享受折扣 | ||
├─ experience | integer | 非必须 | 购买金额|经验达到 | format: int32 | |
├─ grade | integer | 非必须 | 会员等级 | format: int32 | |
├─ icon | string | 非必须 | 会员图标 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ image | string | 非必须 | 会员卡背景 | ||
├─ isDel | boolean | 非必须 | 是否删除.1=删除,0=未删除 | ||
├─ isShow | boolean | 非必须 | 是否显示 1=显示,0=隐藏 | ||
├─ memo | string | 非必须 | 说明 | ||
├─ name | string | 非必须 | 会员名称 | ||
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
佣金排行
基本信息
Path: /api/front/brokerage_rank
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 | |
type | 是 | type |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
修改个人资料
基本信息
Path: /api/front/user/edit
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
avatar | string | 非必须 | 用户头像 | ||
nickname | string | 非必须 | 用户昵称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
当前用户在佣金排行第几名
基本信息
Path: /api/front/user/brokerageRankNumber
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
type | 是 | type |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
当前登录用户信息
基本信息
Path: /api/front/userinfo
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
手机号修改密码
基本信息
Path: /api/front/register/reset
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
account | string | 必须 | 手机号 | ||
captcha | string | 必须 | 验证码 | ||
password | string | 必须 | 密码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
推广人排行
基本信息
Path: /api/front/rank
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 | |
type | 是 | type |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
推广佣金/提现总和
基本信息
Path: /api/front/spread/count/{type}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
type | 类型 佣金类型3=佣金,4=提现 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
推广佣金明细
基本信息
Path: /api/front/spread/commission/{type}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 | |
---|---|---|---|
type | 类型 佣金类型 | 0=全部,1=消费,2=充值,3=返佣,4=提现 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ date | string | 非必须 | 月份 | ||
├─ list | object [] | 非必须 | 数据 | item 类型: object | |
├─ add_time | string | 非必须 | 创建时间 | format: date-time | |
├─ balance | number | 非必须 | 剩余 | ||
├─ category | string | 非必须 | 明细种类 | ||
├─ id | integer | 非必须 | 用户账单id | format: int32 | |
├─ linkId | string | 非必须 | 关联id | ||
├─ mark | string | 非必须 | 备注 | ||
├─ number | number | 非必须 | 明细数字 | ||
├─ pm | integer | 非必须 | 0 = 支出 1 = 获得 | format: int32 | |
├─ status | integer | 非必须 | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32 | |
├─ title | string | 非必须 | 账单标题 | ||
├─ type | string | 非必须 | 明细类型 | ||
├─ uid | integer | 非必须 | 用户uid | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
推广数据接口(昨天的佣金 累计提现金额 当前佣金)
<a id=推广数据接口(昨天的佣金 累计提现金额 当前佣金)>
基本信息
Path: /api/front/commission
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 推广佣金明细 | ||
├─ commissionCount | number | 非必须 | 当前佣金 | ||
├─ extractCount | number | 非必须 | 累计提现金额 | ||
├─ lastDayCount | number | 非必须 | 昨天的佣金 | ||
message | string | 非必须 |
推广海报图
基本信息
Path: /api/front/user/spread/banner
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ id | integer | 非必须 | id | format: int32 | |
├─ pic | string | 非必须 | 背景图 | ||
├─ title | string | 非必须 | 名称 | ||
message | string | 非必须 |
推广用户
基本信息
Path: /api/front/spread/people
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 | ||
---|---|---|---|---|---|
grade | 否 | 推荐人类型 | 0=一级 | 1=二级 | |
isAsc | 否 | 排序值 DESC ASC | |||
keyword | 否 | 搜索关键字 | |||
limit | 否 | 每页数量 | |||
page | 否 | 页码 | |||
sortKey | 否 | 排序, 排序 | childCount=团队排序,numberCount=金额排序,orderCount=订单排序 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 推广人信息 | ||
├─ avatar | string | 非必须 | 用户头像 | ||
├─ childCount | integer | 非必须 | 推广人数 | format: int32 | |
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ numberCount | number | 非必须 | 订单金额 | ||
├─ orderCount | integer | 非必须 | 订单数量 | format: int32 | |
├─ time | string | 非必须 | 添加时间 | ||
├─ uid | integer | 非必须 | 用户编号 | format: int32 | |
message | string | 非必须 |
推广订单
基本信息
Path: /api/front/spread/order
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 推广订单 | ||
├─ count | integer | 非必须 | 累计推广订单 | format: int64 | |
├─ list | object [] | 非必须 | 推广人列表 | item 类型: object | |
├─ child | object [] | 非必须 | 推广订单信息 | item 类型: object | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ number | number | 非必须 | 返佣金额 | ||
├─ orderId | string | 非必须 | 订单号 | ||
├─ time | string | 非必须 | 返佣时间 | format: date-time | |
├─ type | string | 非必须 | 订单显示类型 | ||
├─ count | integer | 非必须 | 推广条数 | format: int32 | |
├─ time | string | 非必须 | 推广年月 | ||
message | string | 非必须 |
提现申请
基本信息
Path: /api/front/extract/cash
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
alipayCode | string | 非必须 | 支付宝账号 | ||
bankname | string | 非必须 | 提现银行名称 | ||
cardum | string | 非必须 | 银行卡 | ||
extractType | string | 非必须 | 提现方式| alipay=支付宝,bank=银行卡,weixin=微信 | ||
money | number | 非必须 | 提现金额 | ||
name | string | 非必须 | 姓名 | ||
string | 非必须 | 微信号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
提现银行/提现最低金额
基本信息
Path: /api/front/extract/bank
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 提现银行/提现最低金额 | ||
├─ brokenCommission | number | 非必须 | 冻结佣金 | ||
├─ brokenDay | string | 非必须 | 冻结天数 | ||
├─ commissionCount | number | 非必须 | 可提现佣金 | ||
├─ extractBank | string [] | 非必须 | 提现银行 | item 类型: string | |
├─ | 非必须 | ||||
├─ minPrice | string | 非必须 | 提现最低金额 | ||
message | string | 非必须 |
用户资金统计
基本信息
Path: /api/front/user/balance
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户资金统计 | ||
├─ nowMoney | number | 非必须 | 当前总资金 | ||
├─ orderStatusSum | number | 非必须 | 累计消费 | ||
├─ recharge | number | 非必须 | 累计充值 | ||
message | string | 非必须 |
积分记录
基本信息
Path: /api/front/integral/list
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ add_time | string | 非必须 | 创建时间 | format: date-time | |
├─ balance | number | 非必须 | 剩余 | ||
├─ category | string | 非必须 | 明细种类 | ||
├─ id | integer | 非必须 | 用户账单id | format: int32 | |
├─ linkId | string | 非必须 | 关联id | ||
├─ mark | string | 非必须 | 备注 | ||
├─ number | number | 非必须 | 明细数字 | ||
├─ pm | integer | 非必须 | 0 = 支出 1 = 获得 | format: int32 | |
├─ status | integer | 非必须 | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32 | |
├─ title | string | 非必须 | 账单标题 | ||
├─ type | string | 非必须 | 明细类型 | ||
├─ uid | integer | 非必须 | 用户uid | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
经验记录
基本信息
Path: /api/front/user/expList
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ add_time | string | 非必须 | 创建时间 | format: date-time | |
├─ balance | number | 非必须 | 剩余 | ||
├─ category | string | 非必须 | 明细种类 | ||
├─ id | integer | 非必须 | 用户账单id | format: int32 | |
├─ linkId | string | 非必须 | 关联id | ||
├─ mark | string | 非必须 | 备注 | ||
├─ number | number | 非必须 | 明细数字 | ||
├─ pm | integer | 非必须 | 0 = 支出 1 = 获得 | format: int32 | |
├─ status | integer | 非必须 | 0 = 带确定 1 = 有效 -1 = 无效 | format: int32 | |
├─ title | string | 非必须 | 账单标题 | ||
├─ type | string | 非必须 | 明细类型 | ||
├─ uid | integer | 非必须 | 用户uid | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
绑定手机号
基本信息
Path: /api/front/binding
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
account | string | 必须 | 手机号 | ||
captcha | string | 必须 | 验证码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
获取个人中心菜单
基本信息
Path: /api/front/menu/user
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
获取个人资料
基本信息
Path: /api/front/user
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 个人中心 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | integer | 非必须 | 生日 | format: int32 | |
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ couponCount | integer | 非必须 | 用户优惠券数量 | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | integer | 非必须 | 用户分组id | format: int32 | |
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ orderStatusNum | object | 非必须 | 个人中心 -- 订单状态数量 | ||
├─ noBuy | integer | 非必须 | 未支付订单数量 | format: int32 | |
├─ noPink | integer | 非必须 | 拼团的订单数量 | format: int32 | |
├─ noPostage | integer | 非必须 | 未发货订单数量 | format: int32 | |
├─ noRefund | integer | 非必须 | 退款的订单数量 | format: int32 | |
├─ noReply | integer | 非必须 | 未评论订单数量 | format: int32 | |
├─ noTake | integer | 非必须 | 未收货订单数量 | format: int32 | |
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ pwd | string | 非必须 | 用户密码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广元id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
├─ vip | boolean | 非必须 | 是否会员 | ||
├─ vipIcon | string | 非必须 | 会员图标 | ||
├─ vipName | string | 非必须 | 会员名称 | ||
message | string | 非必须 |
用户 -- 登录注册
发送短信
基本信息
Path: /api/front/sendCode
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
phone | 是 | 手机号码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
手机号登录接口
基本信息
Path: /api/front/login/mobile
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
account | string | 必须 | 手机号 | ||
captcha | string | 必须 | 验证码 | ||
spread | integer | 非必须 | 推广人id | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ expiresTime | string | 非必须 | 用户登录密钥到期时间 | format: date-time | |
├─ token | string | 非必须 | 用户登录密钥 | ||
├─ user | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
账号密码登录
基本信息
Path: /api/front/login
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
account | string | 必须 | 手机号 | ||
password | string | 必须 | 密码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ expiresTime | string | 非必须 | 用户登录密钥到期时间 | format: date-time | |
├─ token | string | 非必须 | 用户登录密钥 | ||
├─ user | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
message | string | 非必须 |
退出
基本信息
Path: /api/front/logout
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
用户 -- 签到
分页列表
基本信息
Path: /api/front/user/sign/list
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ createDay | string | 非必须 | 签到日期 | format: date-time | |
├─ number | integer | 非必须 | 获得积分 | format: int32 | |
├─ title | string | 非必须 | 签到说明 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
分页列表
基本信息
Path: /api/front/user/sign/month
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ createDay | string | 非必须 | 签到日期 | format: date-time | |
├─ number | integer | 非必须 | 获得积分 | format: int32 | |
├─ title | string | 非必须 | 签到说明 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
签到
基本信息
Path: /api/front/user/sign/integral
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 签到记录 | ||
├─ day | integer | 非必须 | 第几天 | format: int32 | |
├─ experience | integer | 非必须 | 经验 | format: int32 | |
├─ id | integer | 非必须 | format: int32 | ||
├─ integral | integer | 非必须 | 积分 | format: int32 | |
├─ title | string | 非必须 | 显示文字 | ||
message | string | 非必须 |
签到用户信息
基本信息
Path: /api/front/user/sign/user
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
all | boolean | 非必须 | 是否统计签到和统计积分使用情况|1=是,0=否 | ||
integral | boolean | 非必须 | 是否统计积分使用情况|1=是,0=否 | ||
sign | boolean | 非必须 | 是否统计签到|1=是,0=否 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 修改个人资料 | ||
├─ avatar | string | 非必须 | 用户头像 | ||
├─ deductionIntegral | integer | 非必须 | 累计抵扣积分 | format: int32 | |
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isDaySign | boolean | 非必须 | 今天是否签到 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ isYesterdaySign | boolean | 非必须 | 昨天是否签到 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ sumIntegral | integer | 非必须 | 累计总积分 | format: int32 | |
├─ sumSignDay | integer | 非必须 | 累计签到次数 | format: int32 | |
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ yesterdayIntegral | integer | 非必须 | 昨天累计积分 | format: int32 | |
message | string | 非必须 |
详情
基本信息
Path: /api/front/user/sign/get
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
配置
基本信息
Path: /api/front/user/sign/config
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ limit | integer | 非必须 | format: int32 | ||
├─ list | object [] | 非必须 | item 类型: object | ||
├─ day | integer | 非必须 | 第几天 | format: int32 | |
├─ experience | integer | 非必须 | 经验 | format: int32 | |
├─ id | integer | 非必须 | format: int32 | ||
├─ integral | integer | 非必须 | 积分 | format: int32 | |
├─ title | string | 非必须 | 显示文字 | ||
├─ page | integer | 非必须 | format: int32 | ||
├─ total | integer | 非必须 | format: int64 | ||
├─ totalPage | integer | 非必须 | format: int32 | ||
message | string | 非必须 |
营销 -- 优惠券
我的优惠券
基本信息
Path: /api/front/coupon/list
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ avatar | string | 非必须 | 用户头像 | ||
├─ cid | integer | 非必须 | 兑换的项目id | format: int32 | |
├─ couponId | integer | 非必须 | 优惠券发布id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ endTime | string | 非必须 | 过期时间 | format: date-time | |
├─ id | integer | 非必须 | id | format: int32 | |
├─ isValid | boolean | 非必须 | 用户头像 | ||
├─ minPrice | number | 非必须 | 最低消费多少金额可用优惠券 | ||
├─ money | number | 非必须 | 优惠券的面值 | ||
├─ name | string | 非必须 | 优惠券名称 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ primaryKey | string | 必须 | 主键id 商品id/分类id | ||
├─ startTime | string | 非必须 | 开始使用时间 | format: date-time | |
├─ status | integer | 非必须 | 状态(0:未使用,1:已使用, 2:已失效) | format: int32 | |
├─ type | string | 非必须 | 获取方式 | ||
├─ uid | integer | 非必须 | 领取人id | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ useTime | string | 非必须 | 使用时间 | format: date-time | |
├─ useType | integer | 非必须 | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32 | |
message | string | 非必须 |
批量领券
基本信息
Path: /api/front/coupon/receive/batch
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
couponId | integer [] | 非必须 | 优惠券id | item 类型: integer | |
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
领券
基本信息
Path: /api/front/coupon/receive
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
couponId | integer [] | 非必须 | 优惠券id | item 类型: integer | |
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | string | 非必须 | |||
message | string | 非必须 |
订单
再次下单
基本信息
Path: /api/front/order/again
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
nui | string | 非必须 | 订单id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
删除订单
基本信息
Path: /api/front/order/del
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 是 | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
待评价商品信息查询
基本信息
Path: /api/front/order/product
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
orderId | integer | 非必须 | 订单id | format: int32 | |
uni | string | 非必须 | 商品attrid |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
支付
基本信息
Path: /api/front/order/pay
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
from | string | 非必须 | 支付平台 | ||
paytype | string | 非必须 | 支付类型 | ||
uni | string | 非必须 | 订单id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
物流信息查询
基本信息
Path: /api/front/order/express/{orderId}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
orderId | orderId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
生成订单
基本信息
Path: /api/front/order/create/{key}
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
key | key |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
addressId | integer | 非必须 | 收货地址id | format: int32 | |
bargainId | integer | 非必须 | format: int32 | ||
combinationId | integer | 非必须 | format: int32 | ||
couponId | integer | 非必须 | format: int32 | ||
formId | integer | 非必须 | format: int32 | ||
from | string | 非必须 | |||
isNew | boolean | 必须 | 是否为立即购买 | ||
mark | string | 非必须 | |||
payType | string | 非必须 | |||
phone | string | 非必须 | 手机号码 | ||
pinkId | integer | 非必须 | format: int32 | ||
realName | string | 非必须 | 真实名称 | ||
seckillId | integer | 非必须 | format: int32 | ||
shippingType | integer | 非必须 | 快递类型 | format: int32 | |
storeId | integer | 非必须 | format: int32 | ||
useIntegral | boolean | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
确认订单
基本信息
Path: /api/front/order/confirm
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
cartIds | 是 | cartIds | |
isNew | 是 | isNew |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
├─ addressInfo | object | 非必须 | 用户地址表 | ||
├─ city | string | 非必须 | 收货人所在市 | ||
├─ cityId | integer | 非必须 | 城市id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ detail | string | 非必须 | 收货人详细地址 | ||
├─ district | string | 非必须 | 收货人所在区 | ||
├─ id | integer | 非必须 | 用户地址id | format: int32 | |
├─ isDefault | boolean | 非必须 | 是否默认 | ||
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ latitude | string | 非必须 | 纬度 | ||
├─ longitude | string | 非必须 | 经度 | ||
├─ phone | string | 非必须 | 收货人电话 | ||
├─ postCode | integer | 非必须 | 邮编 | format: int32 | |
├─ province | string | 非必须 | 收货人所在省 | ||
├─ realName | string | 非必须 | 收货人姓名 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ cartInfo | object [] | 非必须 | item 类型: object | ||
├─ addTime | string | 非必须 | |||
├─ attrStatus | boolean | 非必须 | 商品是否有效 | ||
├─ bargainId | integer | 非必须 | 砍价id | format: int32 | |
├─ brokerage | number | 非必须 | 一级分佣 | ||
├─ brokerageTwo | number | 非必须 | 二级分佣 | ||
├─ cartNum | integer | 非必须 | 商品数量 | format: int32 | |
├─ combinationId | integer | 非必须 | 拼团id | format: int32 | |
├─ costPrice | number | 非必须 | |||
├─ id | integer | 非必须 | 购物车表ID | format: int64 | |
├─ isNew | boolean | 非必须 | 是否为立即购买 | ||
├─ isReply | integer | 非必须 | format: int32 | ||
├─ productAttrUnique | string | 非必须 | 商品属性 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ productInfo | object | 非必须 | 商品信息,购物车列表使用 | ||
├─ attrInfo | object | 非必须 | 商品属性值表 | ||
├─ attrValue | string | 非必须 | 产品属性值和属性名对应关系 | ||
├─ barCode | string | 非必须 | 商品条码 | ||
├─ brokerage | number | 非必须 | 一级返佣 | ||
├─ brokerageTwo | number | 非必须 | 二级返佣 | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ id | integer | 非必须 | attrId | format: int32 | |
├─ image | string | 非必须 | 图片 | ||
├─ otPrice | number | 非必须 | 原价 | ||
├─ price | number | 非必须 | 属性金额 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ quota | integer | 非必须 | 活动限购数量 | format: int32 | |
├─ quotaShow | integer | 非必须 | 活动限购数量显示 | format: int32 | |
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ stock | integer | 非必须 | 属性对应的库存 | format: int32 | |
├─ suk | string | 非必须 | 商品属性索引值 (attr_value|attr_value[|....]) | ||
├─ type | integer | 非必须 | 活动类型 0=商品,1=秒杀,2=砍价,3=拼团 | format: int32 | |
├─ unique | string | 非必须 | 唯一值 | ||
├─ volume | number | 非必须 | 体积 | ||
├─ weight | number | 非必须 | 重量 | ||
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ cateId | string | 非必须 | 分类id | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
├─ seckillId | integer | 非必须 | 秒杀商品ID | format: int32 | |
├─ truePrice | number | 非必须 | |||
├─ trueStock | integer | 非必须 | format: int32 | ||
├─ type | string | 非必须 | 类型 | ||
├─ uid | integer | 非必须 | 用户ID | format: int32 | |
├─ vipTruePrice | number | 非必须 | |||
├─ deduction | boolean | 非必须 | |||
├─ integralRatio | string | 非必须 | |||
├─ offlinePayStatus | string | 非必须 | |||
├─ offlinePostage | string | 非必须 | |||
├─ orderKey | string | 非必须 | |||
├─ other | object | 非必须 | |||
├─ payWeixinOpen | string | 非必须 | |||
├─ priceGroup | object | 非必须 | |||
├─ costPrice | number | 非必须 | |||
├─ couponPrice | number | 非必须 | |||
├─ deductionPrice | number | 非必须 | |||
├─ payPostage | number | 非必须 | |||
├─ payPrice | number | 非必须 | |||
├─ storeFreePostage | number | 非必须 | |||
├─ storePostage | number | 非必须 | |||
├─ totalPrice | number | 非必须 | |||
├─ usedIntegral | number | 非必须 | |||
├─ vipPrice | number | 非必须 | |||
├─ storeSelfMention | string | 非必须 | |||
├─ systemStore | string | 非必须 | |||
├─ usableCoupon | object | 非必须 | 优惠券记录表 | ||
├─ avatar | string | 非必须 | 用户头像 | ||
├─ cid | integer | 非必须 | 兑换的项目id | format: int32 | |
├─ couponId | integer | 非必须 | 优惠券发布id | format: int32 | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ endTime | string | 非必须 | 过期时间 | format: date-time | |
├─ id | integer | 非必须 | id | format: int32 | |
├─ isValid | boolean | 非必须 | 用户头像 | ||
├─ minPrice | number | 非必须 | 最低消费多少金额可用优惠券 | ||
├─ money | number | 非必须 | 优惠券的面值 | ||
├─ name | string | 非必须 | 优惠券名称 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ primaryKey | string | 必须 | 主键id 商品id/分类id | ||
├─ startTime | string | 非必须 | 开始使用时间 | format: date-time | |
├─ status | integer | 非必须 | 状态(0:未使用,1:已使用, 2:已失效) | format: int32 | |
├─ type | string | 非必须 | 获取方式 | ||
├─ uid | integer | 非必须 | 领取人id | format: int32 | |
├─ updateTime | string | 非必须 | 更新时间 | format: date-time | |
├─ useTime | string | 非必须 | 使用时间 | format: date-time | |
├─ useType | integer | 非必须 | 使用类型 1 全场通用, 2 商品券, 3 品类券 | format: int32 | |
├─ userInfo | object | 非必须 | 用户表 | ||
├─ account | string | 非必须 | 用户账号 | ||
├─ addIp | string | 非必须 | 添加ip | ||
├─ addres | string | 非必须 | 详细地址 | ||
├─ adminid | integer | 非必须 | 管理员编号 | format: int32 | |
├─ avatar | string | 非必须 | 用户头像 | ||
├─ birthday | string | 非必须 | 生日 | ||
├─ brokeragePrice | number | 非必须 | 佣金金额 | ||
├─ cardId | string | 非必须 | 身份证号码 | ||
├─ cleanTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ experience | integer | 非必须 | 用户剩余经验 | format: int32 | |
├─ groupId | string | 非必须 | 用户分组id | ||
├─ integral | number | 非必须 | 用户剩余积分 | ||
├─ isPromoter | boolean | 非必须 | 是否为推广员 | ||
├─ lastIp | string | 非必须 | 最后一次登录ip | ||
├─ lastLoginTime | string | 非必须 | 最后一次登录时间 | format: date-time | |
├─ level | integer | 非必须 | 等级 | format: int32 | |
├─ loginType | string | 非必须 | 用户登陆类型,h5,wechat,routine | ||
├─ mark | string | 非必须 | 用户备注 | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ nowMoney | number | 非必须 | 用户余额 | ||
├─ partnerId | integer | 非必须 | 合伙人id | format: int32 | |
├─ path | string | 非必须 | 用户推广等级 | ||
├─ payCount | integer | 非必须 | 用户购买次数 | format: int32 | |
├─ phone | string | 非必须 | 手机号码 | ||
├─ realName | string | 非必须 | 真实姓名 | ||
├─ signNum | integer | 非必须 | 连续签到天数 | format: int32 | |
├─ spreadCount | integer | 非必须 | 下级人数 | format: int32 | |
├─ spreadTime | string | 非必须 | 推广员关联时间 | format: date-time | |
├─ spreadUid | integer | 非必须 | 推广人id | format: int32 | |
├─ status | boolean | 非必须 | 1为正常,0为禁止 | ||
├─ subscribe | boolean | 非必须 | 是否关注公众号 | ||
├─ tagId | string | 非必须 | 用户标签id | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ updateTime | string | 非必须 | 创建时间 | format: date-time | |
├─ userType | string | 非必须 | 用户类型 | ||
├─ yuePayStatus | string | 非必须 | |||
message | string | 非必须 |
计算价格
基本信息
Path: /api/front/order/computed/{key}
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
key | key |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
addressId | integer | 非必须 | 地址id | format: int32 | |
couponId | integer | 非必须 | 优惠券id | format: int32 | |
payType | string | 非必须 | 支付类型 | ||
shippingType | integer | 非必须 | 快递类型 | format: int32 | |
useIntegral | boolean | 非必须 | 抵扣积分 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
订单列表
基本信息
Path: /api/front/order/list
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 | |
---|---|---|---|---|
limit | 否 | 每页数量 | ||
page | 否 | 页码 | ||
type | 是 | 评价等级 | 0=未支付,1=待发货,2=待收货,3=待评价,4=已完成 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ addTime | string | 非必须 | |||
├─ cartInfo | object [] | 非必须 | item 类型: object | ||
├─ info | object | 非必须 | 购物车ListResponse | ||
├─ addTime | string | 非必须 | |||
├─ attrStatus | boolean | 非必须 | 商品是否有效 | ||
├─ bargainId | integer | 非必须 | 砍价id | format: int32 | |
├─ brokerage | number | 非必须 | 一级分佣 | ||
├─ brokerageTwo | number | 非必须 | 二级分佣 | ||
├─ cartNum | integer | 非必须 | 商品数量 | format: int32 | |
├─ combinationId | integer | 非必须 | 拼团id | format: int32 | |
├─ costPrice | number | 非必须 | |||
├─ id | integer | 非必须 | 购物车表ID | format: int64 | |
├─ isNew | boolean | 非必须 | 是否为立即购买 | ||
├─ isReply | integer | 非必须 | format: int32 | ||
├─ productAttrUnique | string | 非必须 | 商品属性 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ productInfo | object | 非必须 | 商品信息,购物车列表使用 | ||
├─ attrInfo | object | 非必须 | 商品属性值表 | ||
├─ attrValue | string | 非必须 | 产品属性值和属性名对应关系 | ||
├─ barCode | string | 非必须 | 商品条码 | ||
├─ brokerage | number | 非必须 | 一级返佣 | ||
├─ brokerageTwo | number | 非必须 | 二级返佣 | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ id | integer | 非必须 | attrId | format: int32 | |
├─ image | string | 非必须 | 图片 | ||
├─ otPrice | number | 非必须 | 原价 | ||
├─ price | number | 非必须 | 属性金额 | ||
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ quota | integer | 非必须 | 活动限购数量 | format: int32 | |
├─ quotaShow | integer | 非必须 | 活动限购数量显示 | format: int32 | |
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ stock | integer | 非必须 | 属性对应的库存 | format: int32 | |
├─ suk | string | 非必须 | 商品属性索引值 (attr_value|attr_value[|....]) | ||
├─ type | integer | 非必须 | 活动类型 0=商品,1=秒杀,2=砍价,3=拼团 | format: int32 | |
├─ unique | string | 非必须 | 唯一值 | ||
├─ volume | number | 非必须 | 体积 | ||
├─ weight | number | 非必须 | 重量 | ||
├─ barCode | string | 非必须 | 商品条码(一维码) | ||
├─ cateId | string | 非必须 | 分类id | ||
├─ cost | number | 非必须 | 成本价 | ||
├─ giveIntegral | number | 非必须 | 获得积分 | ||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ isPostage | boolean | 非必须 | 是否包邮 | ||
├─ isSub | boolean | 非必须 | 是否单独分佣 | ||
├─ keyword | string | 非必须 | 关键字 | ||
├─ merId | integer | 非必须 | 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) | format: int32 | |
├─ otPrice | number | 非必须 | 市场价 | ||
├─ postage | number | 非必须 | 邮费 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sliderImage | string | 非必须 | 轮播图 | ||
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeInfo | string | 非必须 | 商品简介 | ||
├─ storeName | string | 非必须 | 商品名称 | ||
├─ tempId | integer | 非必须 | 运费模板ID | format: int32 | |
├─ unitName | string | 非必须 | 单位名 | ||
├─ vipPrice | number | 非必须 | 会员价格 | ||
├─ seckillId | integer | 非必须 | 秒杀商品ID | format: int32 | |
├─ truePrice | number | 非必须 | |||
├─ trueStock | integer | 非必须 | format: int32 | ||
├─ type | string | 非必须 | 类型 | ||
├─ uid | integer | 非必须 | 用户ID | format: int32 | |
├─ vipTruePrice | number | 非必须 | |||
├─ orderId | integer | 非必须 | 订单id | format: int32 | |
├─ productId | integer | 非必须 | 商品ID | format: int32 | |
├─ unique | string | 非必须 | 唯一id | ||
├─ offlinePayStatus | integer | 非必须 | format: int32 | ||
├─ payTime | string | 非必须 | |||
├─ status | object | 非必须 | |||
├─ deliveryType | string | 非必须 | |||
├─ msg | string | 非必须 | |||
├─ payType | string | 非必须 | |||
├─ title | string | 非必须 | |||
├─ type | integer | 非必须 | format: int32 | ||
├─ statusPic | string | 非必须 | |||
├─ storeOrder | object | 非必须 | 订单表 | ||
├─ backIntegral | number | 非必须 | 给用户退了多少积分 | ||
├─ bargainId | integer | 非必须 | 砍价id | format: int32 | |
├─ clerkId | integer | 非必须 | 店员id | format: int32 | |
├─ combinationId | integer | 非必须 | 拼团商品id0一般商品 | format: int32 | |
├─ cost | number | 非必须 | 成本价 | ||
├─ couponId | integer | 非必须 | 优惠券id | format: int32 | |
├─ couponPrice | number | 非必须 | 优惠券金额 | ||
├─ createTime | string | 非必须 | 创建时间 | format: date-time | |
├─ deductionPrice | number | 非必须 | 抵扣金额 | ||
├─ deliveryId | string | 非必须 | 快递单号/手机号 | ||
├─ deliveryName | string | 非必须 | 快递名称/送货人姓名 | ||
├─ deliveryType | string | 非必须 | 发货类型 | ||
├─ freightPrice | number | 非必须 | 运费金额 | ||
├─ gainIntegral | number | 非必须 | 消费赚取积分 | ||
├─ id | integer | 非必须 | 订单ID | format: int32 | |
├─ isChannel | integer | 非必须 | 支付渠道(0微信公众号1微信小程序) | format: int32 | |
├─ isDel | boolean | 非必须 | 是否删除 | ||
├─ isMerCheck | integer | 非必须 | format: int32 | ||
├─ isRemind | boolean | 非必须 | 消息提醒 | ||
├─ isSystemDel | boolean | 非必须 | 后台是否删除 | ||
├─ mark | string | 非必须 | 备注 | ||
├─ merId | integer | 非必须 | 商户ID | format: int32 | |
├─ orderId | string | 非必须 | 订单号 | ||
├─ paid | boolean | 非必须 | 支付状态 | ||
├─ payPostage | number | 非必须 | 支付邮费 | ||
├─ payPrice | number | 非必须 | 实际支付金额 | ||
├─ payTime | string | 非必须 | 支付时间 | format: date-time | |
├─ payType | string | 非必须 | 支付方式 | ||
├─ pinkId | integer | 非必须 | 拼团id 0没有拼团 | format: int32 | |
├─ realName | string | 非必须 | 用户姓名 | ||
├─ refundPrice | number | 非必须 | 退款金额 | ||
├─ refundReason | string | 非必须 | 不退款的理由 | ||
├─ refundReasonTime | string | 非必须 | 退款时间 | format: date-time | |
├─ refundReasonWap | string | 非必须 | 前台退款原因 | ||
├─ refundReasonWapExplain | string | 非必须 | 退款用户说明 | ||
├─ refundReasonWapImg | string | 非必须 | 退款图片 | ||
├─ refundStatus | integer | 非必须 | 0 未退款 1 申请中 2 已退款 | format: int32 | |
├─ remark | string | 非必须 | 管理员备注 | ||
├─ seckillId | integer | 非必须 | 秒杀商品ID | format: int32 | |
├─ shippingType | integer | 非必须 | 配送方式 1=快递 ,2=门店自提 | format: int32 | |
├─ status | integer | 非必须 | 订单状态(-1 : 申请退款 -2 : 退货成功 0:待发货;1:待收货;2:已收货,待评价;3:已完成;) | format: int32 | |
├─ storeId | integer | 非必须 | 门店id | format: int32 | |
├─ totalNum | integer | 非必须 | 订单商品总数 | format: int32 | |
├─ totalPostage | number | 非必须 | 邮费 | ||
├─ totalPrice | number | 非必须 | 订单总价 | ||
├─ uid | integer | 非必须 | 用户id | format: int32 | |
├─ unique | string | 非必须 | 唯一id(md5加密)类似id | ||
├─ useIntegral | number | 非必须 | 使用积分 | ||
├─ userAddress | string | 非必须 | 详细地址 | ||
├─ userPhone | string | 非必须 | 用户电话 | ||
├─ verifyCode | string | 非必须 | 核销码 | ||
message | string | 非必须 |
订单取消
基本信息
Path: /api/front/order/cancel
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 是 | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
订单头部数量
基本信息
Path: /api/front/order/data
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
订单收货
基本信息
Path: /api/front/order/take
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 是 | id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
订单详情
基本信息
Path: /api/front/order/detail/{orderId}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
orderId | orderId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
订单退款理由
基本信息
Path: /api/front/order/refund/reason
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
订单退款申请
基本信息
Path: /api/front/order/refund
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 必须 | 订单id | format: int32 | |
refund_reason_wap_explain | string | 非必须 | 备注说明 | ||
refund_reason_wap_img | string | 非必须 | 退款凭证(多个图片请用,(英文逗号)隔开) | ||
text | string | 必须 | 退款原因 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
评价订单
基本信息
Path: /api/front/order/comment
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
comment | string | 必须 | 评论内容 | ||
oid | integer | 非必须 | 订单ID, 移动端必须传递此参数 | format: int32 | |
pics | string | 必须 | 评论图片 | ||
productId | integer | 必须 | 商品id | format: int32 | |
productScore | integer | 必须 | 商品分数 | format: int32 | |
serviceScore | integer | 必须 | 服务分数 | format: int32 | |
unique | string | 非必须 | 商品 属性id | ||
userId | integer | 非必须 | 用户id, 后端必须传递此参数 | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | boolean | 非必须 | |||
message | string | 非必须 |
退款订单验证
基本信息
Path: /api/front/order/refund/verify
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
refund_reason_wap_explain | string | 非必须 | 退款备注说明 | ||
refund_reason_wap_img | string | 非必须 | 退款凭证图片 | ||
text | string | 非必须 | 退款原因 | ||
uni | string | 非必须 | 待退款订单 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
首页
分享配置
基本信息
Path: /api/front/share
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | |||
message | string | 非必须 |
热门搜索
基本信息
Path: /api/front/search/keyword
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object [] | 非必须 | item 类型: object | ||
message | string | 非必须 |
首页产品的轮播图和产品信息
基本信息
Path: /api/front/groom/list/{type}
Method: GET
接口描述:
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
type | 类型 【1 精品推荐 2 热门榜单 3首发新品 4促销单品】 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 每页数量 | |
page | 否 | 页码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ activity | object [] | 非必须 | 活动区域图片 | item 类型: object | |
├─ banner | object [] | 非必须 | 首页banner滚动图 | item 类型: object | |
├─ benefit | object [] | 非必须 | 首页促销单品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ couponList | object [] | 非必须 | 优惠券 | item 类型: object | |
├─ explosiveMoney | object [] | 非必须 | 首页超值爆款 | item 类型: object | |
├─ info | object | 非必须 | 用户登录返回数据 | ||
├─ bastBanner | object [] | 非必须 | 首页精品推荐图片 | item 类型: object | |
├─ bastInfo | string | 非必须 | 精品推荐简介 | ||
├─ bastList | object [] | 非必须 | 精品推荐 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ bastNumber | string | 非必须 | 精品推荐个数 | ||
├─ fastInfo | string | 非必须 | 快速选择简介 | ||
├─ fastList | object [] | 非必须 | 分类 | item 类型: object | |
├─ extra | string | 非必须 | 扩展字段 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ name | string | 非必须 | 分类名称 | ||
├─ path | string | 非必须 | 路径 | ||
├─ pid | integer | 非必须 | 父级ID | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态, 0正常,1失效 | ||
├─ type | integer | 非必须 | 类型ID | 类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置 | format: int32 | |
├─ url | string | 非必须 | 地址 | ||
├─ fastNumber | string | 非必须 | 快速选择分类个数 | ||
├─ firstInfo | string | 非必须 | 首发新品简介 | ||
├─ firstList | object [] | 非必须 | 首发新品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ firstNumber | string | 非必须 | 首发新品个数 | ||
├─ promotionNumber | string | 非必须 | 首页促销单品 | ||
├─ salesInfo | string | 非必须 | 促销单品简介 | ||
├─ likeInfo | object [] | 非必须 | 热门榜单 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ list | object [] | 非必须 | 商品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ logoUrl | string | 非必须 | 企业logo | ||
├─ lovely | object | 非必须 | 首发新品广告图 | ||
├─ menus | object [] | 非必须 | 导航模块 | item 类型: object | |
├─ roll | object [] | 非必须 | 新闻简报消息滚动 | item 类型: object | |
├─ subscribe | boolean | 非必须 | 是否关注 | ||
message | string | 非必须 |
首页数据
基本信息
Path: /api/front/index
Method: GET
接口描述:
请求参数
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | format: int64 | ||
data | object | 非必须 | 用户登录返回数据 | ||
├─ activity | object [] | 非必须 | 活动区域图片 | item 类型: object | |
├─ banner | object [] | 非必须 | 首页banner滚动图 | item 类型: object | |
├─ benefit | object [] | 非必须 | 首页促销单品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ couponList | object [] | 非必须 | 优惠券 | item 类型: object | |
├─ explosiveMoney | object [] | 非必须 | 首页超值爆款 | item 类型: object | |
├─ info | object | 非必须 | 用户登录返回数据 | ||
├─ bastBanner | object [] | 非必须 | 首页精品推荐图片 | item 类型: object | |
├─ bastInfo | string | 非必须 | 精品推荐简介 | ||
├─ bastList | object [] | 非必须 | 精品推荐 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ bastNumber | string | 非必须 | 精品推荐个数 | ||
├─ fastInfo | string | 非必须 | 快速选择简介 | ||
├─ fastList | object [] | 非必须 | 分类 | item 类型: object | |
├─ extra | string | 非必须 | 扩展字段 | ||
├─ id | integer | 非必须 | format: int32 | ||
├─ name | string | 非必须 | 分类名称 | ||
├─ path | string | 非必须 | 路径 | ||
├─ pid | integer | 非必须 | 父级ID | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ status | boolean | 非必须 | 状态, 0正常,1失效 | ||
├─ type | integer | 非必须 | 类型ID | 类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置 | format: int32 | |
├─ url | string | 非必须 | 地址 | ||
├─ fastNumber | string | 非必须 | 快速选择分类个数 | ||
├─ firstInfo | string | 非必须 | 首发新品简介 | ||
├─ firstList | object [] | 非必须 | 首发新品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ firstNumber | string | 非必须 | 首发新品个数 | ||
├─ promotionNumber | string | 非必须 | 首页促销单品 | ||
├─ salesInfo | string | 非必须 | 促销单品简介 | ||
├─ likeInfo | object [] | 非必须 | 热门榜单 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ list | object [] | 非必须 | 商品 | item 类型: object | |
├─ cateId | integer [] | 非必须 | 分类id | item 类型: integer | |
├─ | 非必须 | ||||
├─ id | integer | 非必须 | 商品id | format: int32 | |
├─ image | string | 非必须 | 商品图片 | ||
├─ otPrice | number | 非必须 | 市场价 | ||
├─ price | number | 非必须 | 商品价格 | ||
├─ sales | integer | 非必须 | 销量 | format: int32 | |
├─ sort | integer | 非必须 | 排序 | format: int32 | |
├─ stock | integer | 非必须 | 库存 | format: int32 | |
├─ storeName | string | 非必须 | 商品名称 | ||
├─ unitName | string | 非必须 | 单位名 | ||
├─ logoUrl | string | 非必须 | 企业logo | ||
├─ lovely | object | 非必须 | 首发新品广告图 | ||
├─ menus | object [] | 非必须 | 导航模块 | item 类型: object | |
├─ roll | object [] | 非必须 | 新闻简报消息滚动 | item 类型: object | |
├─ subscribe | boolean | 非必须 | 是否关注 | ||
message | string | 非必须 |