更新记录

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

返回数据

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

format: int64

dataobject非必须
├─ extNamestring非必须
├─ fileNamestring非必须
├─ fileSizeinteger非必须

format: int64

├─ serverPathstring非必须
├─ typestring非必须
├─ urlstring非必须
messagestring非必须

二维码服务

获取二维码

基本信息

Path: /api/front/qrcode/get

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

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

format: int64

dataobject非必须
messagestring非必须

远程图片转base64

基本信息

Path: /api/front/qrcode/base64

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

dataobject非必须
messagestring非必须

优惠券

分页列表

基本信息

Path: /api/front/coupons

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ createTimestring非必须创建时间

format: date-time

├─ dayinteger非必须天数

format: int32

├─ idinteger非必须优惠券表ID

format: int32

├─ isDelboolean非必须是否删除 状态(0:否,1:是)
├─ isFixedTimeboolean非必须是否固定使用时间, 默认0 否, 1是
├─ isLimitedboolean非必须是否限量, 默认0 不限量, 1限量
├─ isUseboolean非必须是否已领取未使用
├─ lastTotalinteger非必须剩余数量

format: int32

├─ minPricenumber非必须最低消费,0代表不限制
├─ moneynumber非必须兑换的优惠券面值
├─ namestring非必须优惠券名称
├─ primaryKeystring非必须所属商品id / 分类id
├─ receiveEndTimestring非必须可领取结束时间

format: date-time

├─ receiveStartTimestring非必须可领取开始时间

format: date-time

├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态(0:关闭,1:开启)
├─ totalinteger非必须发放总数

format: int32

├─ typeinteger非必须优惠券类型 0-通用 1 普通券, 2 新人券, 3 购买商品赠送券, 4 付费会员券

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ useEndTimestring非必须可使用时间范围 结束时间

format: date-time

├─ useStartTimestring非必须可使用时间范围 开始时间

format: date-time

messagestring非必须

当前购物车可用优惠券

基本信息

Path: /api/front/coupons/order

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ cidinteger非必须兑换的项目id

format: int32

├─ couponIdinteger非必须优惠券发布id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ idinteger非必须id

format: int32

├─ minPricenumber非必须最低消费多少金额可用优惠券
├─ moneynumber非必须优惠券的面值
├─ namestring非必须优惠券名称
├─ primaryKeystring必须主键id 商品id/分类id
├─ receiveEndTimestring非必须过期时间

format: date-time

├─ receiveStartTimestring非必须开始使用时间

format: date-time

├─ statusinteger非必须状态(0:未使用,1:已使用, 2:已失效)

format: int32

├─ typestring非必须获取方式
├─ uidinteger非必须领取人id

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ useTimestring非必须使用时间

format: date-time

├─ useTypeinteger非必须使用类型 1 全场通用, 2 商品券, 3 品类券

format: int32

messagestring非必须

商品

为你推荐

基本信息

Path: /api/front/product/hot

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

商品列表

基本信息

Path: /api/front/products

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cid 分类id
keyword 搜索关键字
limit 每页数量
news 是否新品
page 页码
priceOrder 价格排序
salesOrder 销量排序

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

商品评论列表

基本信息

Path: /api/front/reply/list/{id}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id

Query

参数名称 是否必须 示例 备注
limit 每页数量
page 页码
type 评价等级 0=全部,1=好评,2=中评,3=差评

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ avatarstring非必须用户头像
├─ commentstring非必须评论内容
├─ createTimestring非必须评论时间

format: date-time

├─ idinteger非必须评论ID

format: int32

├─ isDelboolean非必须0未删除1已删除
├─ isReplyboolean非必须0未回复1已回复
├─ merchantReplyContentstring非必须管理员回复内容
├─ merchantReplyTimeinteger非必须管理员回复时间

format: int32

├─ nicknamestring非必须用户名称
├─ oidinteger非必须订单ID

format: int32

├─ picsstring []非必须评论图片

item 类型: string

├─ 非必须
├─ productIdinteger非必须商品id

format: int32

├─ productScoreinteger非必须商品分数

format: int32

├─ replyTypestring非必须某种商品类型(普通商品、秒杀商品)
├─ serviceScoreinteger非必须服务分数

format: int32

├─ storeProductobject非必须商品表
├─ activitystring非必须活动显示排序1=秒杀,2=砍价,3=拼团
├─ addTimeinteger非必须添加时间

format: int32

├─ barCodestring非必须商品条码(一维码)
├─ browseinteger非必须浏览量

format: int32

├─ cateIdstring非必须分类id
├─ codePathstring非必须商品二维码地址(用户小程序海报)
├─ costnumber非必须成本价
├─ fictiinteger非必须虚拟销量

format: int32

├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isBargainboolean非必须砍价状态 0未开启 1开启
├─ isBenefitboolean非必须是否优惠
├─ isBestboolean非必须是否精品
├─ isDelboolean非必须是否删除
├─ isGoodboolean非必须是否优品推荐
├─ isHotboolean非必须是否热卖
├─ isNewboolean非必须是否新品
├─ isPostageboolean非必须是否包邮
├─ isSeckillboolean非必须秒杀状态 0 未开启 1已开启
├─ isShowboolean非必须状态(0:未上架,1:上架)
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ merUseboolean非必须商户是否代理 0不可代理1可代理
├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ soureLinkstring非必须淘宝京东1688类型
├─ specTypeboolean非必须规格 0单 1多
├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ videoLinkstring非必须主图视频链接
├─ vipPricenumber非必须会员价格
├─ uidinteger非必须用户ID

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

商品评论数量

基本信息

Path: /api/front/reply/config/{id}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id

返回数据

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

format: int64

dataobject非必须产品评价数量和好评度
├─ goodCountinteger非必须好评总数

format: int64

├─ inCountinteger非必须中评总数

format: int64

├─ poorCountinteger非必须差评总数

format: int64

├─ replyChancestring非必须好评率
├─ replyStarinteger非必须评分星数

format: int32

├─ sumCountinteger非必须评论总数

format: int64

messagestring非必须

商品详情

基本信息

Path: /api/front/product/detail/{id}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id

返回数据

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

format: int64

dataobject非必须商品详情H5
├─ activityobject []非必须拼团,砍价,秒杀商品集合

item 类型: object

├─ base64Imagestring非必须主图base64
├─ goodListobject []非必须优品推荐列表

item 类型: object

├─ activityobject []非必须秒杀,团购,砍价

item 类型: object

├─ checkCouponboolean非必须可用优惠券
├─ idinteger非必须id

format: int32

├─ imagestring非必须img Url
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价
├─ storeNamestring非必须商品名称
├─ priceNamestring非必须返佣金额区间
├─ productAttrobject []非必须产品属性

item 类型: object

├─ productValueobject非必须商品属性详情
├─ replyobject非必须最新评价
├─ replyChanceinteger非必须好评率

format: int32

├─ replyCountinteger非必须评价数量

format: int32

├─ storeInfoobject非必须商品表
├─ activitystring非必须活动显示排序1=秒杀,2=砍价,3=拼团
├─ addTimeinteger非必须添加时间

format: int32

├─ barCodestring非必须商品条码(一维码)
├─ browseinteger非必须浏览量

format: int32

├─ cateIdstring非必须分类id
├─ cateIdsinteger []非必须

item 类型: integer

├─ 非必须
├─ cateValuesstring非必须分类中文
├─ codePathstring非必须商品二维码地址(用户小程序海报)
├─ contentstring非必须商品描述
├─ costnumber非必须成本价
├─ fictiinteger非必须虚拟销量

format: int32

├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isBargainboolean非必须砍价状态 0未开启 1开启
├─ isBenefitboolean非必须是否优惠
├─ isBestboolean非必须是否精品
├─ isDelboolean非必须是否删除
├─ isGoodboolean非必须是否优品推荐
├─ isHotboolean非必须是否热卖
├─ isNewboolean非必须是否新品
├─ isPostageboolean非必须是否包邮
├─ isSeckillboolean非必须秒杀状态 0 未开启 1已开启
├─ isShowboolean非必须状态(0:未上架,1:上架)
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ merUseboolean非必须商户是否代理 0不可代理1可代理
├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ soureLinkstring非必须淘宝京东1688类型
├─ specTypeboolean非必须规格 0单 1多
├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ userCollectboolean非必须收藏标识
├─ userLikeboolean非必须点赞标识
├─ videoLinkstring非必须主图视频链接
├─ vipPricenumber非必须会员价格
messagestring非必须

获取分类

基本信息

Path: /api/front/category

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ child []非必须
├─ 非必须
├─ extrastring非必须扩展字段
├─ idinteger非必须

format: int32

├─ namestring非必须分类名称
├─ pathstring非必须路径
├─ pidinteger非必须父级ID

format: int32

├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态, 0正常,1失效
├─ typeinteger非必须类型,类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置

format: int32

├─ urlstring非必须地址
messagestring非必须

商品 -- 购物车

修改

基本信息

Path: /api/front/cart/num

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

datastring非必须
messagestring非必须

分页列表

基本信息

Path: /api/front/cart/list

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ addTimestring非必须
├─ attrStatusboolean非必须商品是否有效
├─ bargainIdinteger非必须砍价id

format: int32

├─ brokeragenumber非必须一级分佣
├─ brokerageTwonumber非必须二级分佣
├─ cartNuminteger非必须商品数量

format: int32

├─ combinationIdinteger非必须拼团id

format: int32

├─ costPricenumber非必须
├─ idinteger非必须购物车表ID

format: int64

├─ isNewboolean非必须是否为立即购买
├─ isReplyinteger非必须

format: int32

├─ productAttrUniquestring非必须商品属性
├─ productIdinteger非必须商品ID

format: int32

├─ productInfoobject非必须商品信息,购物车列表使用
├─ attrInfoobject非必须商品属性值表
├─ attrValuestring非必须产品属性值和属性名对应关系
├─ barCodestring非必须商品条码
├─ brokeragenumber非必须一级返佣
├─ brokerageTwonumber非必须二级返佣
├─ costnumber非必须成本价
├─ idinteger非必须attrId

format: int32

├─ imagestring非必须图片
├─ otPricenumber非必须原价
├─ pricenumber非必须属性金额
├─ productIdinteger非必须商品ID

format: int32

├─ quotainteger非必须活动限购数量

format: int32

├─ quotaShowinteger非必须活动限购数量显示

format: int32

├─ salesinteger非必须销量

format: int32

├─ stockinteger非必须属性对应的库存

format: int32

├─ sukstring非必须商品属性索引值 (attr_value|attr_value[|....])
├─ typeinteger非必须活动类型 0=商品,1=秒杀,2=砍价,3=拼团

format: int32

├─ uniquestring非必须唯一值
├─ volumenumber非必须体积
├─ weightnumber非必须重量
├─ barCodestring非必须商品条码(一维码)
├─ cateIdstring非必须分类id
├─ costnumber非必须成本价
├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isPostageboolean非必须是否包邮
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ vipPricenumber非必须会员价格
├─ seckillIdinteger非必须秒杀商品ID

format: int32

├─ truePricenumber非必须
├─ trueStockinteger非必须

format: int32

├─ typestring非必须类型
├─ uidinteger非必须用户ID

format: int32

├─ vipTruePricenumber非必须
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

删除

基本信息

Path: /api/front/cart/delete

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

datastring非必须
messagestring非必须

数量

基本信息

Path: /api/front/cart/count

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
messagestring非必须

新增

基本信息

Path: /api/front/cart/save

Method: POST

接口描述:

请求参数

Headers

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

Query

参数名称 是否必须 示例 备注
cartNum 商品数量
isNew 是否为立即购买
productAttrUnique 商品属性 -- attr 对象的id
productId 商品ID

返回数据

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

format: int64

dataobject非必须
messagestring非必须

购物车重选提交

基本信息

Path: /api/front/cart/resetcart

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
idinteger非必须购物车id

format: int64

numinteger非必须购物车数量

format: int32

productIdinteger非必须商品id

format: int32

uniqueinteger非必须AttrValue Id

format: int32

返回数据

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

format: int64

dataobject非必须
messagestring非必须

城市服务

树形结构

基本信息

Path: /api/front/city/list

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

客服

客服列表

基本信息

Path: /api/front/user/service/lst

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ avatarstring非必须客服头像
├─ createTimestring非必须添加时间

format: date-time

├─ customerboolean非必须是否展示统计管理
├─ idinteger非必须客服id

format: int32

├─ nicknamestring非必须代理名称
├─ notifyinteger非必须订单通知1开启0关闭

format: int32

├─ statusboolean非必须0隐藏1显示
├─ uidinteger非必须客服uid

format: int32

├─ updateTimestring非必须更新时间

format: date-time

messagestring非必须

聊天记录

基本信息

Path: /api/front/user/service/record/{toUid}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
toUid 聊天人编号

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ createTimestring非必须添加时间

format: date-time

├─ idinteger非必须客服用户对话记录表ID

format: int32

├─ msnstring非必须消息内容
├─ msnTypeboolean非必须消息类型 1=文字 2=表情 3=图片 4=语音
├─ remindboolean非必须是否提醒过
├─ toUidinteger非必须接收人uid

format: int32

├─ typeboolean非必须是否已读(0:否;1:是;)
├─ uidinteger非必须发送人uid

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

微信 -- 开放平台

小程序获取授权logo

基本信息

Path: /api/front/wechat/getLogo

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

微信登录公共号授权登录

基本信息

Path: /api/front/wechat/authorize/login

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ expiresTimestring非必须用户登录密钥到期时间

format: date-time

├─ tokenstring非必须用户登录密钥
├─ userobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

微信登录小程序授权登录

基本信息

Path: /api/front/wechat/authorize/program/login

Method: POST

接口描述:

请求参数

Headers

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

Query

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

Body

名称类型是否必须默认值备注其他信息
avatarstring必须用户头像
citystring非必须普通用户个人资料填写的城市
countrystring非必须国家,如中国为CN
nickNamestring必须用户昵称
provincestring非必须用户个人资料填写的省份
sexstring必须性别
spread_spidinteger必须推广人id

format: int32

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ expiresTimestring非必须用户登录密钥到期时间

format: date-time

├─ tokenstring非必须用户登录密钥
├─ userobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

获取微信公众号js配置

基本信息

Path: /api/front/wechat/config

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
url 页面地址url

返回数据

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

format: int64

dataobject非必须
messagestring非必须

获取授权页面跳转地址

基本信息

Path: /api/front/wechat/authorize/get

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

详情

基本信息

Path: /api/front/wechat/info/{id}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id

返回数据

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

format: int64

dataobject非必须微信模板
├─ contentstring非必须回复内容
├─ createTimestring非必须添加时间

format: date-time

├─ idinteger非必须模板id

format: int32

├─ namestring非必须模板名
├─ statusinteger非必须状态

format: int32

├─ tempIdstring非必须模板ID
├─ tempKeystring非必须模板编号
├─ typeboolean非必须0=订阅消息,1=微信模板消息
├─ updateTimestring非必须更新时间

format: date-time

messagestring非必须

提货点

附近的提货点

基本信息

Path: /api/front/store/list

Method: POST

接口描述:

请求参数

Headers

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

Query

参数名称 是否必须 示例 备注
latitude 经度
limit 每页数量
longitude 纬度
page 页码

返回数据

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

format: int64

dataobject非必须附近的门店
├─ listobject []必须附近的门店列表

item 类型: object

├─ addressstring非必须省市区
├─ createTimestring非必须创建时间

format: date-time

├─ dayTimestring非必须每日营业开关时间
├─ detailedAddressstring非必须详细地址
├─ distancestring非必须距离,单位米
├─ idinteger非必须

format: int32

├─ imagestring非必须门店logo
├─ introductionstring非必须简介
├─ isDelboolean非必须是否删除
├─ isShowboolean非必须是否显示
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ namestring非必须门店名称
├─ phonestring非必须手机号码
├─ updateTimestring非必须修改时间

format: date-time

├─ validTimestring非必须核销有效日期
├─ tengXunMapKeystring非必须腾讯地图key
messagestring非必须

文章

分类列表

基本信息

Path: /api/front/article/category/list

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ child []非必须
├─ 非必须
├─ extrastring非必须扩展字段
├─ idinteger非必须

format: int32

├─ namestring非必须分类名称
├─ pathstring非必须路径
├─ pidinteger非必须父级ID

format: int32

├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态, 0正常,1失效
├─ typeinteger非必须类型,类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置

format: int32

├─ urlstring非必须地址
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

分页列表

基本信息

Path: /api/front/article/list/{cid}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
cid cid

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ adminIdinteger非必须管理员id

format: int32

├─ authorstring非必须文章作者
├─ categoryNamestring非必须分类
├─ cidstring非必须分类id
├─ contentstring非必须文章内容
├─ createTimestring非必须创建时间

format: date-time

├─ hideboolean非必须是否隐藏
├─ idinteger非必须文章管理ID

format: int32

├─ imageInputstring []非必须文章图片 前端用

item 类型: string

├─ 非必须
├─ imageInputsstring非必须文章图片 后端用
├─ isBannerboolean非必须是否轮播图(小程序)
├─ isHotboolean非必须是否热门(小程序)
├─ mediaIdstring非必须微信素材媒体id
├─ merIdinteger非必须商户id

format: int32

├─ productIdinteger非必须商品关联id

format: int32

├─ shareSynopsisstring非必须文章分享简介
├─ shareTitlestring非必须文章分享标题
├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态
├─ synopsisstring非必须文章简介
├─ titlestring非必须文章标题
├─ updateTimestring非必须更新时间

format: date-time

├─ urlstring非必须原文链接
├─ visitstring非必须浏览次数
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

热门列表

基本信息

Path: /api/front/article/hot/list

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ adminIdinteger非必须管理员id

format: int32

├─ authorstring非必须文章作者
├─ categoryNamestring非必须分类
├─ cidstring非必须分类id
├─ contentstring非必须文章内容
├─ createTimestring非必须创建时间

format: date-time

├─ hideboolean非必须是否隐藏
├─ idinteger非必须文章管理ID

format: int32

├─ imageInputstring []非必须文章图片 前端用

item 类型: string

├─ 非必须
├─ imageInputsstring非必须文章图片 后端用
├─ isBannerboolean非必须是否轮播图(小程序)
├─ isHotboolean非必须是否热门(小程序)
├─ mediaIdstring非必须微信素材媒体id
├─ merIdinteger非必须商户id

format: int32

├─ productIdinteger非必须商品关联id

format: int32

├─ shareSynopsisstring非必须文章分享简介
├─ shareTitlestring非必须文章分享标题
├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态
├─ synopsisstring非必须文章简介
├─ titlestring非必须文章标题
├─ updateTimestring非必须更新时间

format: date-time

├─ urlstring非必须原文链接
├─ visitstring非必须浏览次数
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

详情

基本信息

Path: /api/front/article/info

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须文章管理表
├─ adminIdinteger非必须管理员id

format: int32

├─ authorstring非必须文章作者
├─ categoryNamestring非必须分类
├─ cidstring非必须分类id
├─ contentstring非必须文章内容
├─ createTimestring非必须创建时间

format: date-time

├─ hideboolean非必须是否隐藏
├─ idinteger非必须文章管理ID

format: int32

├─ imageInputstring []非必须文章图片 前端用

item 类型: string

├─ 非必须
├─ imageInputsstring非必须文章图片 后端用
├─ isBannerboolean非必须是否轮播图(小程序)
├─ isHotboolean非必须是否热门(小程序)
├─ mediaIdstring非必须微信素材媒体id
├─ merIdinteger非必须商户id

format: int32

├─ productIdinteger非必须商品关联id

format: int32

├─ shareSynopsisstring非必须文章分享简介
├─ shareTitlestring非必须文章分享标题
├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态
├─ synopsisstring非必须文章简介
├─ titlestring非必须文章标题
├─ updateTimestring非必须更新时间

format: date-time

├─ urlstring非必须原文链接
├─ visitstring非必须浏览次数
messagestring非必须

轮播列表

基本信息

Path: /api/front/article/banner/list

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ adminIdinteger非必须管理员id

format: int32

├─ authorstring非必须文章作者
├─ categoryNamestring非必须分类
├─ cidstring非必须分类id
├─ contentstring非必须文章内容
├─ createTimestring非必须创建时间

format: date-time

├─ hideboolean非必须是否隐藏
├─ idinteger非必须文章管理ID

format: int32

├─ imageInputstring []非必须文章图片 前端用

item 类型: string

├─ 非必须
├─ imageInputsstring非必须文章图片 后端用
├─ isBannerboolean非必须是否轮播图(小程序)
├─ isHotboolean非必须是否热门(小程序)
├─ mediaIdstring非必须微信素材媒体id
├─ merIdinteger非必须商户id

format: int32

├─ productIdinteger非必须商品关联id

format: int32

├─ shareSynopsisstring非必须文章分享简介
├─ shareTitlestring非必须文章分享标题
├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态
├─ synopsisstring非必须文章简介
├─ titlestring非必须文章标题
├─ updateTimestring非必须更新时间

format: date-time

├─ urlstring非必须原文链接
├─ visitstring非必须浏览次数
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

物流公司

列表

基本信息

Path: /api/front/logistics

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ codestring非必须快递公司简称
├─ idinteger非必须快递公司id

format: int32

├─ isShowboolean非必须是否显示
├─ namestring非必须快递公司全称
├─ sortinteger非必须排序

format: int32

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

用户 -- 充值

余额转入

基本信息

Path: /api/front/recharge/transferIn

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

databoolean非必须
messagestring非必须

充值额度选择

基本信息

Path: /api/front/recharge/index

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须c
├─ giveMoneystring非必须赠送金额
├─ idinteger非必须充值模板id

format: int32

├─ pricestring非必须充值金额
messagestring非必须

公众号充值

基本信息

Path: /api/front/recharge/wechat

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
fromstring非必须来源 | public = 微信公众号, weixinh5 =微信H5支付, routine = 小程序
payTypestring非必须支付方式| weixin = 微信,alipay = 支付宝
pricenumber非必须充值金额
rechar_idinteger非必须选择金额组合数据id

format: int32

返回数据

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

format: int64

dataobject非必须充值返回对象
├─ appIdstring非必须调用接口提交的公众账号ID
├─ h5PayUrlstring非必须H5支付的跳转url
├─ nonceStrstring非必须随机字符串
├─ packagestring非必须订单详情扩展字符串
├─ paySignstring非必须签名
├─ prepayIdstring非必须微信生成的预支付回话标识,用于后续接口调用中使用,该值有效期为2小时,针对H5支付此参数无特殊用途
├─ signTypestring非必须签名方式
├─ timeStampinteger非必须当前的时间,其他详见时间戳规则

format: int32

messagestring非必须

小程序充值

基本信息

Path: /api/front/recharge/routine

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
fromstring非必须来源 | public = 微信公众号, weixinh5 =微信H5支付, routine = 小程序
payTypestring非必须支付方式| weixin = 微信,alipay = 支付宝
pricenumber非必须充值金额
rechar_idinteger非必须选择金额组合数据id

format: int32

返回数据

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

format: int64

dataobject非必须
messagestring非必须

用户 -- 地址

保存

基本信息

Path: /api/front/address/edit

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
addressobject必须用户地址城市
├─ citystring必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ districtstring必须收货人所在区
├─ provincestring必须收货人所在省
detailstring必须收货人详细地址
idinteger非必须用户地址id

format: int32

isDefaultboolean必须是否默认
phonestring必须收货人电话
realNamestring必须收货人姓名

返回数据

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

format: int64

dataobject非必须用户地址表
├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

messagestring非必须

列表

基本信息

Path: /api/front/address/list

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

删除

基本信息

Path: /api/front/address/del

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
idinteger非必须用户地址id

format: int32

返回数据

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

format: int64

datastring非必须
messagestring非必须

获取单个地址

基本信息

Path: /api/front/address/detail/{id}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id

返回数据

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

format: int64

dataobject非必须用户地址表
├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

messagestring非必须

获取默认地址

基本信息

Path: /api/front/address/default

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须用户地址表
├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

messagestring非必须

设置默认地址

基本信息

Path: /api/front/address/default/set

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
idinteger非必须用户地址id

format: int32

返回数据

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

format: int64

dataobject非必须用户地址表
├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

messagestring非必须

用户 -- 点赞/收藏

取消收藏产品

基本信息

Path: /api/front/collect/del

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
categorystring非必须产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store)
idinteger非必须商品ID

format: int32

返回数据

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

format: int64

datastring非必须
messagestring非必须

批量收藏

基本信息

Path: /api/front/collect/all

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
categorystring非必须产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store)
idinteger []非必须商品ID

item 类型: integer

├─ 非必须

返回数据

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

format: int64

datastring非必须
messagestring非必须

添加收藏产品

基本信息

Path: /api/front/collect/add

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
categorystring非必须产品类型|store=普通产品,product_seckill=秒杀产品(默认 普通产品 store)
idinteger非必须商品ID

format: int32

返回数据

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

format: int64

datastring非必须
messagestring非必须

获取收藏产品

基本信息

Path: /api/front/collect/user

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ activitystring非必须活动显示排序1=秒杀,2=砍价,3=拼团
├─ addTimeinteger非必须添加时间

format: int32

├─ barCodestring非必须商品条码(一维码)
├─ browseinteger非必须浏览量

format: int32

├─ cateIdstring非必须分类id
├─ codePathstring非必须商品二维码地址(用户小程序海报)
├─ costnumber非必须成本价
├─ fictiinteger非必须虚拟销量

format: int32

├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isBargainboolean非必须砍价状态 0未开启 1开启
├─ isBenefitboolean非必须是否优惠
├─ isBestboolean非必须是否精品
├─ isDelboolean非必须是否删除
├─ isGoodboolean非必须是否优品推荐
├─ isHotboolean非必须是否热卖
├─ isNewboolean非必须是否新品
├─ isPostageboolean非必须是否包邮
├─ isSeckillboolean非必须秒杀状态 0 未开启 1已开启
├─ isShowboolean非必须状态(0:未上架,1:上架)
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ merUseboolean非必须商户是否代理 0不可代理1可代理
├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ soureLinkstring非必须淘宝京东1688类型
├─ specTypeboolean非必须规格 0单 1多
├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ videoLinkstring非必须主图视频链接
├─ vipPricenumber非必须会员价格
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

用户 -- 用户中心

会员等级列表

基本信息

Path: /api/front/user/level/grade

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ createTimestring非必须创建时间

format: date-time

├─ discountnumber非必须享受折扣
├─ experienceinteger非必须购买金额|经验达到

format: int32

├─ gradeinteger非必须会员等级

format: int32

├─ iconstring非必须会员图标
├─ idinteger非必须

format: int32

├─ imagestring非必须会员卡背景
├─ isDelboolean非必须是否删除.1=删除,0=未删除
├─ isShowboolean非必须是否显示 1=显示,0=隐藏
├─ memostring非必须说明
├─ namestring非必须会员名称
├─ updateTimestring非必须创建时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

佣金排行

基本信息

Path: /api/front/brokerage_rank

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

修改个人资料

基本信息

Path: /api/front/user/edit

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
avatarstring非必须用户头像
nicknamestring非必须用户昵称

返回数据

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

format: int64

databoolean非必须
messagestring非必须

当前用户在佣金排行第几名

基本信息

Path: /api/front/user/brokerageRankNumber

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

datainteger非必须

format: int32

messagestring非必须

当前登录用户信息

基本信息

Path: /api/front/userinfo

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

手机号修改密码

基本信息

Path: /api/front/register/reset

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号
captchastring必须验证码
passwordstring必须密码

返回数据

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

format: int64

databoolean非必须
messagestring非必须

推广人排行

基本信息

Path: /api/front/rank

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

推广佣金/提现总和

基本信息

Path: /api/front/spread/count/{type}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 类型 佣金类型3=佣金,4=提现

返回数据

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

format: int64

dataobject非必须
messagestring非必须

推广佣金明细

基本信息

Path: /api/front/spread/commission/{type}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 类型 佣金类型 0=全部,1=消费,2=充值,3=返佣,4=提现

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ datestring非必须月份
├─ listobject []非必须数据

item 类型: object

├─ add_timestring非必须创建时间

format: date-time

├─ balancenumber非必须剩余
├─ categorystring非必须明细种类
├─ idinteger非必须用户账单id

format: int32

├─ linkIdstring非必须关联id
├─ markstring非必须备注
├─ numbernumber非必须明细数字
├─ pminteger非必须0 = 支出 1 = 获得

format: int32

├─ statusinteger非必须0 = 带确定 1 = 有效 -1 = 无效

format: int32

├─ titlestring非必须账单标题
├─ typestring非必须明细类型
├─ uidinteger非必须用户uid

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

推广数据接口(昨天的佣金 累计提现金额 当前佣金)

<a id=推广数据接口(昨天的佣金 累计提现金额 当前佣金)>

基本信息

Path: /api/front/commission

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须推广佣金明细
├─ commissionCountnumber非必须当前佣金
├─ extractCountnumber非必须累计提现金额
├─ lastDayCountnumber非必须昨天的佣金
messagestring非必须

推广海报图

基本信息

Path: /api/front/user/spread/banner

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ idinteger非必须id

format: int32

├─ picstring非必须背景图
├─ titlestring非必须名称
messagestring非必须

推广用户

基本信息

Path: /api/front/spread/people

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
grade 推荐人类型 0=一级 1=二级
isAsc 排序值 DESC ASC
keyword 搜索关键字
limit 每页数量
page 页码
sortKey 排序, 排序 childCount=团队排序,numberCount=金额排序,orderCount=订单排序

返回数据

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

format: int64

dataobject非必须推广人信息
├─ avatarstring非必须用户头像
├─ childCountinteger非必须推广人数

format: int32

├─ nicknamestring非必须用户昵称
├─ numberCountnumber非必须订单金额
├─ orderCountinteger非必须订单数量

format: int32

├─ timestring非必须添加时间
├─ uidinteger非必须用户编号

format: int32

messagestring非必须

推广订单

基本信息

Path: /api/front/spread/order

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须推广订单
├─ countinteger非必须累计推广订单

format: int64

├─ listobject []非必须推广人列表

item 类型: object

├─ childobject []非必须推广订单信息

item 类型: object

├─ avatarstring非必须用户头像
├─ nicknamestring非必须用户昵称
├─ numbernumber非必须返佣金额
├─ orderIdstring非必须订单号
├─ timestring非必须返佣时间

format: date-time

├─ typestring非必须订单显示类型
├─ countinteger非必须推广条数

format: int32

├─ timestring非必须推广年月
messagestring非必须

提现申请

基本信息

Path: /api/front/extract/cash

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
alipayCodestring非必须支付宝账号
banknamestring非必须提现银行名称
cardumstring非必须银行卡
extractTypestring非必须提现方式| alipay=支付宝,bank=银行卡,weixin=微信
moneynumber非必须提现金额
namestring非必须姓名
wechatstring非必须微信号

返回数据

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

format: int64

databoolean非必须
messagestring非必须

提现银行/提现最低金额

基本信息

Path: /api/front/extract/bank

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须提现银行/提现最低金额
├─ brokenCommissionnumber非必须冻结佣金
├─ brokenDaystring非必须冻结天数
├─ commissionCountnumber非必须可提现佣金
├─ extractBankstring []非必须提现银行

item 类型: string

├─ 非必须
├─ minPricestring非必须提现最低金额
messagestring非必须

用户资金统计

基本信息

Path: /api/front/user/balance

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须用户资金统计
├─ nowMoneynumber非必须当前总资金
├─ orderStatusSumnumber非必须累计消费
├─ rechargenumber非必须累计充值
messagestring非必须

积分记录

基本信息

Path: /api/front/integral/list

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ add_timestring非必须创建时间

format: date-time

├─ balancenumber非必须剩余
├─ categorystring非必须明细种类
├─ idinteger非必须用户账单id

format: int32

├─ linkIdstring非必须关联id
├─ markstring非必须备注
├─ numbernumber非必须明细数字
├─ pminteger非必须0 = 支出 1 = 获得

format: int32

├─ statusinteger非必须0 = 带确定 1 = 有效 -1 = 无效

format: int32

├─ titlestring非必须账单标题
├─ typestring非必须明细类型
├─ uidinteger非必须用户uid

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

经验记录

基本信息

Path: /api/front/user/expList

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ add_timestring非必须创建时间

format: date-time

├─ balancenumber非必须剩余
├─ categorystring非必须明细种类
├─ idinteger非必须用户账单id

format: int32

├─ linkIdstring非必须关联id
├─ markstring非必须备注
├─ numbernumber非必须明细数字
├─ pminteger非必须0 = 支出 1 = 获得

format: int32

├─ statusinteger非必须0 = 带确定 1 = 有效 -1 = 无效

format: int32

├─ titlestring非必须账单标题
├─ typestring非必须明细类型
├─ uidinteger非必须用户uid

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

绑定手机号

基本信息

Path: /api/front/binding

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号
captchastring必须验证码

返回数据

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

format: int64

databoolean非必须
messagestring非必须

获取个人中心菜单

基本信息

Path: /api/front/menu/user

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

获取个人资料

基本信息

Path: /api/front/user

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须个人中心
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdayinteger非必须生日

format: int32

├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ couponCountinteger非必须用户优惠券数量

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdinteger非必须用户分组id

format: int32

├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ orderStatusNumobject非必须个人中心 -- 订单状态数量
├─ noBuyinteger非必须未支付订单数量

format: int32

├─ noPinkinteger非必须拼团的订单数量

format: int32

├─ noPostageinteger非必须未发货订单数量

format: int32

├─ noRefundinteger非必须退款的订单数量

format: int32

├─ noReplyinteger非必须未评论订单数量

format: int32

├─ noTakeinteger非必须未收货订单数量

format: int32

├─ partnerIdinteger非必须合伙人id

format: int32

├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ pwdstring非必须用户密码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广元id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
├─ vipboolean非必须是否会员
├─ vipIconstring非必须会员图标
├─ vipNamestring非必须会员名称
messagestring非必须

用户 -- 登录注册

发送短信

基本信息

Path: /api/front/sendCode

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

dataobject非必须
messagestring非必须

手机号登录接口

基本信息

Path: /api/front/login/mobile

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号
captchastring必须验证码
spreadinteger非必须推广人id

format: int32

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ expiresTimestring非必须用户登录密钥到期时间

format: date-time

├─ tokenstring非必须用户登录密钥
├─ userobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

账号密码登录

基本信息

Path: /api/front/login

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号
passwordstring必须密码

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ expiresTimestring非必须用户登录密钥到期时间

format: date-time

├─ tokenstring非必须用户登录密钥
├─ userobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
messagestring非必须

退出

基本信息

Path: /api/front/logout

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

datastring非必须
messagestring非必须

用户 -- 签到

分页列表

基本信息

Path: /api/front/user/sign/list

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ createDaystring非必须签到日期

format: date-time

├─ numberinteger非必须获得积分

format: int32

├─ titlestring非必须签到说明
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

分页列表

基本信息

Path: /api/front/user/sign/month

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ createDaystring非必须签到日期

format: date-time

├─ numberinteger非必须获得积分

format: int32

├─ titlestring非必须签到说明
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

签到

基本信息

Path: /api/front/user/sign/integral

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须签到记录
├─ dayinteger非必须第几天

format: int32

├─ experienceinteger非必须经验

format: int32

├─ idinteger非必须

format: int32

├─ integralinteger非必须积分

format: int32

├─ titlestring非必须显示文字
messagestring非必须

签到用户信息

基本信息

Path: /api/front/user/sign/user

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
allboolean非必须是否统计签到和统计积分使用情况|1=是,0=否
integralboolean非必须是否统计积分使用情况|1=是,0=否
signboolean非必须是否统计签到|1=是,0=否

返回数据

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

format: int64

dataobject非必须修改个人资料
├─ avatarstring非必须用户头像
├─ deductionIntegralinteger非必须累计抵扣积分

format: int32

├─ integralnumber非必须用户剩余积分
├─ isDaySignboolean非必须今天是否签到
├─ isPromoterboolean非必须是否为推广员
├─ isYesterdaySignboolean非必须昨天是否签到
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ payCountinteger非必须用户购买次数

format: int32

├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ sumIntegralinteger非必须累计总积分

format: int32

├─ sumSignDayinteger非必须累计签到次数

format: int32

├─ uidinteger非必须用户id

format: int32

├─ yesterdayIntegralinteger非必须昨天累计积分

format: int32

messagestring非必须

详情

基本信息

Path: /api/front/user/sign/get

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

配置

基本信息

Path: /api/front/user/sign/config

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
├─ limitinteger非必须

format: int32

├─ listobject []非必须

item 类型: object

├─ dayinteger非必须第几天

format: int32

├─ experienceinteger非必须经验

format: int32

├─ idinteger非必须

format: int32

├─ integralinteger非必须积分

format: int32

├─ titlestring非必须显示文字
├─ pageinteger非必须

format: int32

├─ totalinteger非必须

format: int64

├─ totalPageinteger非必须

format: int32

messagestring非必须

营销 -- 优惠券

我的优惠券

基本信息

Path: /api/front/coupon/list

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ avatarstring非必须用户头像
├─ cidinteger非必须兑换的项目id

format: int32

├─ couponIdinteger非必须优惠券发布id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ endTimestring非必须过期时间

format: date-time

├─ idinteger非必须id

format: int32

├─ isValidboolean非必须用户头像
├─ minPricenumber非必须最低消费多少金额可用优惠券
├─ moneynumber非必须优惠券的面值
├─ namestring非必须优惠券名称
├─ nicknamestring非必须用户昵称
├─ primaryKeystring必须主键id 商品id/分类id
├─ startTimestring非必须开始使用时间

format: date-time

├─ statusinteger非必须状态(0:未使用,1:已使用, 2:已失效)

format: int32

├─ typestring非必须获取方式
├─ uidinteger非必须领取人id

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ useTimestring非必须使用时间

format: date-time

├─ useTypeinteger非必须使用类型 1 全场通用, 2 商品券, 3 品类券

format: int32

messagestring非必须

批量领券

基本信息

Path: /api/front/coupon/receive/batch

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
couponIdinteger []非必须优惠券id

item 类型: integer

├─ 非必须

返回数据

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

format: int64

datastring非必须
messagestring非必须

领券

基本信息

Path: /api/front/coupon/receive

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
couponIdinteger []非必须优惠券id

item 类型: integer

├─ 非必须

返回数据

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

format: int64

datastring非必须
messagestring非必须

订单

再次下单

基本信息

Path: /api/front/order/again

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
nuistring非必须订单id

返回数据

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

format: int64

dataobject非必须
messagestring非必须

删除订单

基本信息

Path: /api/front/order/del

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

databoolean非必须
messagestring非必须

待评价商品信息查询

基本信息

Path: /api/front/order/product

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
orderIdinteger非必须订单id

format: int32

unistring非必须商品attrid

返回数据

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

format: int64

dataobject非必须
messagestring非必须

支付

基本信息

Path: /api/front/order/pay

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
fromstring非必须支付平台
paytypestring非必须支付类型
unistring非必须订单id

返回数据

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

format: int64

dataobject非必须
messagestring非必须

物流信息查询

基本信息

Path: /api/front/order/express/{orderId}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
orderId orderId

返回数据

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

format: int64

dataobject非必须
messagestring非必须

生成订单

基本信息

Path: /api/front/order/create/{key}

Method: POST

接口描述:

请求参数

Headers

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

路径参数

参数名称 示例 备注
key key

Body

名称类型是否必须默认值备注其他信息
addressIdinteger非必须收货地址id

format: int32

bargainIdinteger非必须

format: int32

combinationIdinteger非必须

format: int32

couponIdinteger非必须

format: int32

formIdinteger非必须

format: int32

fromstring非必须
isNewboolean必须是否为立即购买
markstring非必须
payTypestring非必须
phonestring非必须手机号码
pinkIdinteger非必须

format: int32

realNamestring非必须真实名称
seckillIdinteger非必须

format: int32

shippingTypeinteger非必须快递类型

format: int32

storeIdinteger非必须

format: int32

useIntegralboolean非必须

返回数据

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

format: int64

dataobject非必须
messagestring非必须

确认订单

基本信息

Path: /api/front/order/confirm

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

dataobject非必须
├─ addressInfoobject非必须用户地址表
├─ citystring非必须收货人所在市
├─ cityIdinteger非必须城市id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ detailstring非必须收货人详细地址
├─ districtstring非必须收货人所在区
├─ idinteger非必须用户地址id

format: int32

├─ isDefaultboolean非必须是否默认
├─ isDelboolean非必须是否删除
├─ latitudestring非必须纬度
├─ longitudestring非必须经度
├─ phonestring非必须收货人电话
├─ postCodeinteger非必须邮编

format: int32

├─ provincestring非必须收货人所在省
├─ realNamestring非必须收货人姓名
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ cartInfoobject []非必须

item 类型: object

├─ addTimestring非必须
├─ attrStatusboolean非必须商品是否有效
├─ bargainIdinteger非必须砍价id

format: int32

├─ brokeragenumber非必须一级分佣
├─ brokerageTwonumber非必须二级分佣
├─ cartNuminteger非必须商品数量

format: int32

├─ combinationIdinteger非必须拼团id

format: int32

├─ costPricenumber非必须
├─ idinteger非必须购物车表ID

format: int64

├─ isNewboolean非必须是否为立即购买
├─ isReplyinteger非必须

format: int32

├─ productAttrUniquestring非必须商品属性
├─ productIdinteger非必须商品ID

format: int32

├─ productInfoobject非必须商品信息,购物车列表使用
├─ attrInfoobject非必须商品属性值表
├─ attrValuestring非必须产品属性值和属性名对应关系
├─ barCodestring非必须商品条码
├─ brokeragenumber非必须一级返佣
├─ brokerageTwonumber非必须二级返佣
├─ costnumber非必须成本价
├─ idinteger非必须attrId

format: int32

├─ imagestring非必须图片
├─ otPricenumber非必须原价
├─ pricenumber非必须属性金额
├─ productIdinteger非必须商品ID

format: int32

├─ quotainteger非必须活动限购数量

format: int32

├─ quotaShowinteger非必须活动限购数量显示

format: int32

├─ salesinteger非必须销量

format: int32

├─ stockinteger非必须属性对应的库存

format: int32

├─ sukstring非必须商品属性索引值 (attr_value|attr_value[|....])
├─ typeinteger非必须活动类型 0=商品,1=秒杀,2=砍价,3=拼团

format: int32

├─ uniquestring非必须唯一值
├─ volumenumber非必须体积
├─ weightnumber非必须重量
├─ barCodestring非必须商品条码(一维码)
├─ cateIdstring非必须分类id
├─ costnumber非必须成本价
├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isPostageboolean非必须是否包邮
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ vipPricenumber非必须会员价格
├─ seckillIdinteger非必须秒杀商品ID

format: int32

├─ truePricenumber非必须
├─ trueStockinteger非必须

format: int32

├─ typestring非必须类型
├─ uidinteger非必须用户ID

format: int32

├─ vipTruePricenumber非必须
├─ deductionboolean非必须
├─ integralRatiostring非必须
├─ offlinePayStatusstring非必须
├─ offlinePostagestring非必须
├─ orderKeystring非必须
├─ otherobject非必须
├─ payWeixinOpenstring非必须
├─ priceGroupobject非必须
├─ costPricenumber非必须
├─ couponPricenumber非必须
├─ deductionPricenumber非必须
├─ payPostagenumber非必须
├─ payPricenumber非必须
├─ storeFreePostagenumber非必须
├─ storePostagenumber非必须
├─ totalPricenumber非必须
├─ usedIntegralnumber非必须
├─ vipPricenumber非必须
├─ storeSelfMentionstring非必须
├─ systemStorestring非必须
├─ usableCouponobject非必须优惠券记录表
├─ avatarstring非必须用户头像
├─ cidinteger非必须兑换的项目id

format: int32

├─ couponIdinteger非必须优惠券发布id

format: int32

├─ createTimestring非必须创建时间

format: date-time

├─ endTimestring非必须过期时间

format: date-time

├─ idinteger非必须id

format: int32

├─ isValidboolean非必须用户头像
├─ minPricenumber非必须最低消费多少金额可用优惠券
├─ moneynumber非必须优惠券的面值
├─ namestring非必须优惠券名称
├─ nicknamestring非必须用户昵称
├─ primaryKeystring必须主键id 商品id/分类id
├─ startTimestring非必须开始使用时间

format: date-time

├─ statusinteger非必须状态(0:未使用,1:已使用, 2:已失效)

format: int32

├─ typestring非必须获取方式
├─ uidinteger非必须领取人id

format: int32

├─ updateTimestring非必须更新时间

format: date-time

├─ useTimestring非必须使用时间

format: date-time

├─ useTypeinteger非必须使用类型 1 全场通用, 2 商品券, 3 品类券

format: int32

├─ userInfoobject非必须用户表
├─ accountstring非必须用户账号
├─ addIpstring非必须添加ip
├─ addresstring非必须详细地址
├─ adminidinteger非必须管理员编号

format: int32

├─ avatarstring非必须用户头像
├─ birthdaystring非必须生日
├─ brokeragePricenumber非必须佣金金额
├─ cardIdstring非必须身份证号码
├─ cleanTimestring非必须最后一次登录时间

format: date-time

├─ createTimestring非必须创建时间

format: date-time

├─ experienceinteger非必须用户剩余经验

format: int32

├─ groupIdstring非必须用户分组id
├─ integralnumber非必须用户剩余积分
├─ isPromoterboolean非必须是否为推广员
├─ lastIpstring非必须最后一次登录ip
├─ lastLoginTimestring非必须最后一次登录时间

format: date-time

├─ levelinteger非必须等级

format: int32

├─ loginTypestring非必须用户登陆类型,h5,wechat,routine
├─ markstring非必须用户备注
├─ nicknamestring非必须用户昵称
├─ nowMoneynumber非必须用户余额
├─ partnerIdinteger非必须合伙人id

format: int32

├─ pathstring非必须用户推广等级
├─ payCountinteger非必须用户购买次数

format: int32

├─ phonestring非必须手机号码
├─ realNamestring非必须真实姓名
├─ signNuminteger非必须连续签到天数

format: int32

├─ spreadCountinteger非必须下级人数

format: int32

├─ spreadTimestring非必须推广员关联时间

format: date-time

├─ spreadUidinteger非必须推广人id

format: int32

├─ statusboolean非必须1为正常,0为禁止
├─ subscribeboolean非必须是否关注公众号
├─ tagIdstring非必须用户标签id
├─ uidinteger非必须用户id

format: int32

├─ updateTimestring非必须创建时间

format: date-time

├─ userTypestring非必须用户类型
├─ yuePayStatusstring非必须
messagestring非必须

计算价格

基本信息

Path: /api/front/order/computed/{key}

Method: POST

接口描述:

请求参数

Headers

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

路径参数

参数名称 示例 备注
key key

Body

名称类型是否必须默认值备注其他信息
addressIdinteger非必须地址id

format: int32

couponIdinteger非必须优惠券id

format: int32

payTypestring非必须支付类型
shippingTypeinteger非必须快递类型

format: int32

useIntegralboolean非必须抵扣积分

返回数据

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

format: int64

dataobject非必须
messagestring非必须

订单列表

基本信息

Path: /api/front/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
limit 每页数量
page 页码
type 评价等级 0=未支付,1=待发货,2=待收货,3=待评价,4=已完成

返回数据

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

format: int64

dataobject []非必须

item 类型: object

├─ addTimestring非必须
├─ cartInfoobject []非必须

item 类型: object

├─ infoobject非必须购物车ListResponse
├─ addTimestring非必须
├─ attrStatusboolean非必须商品是否有效
├─ bargainIdinteger非必须砍价id

format: int32

├─ brokeragenumber非必须一级分佣
├─ brokerageTwonumber非必须二级分佣
├─ cartNuminteger非必须商品数量

format: int32

├─ combinationIdinteger非必须拼团id

format: int32

├─ costPricenumber非必须
├─ idinteger非必须购物车表ID

format: int64

├─ isNewboolean非必须是否为立即购买
├─ isReplyinteger非必须

format: int32

├─ productAttrUniquestring非必须商品属性
├─ productIdinteger非必须商品ID

format: int32

├─ productInfoobject非必须商品信息,购物车列表使用
├─ attrInfoobject非必须商品属性值表
├─ attrValuestring非必须产品属性值和属性名对应关系
├─ barCodestring非必须商品条码
├─ brokeragenumber非必须一级返佣
├─ brokerageTwonumber非必须二级返佣
├─ costnumber非必须成本价
├─ idinteger非必须attrId

format: int32

├─ imagestring非必须图片
├─ otPricenumber非必须原价
├─ pricenumber非必须属性金额
├─ productIdinteger非必须商品ID

format: int32

├─ quotainteger非必须活动限购数量

format: int32

├─ quotaShowinteger非必须活动限购数量显示

format: int32

├─ salesinteger非必须销量

format: int32

├─ stockinteger非必须属性对应的库存

format: int32

├─ sukstring非必须商品属性索引值 (attr_value|attr_value[|....])
├─ typeinteger非必须活动类型 0=商品,1=秒杀,2=砍价,3=拼团

format: int32

├─ uniquestring非必须唯一值
├─ volumenumber非必须体积
├─ weightnumber非必须重量
├─ barCodestring非必须商品条码(一维码)
├─ cateIdstring非必须分类id
├─ costnumber非必须成本价
├─ giveIntegralnumber非必须获得积分
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ isPostageboolean非必须是否包邮
├─ isSubboolean非必须是否单独分佣
├─ keywordstring非必须关键字
├─ merIdinteger非必须商户Id(0为总后台管理员创建,不为0的时候是商户后台创建)

format: int32

├─ otPricenumber非必须市场价
├─ postagenumber非必须邮费
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sliderImagestring非必须轮播图
├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeInfostring非必须商品简介
├─ storeNamestring非必须商品名称
├─ tempIdinteger非必须运费模板ID

format: int32

├─ unitNamestring非必须单位名
├─ vipPricenumber非必须会员价格
├─ seckillIdinteger非必须秒杀商品ID

format: int32

├─ truePricenumber非必须
├─ trueStockinteger非必须

format: int32

├─ typestring非必须类型
├─ uidinteger非必须用户ID

format: int32

├─ vipTruePricenumber非必须
├─ orderIdinteger非必须订单id

format: int32

├─ productIdinteger非必须商品ID

format: int32

├─ uniquestring非必须唯一id
├─ offlinePayStatusinteger非必须

format: int32

├─ payTimestring非必须
├─ statusobject非必须
├─ deliveryTypestring非必须
├─ msgstring非必须
├─ payTypestring非必须
├─ titlestring非必须
├─ typeinteger非必须

format: int32

├─ statusPicstring非必须
├─ storeOrderobject非必须订单表
├─ backIntegralnumber非必须给用户退了多少积分
├─ bargainIdinteger非必须砍价id

format: int32

├─ clerkIdinteger非必须店员id

format: int32

├─ combinationIdinteger非必须拼团商品id0一般商品

format: int32

├─ costnumber非必须成本价
├─ couponIdinteger非必须优惠券id

format: int32

├─ couponPricenumber非必须优惠券金额
├─ createTimestring非必须创建时间

format: date-time

├─ deductionPricenumber非必须抵扣金额
├─ deliveryIdstring非必须快递单号/手机号
├─ deliveryNamestring非必须快递名称/送货人姓名
├─ deliveryTypestring非必须发货类型
├─ freightPricenumber非必须运费金额
├─ gainIntegralnumber非必须消费赚取积分
├─ idinteger非必须订单ID

format: int32

├─ isChannelinteger非必须支付渠道(0微信公众号1微信小程序)

format: int32

├─ isDelboolean非必须是否删除
├─ isMerCheckinteger非必须

format: int32

├─ isRemindboolean非必须消息提醒
├─ isSystemDelboolean非必须后台是否删除
├─ markstring非必须备注
├─ merIdinteger非必须商户ID

format: int32

├─ orderIdstring非必须订单号
├─ paidboolean非必须支付状态
├─ payPostagenumber非必须支付邮费
├─ payPricenumber非必须实际支付金额
├─ payTimestring非必须支付时间

format: date-time

├─ payTypestring非必须支付方式
├─ pinkIdinteger非必须拼团id 0没有拼团

format: int32

├─ realNamestring非必须用户姓名
├─ refundPricenumber非必须退款金额
├─ refundReasonstring非必须不退款的理由
├─ refundReasonTimestring非必须退款时间

format: date-time

├─ refundReasonWapstring非必须前台退款原因
├─ refundReasonWapExplainstring非必须退款用户说明
├─ refundReasonWapImgstring非必须退款图片
├─ refundStatusinteger非必须0 未退款 1 申请中 2 已退款

format: int32

├─ remarkstring非必须管理员备注
├─ seckillIdinteger非必须秒杀商品ID

format: int32

├─ shippingTypeinteger非必须配送方式 1=快递 ,2=门店自提

format: int32

├─ statusinteger非必须订单状态(-1 : 申请退款 -2 : 退货成功 0:待发货;1:待收货;2:已收货,待评价;3:已完成;)

format: int32

├─ storeIdinteger非必须门店id

format: int32

├─ totalNuminteger非必须订单商品总数

format: int32

├─ totalPostagenumber非必须邮费
├─ totalPricenumber非必须订单总价
├─ uidinteger非必须用户id

format: int32

├─ uniquestring非必须唯一id(md5加密)类似id
├─ useIntegralnumber非必须使用积分
├─ userAddressstring非必须详细地址
├─ userPhonestring非必须用户电话
├─ verifyCodestring非必须核销码
messagestring非必须

订单取消

基本信息

Path: /api/front/order/cancel

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

databoolean非必须
messagestring非必须

订单头部数量

基本信息

Path: /api/front/order/data

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

订单收货

基本信息

Path: /api/front/order/take

Method: POST

接口描述:

请求参数

Headers

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

Query

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

返回数据

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

format: int64

databoolean非必须
messagestring非必须

订单详情

基本信息

Path: /api/front/order/detail/{orderId}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
orderId orderId

返回数据

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

format: int64

dataobject非必须
messagestring非必须

订单退款理由

基本信息

Path: /api/front/order/refund/reason

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

订单退款申请

基本信息

Path: /api/front/order/refund

Method: POST

接口描述:

请求参数

Headers

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

Body

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

format: int32

refund_reason_wap_explainstring非必须备注说明
refund_reason_wap_imgstring非必须退款凭证(多个图片请用,(英文逗号)隔开)
textstring必须退款原因

返回数据

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

format: int64

databoolean非必须
messagestring非必须

评价订单

基本信息

Path: /api/front/order/comment

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
commentstring必须评论内容
oidinteger非必须订单ID, 移动端必须传递此参数

format: int32

picsstring必须评论图片
productIdinteger必须商品id

format: int32

productScoreinteger必须商品分数

format: int32

serviceScoreinteger必须服务分数

format: int32

uniquestring非必须商品 属性id
userIdinteger非必须用户id, 后端必须传递此参数

format: int32

返回数据

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

format: int64

databoolean非必须
messagestring非必须

退款订单验证

基本信息

Path: /api/front/order/refund/verify

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
refund_reason_wap_explainstring非必须退款备注说明
refund_reason_wap_imgstring非必须退款凭证图片
textstring非必须退款原因
unistring非必须待退款订单

返回数据

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

format: int64

dataobject非必须
messagestring非必须

首页

分享配置

基本信息

Path: /api/front/share

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须
messagestring非必须

热门搜索

基本信息

Path: /api/front/search/keyword

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject []非必须

item 类型: object

messagestring非必须

首页产品的轮播图和产品信息

基本信息

Path: /api/front/groom/list/{type}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 类型 【1 精品推荐 2 热门榜单 3首发新品 4促销单品】

Query

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

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ activityobject []非必须活动区域图片

item 类型: object

├─ bannerobject []非必须首页banner滚动图

item 类型: object

├─ benefitobject []非必须首页促销单品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ couponListobject []非必须优惠券

item 类型: object

├─ explosiveMoneyobject []非必须首页超值爆款

item 类型: object

├─ infoobject非必须用户登录返回数据
├─ bastBannerobject []非必须首页精品推荐图片

item 类型: object

├─ bastInfostring非必须精品推荐简介
├─ bastListobject []非必须精品推荐

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ bastNumberstring非必须精品推荐个数
├─ fastInfostring非必须快速选择简介
├─ fastListobject []非必须分类

item 类型: object

├─ extrastring非必须扩展字段
├─ idinteger非必须

format: int32

├─ namestring非必须分类名称
├─ pathstring非必须路径
├─ pidinteger非必须父级ID

format: int32

├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态, 0正常,1失效
├─ typeinteger非必须类型ID | 类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置

format: int32

├─ urlstring非必须地址
├─ fastNumberstring非必须快速选择分类个数
├─ firstInfostring非必须首发新品简介
├─ firstListobject []非必须首发新品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ firstNumberstring非必须首发新品个数
├─ promotionNumberstring非必须首页促销单品
├─ salesInfostring非必须促销单品简介
├─ likeInfoobject []非必须热门榜单

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ listobject []非必须商品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ logoUrlstring非必须企业logo
├─ lovelyobject非必须首发新品广告图
├─ menusobject []非必须导航模块

item 类型: object

├─ rollobject []非必须新闻简报消息滚动

item 类型: object

├─ subscribeboolean非必须是否关注
messagestring非必须

首页数据

基本信息

Path: /api/front/index

Method: GET

接口描述:

请求参数

返回数据

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

format: int64

dataobject非必须用户登录返回数据
├─ activityobject []非必须活动区域图片

item 类型: object

├─ bannerobject []非必须首页banner滚动图

item 类型: object

├─ benefitobject []非必须首页促销单品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ couponListobject []非必须优惠券

item 类型: object

├─ explosiveMoneyobject []非必须首页超值爆款

item 类型: object

├─ infoobject非必须用户登录返回数据
├─ bastBannerobject []非必须首页精品推荐图片

item 类型: object

├─ bastInfostring非必须精品推荐简介
├─ bastListobject []非必须精品推荐

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ bastNumberstring非必须精品推荐个数
├─ fastInfostring非必须快速选择简介
├─ fastListobject []非必须分类

item 类型: object

├─ extrastring非必须扩展字段
├─ idinteger非必须

format: int32

├─ namestring非必须分类名称
├─ pathstring非必须路径
├─ pidinteger非必须父级ID

format: int32

├─ sortinteger非必须排序

format: int32

├─ statusboolean非必须状态, 0正常,1失效
├─ typeinteger非必须类型ID | 类型,1 产品分类,2 附件分类,3 文章分类, 4 设置分类, 5 菜单分类, 6 配置分类, 7 秒杀配置

format: int32

├─ urlstring非必须地址
├─ fastNumberstring非必须快速选择分类个数
├─ firstInfostring非必须首发新品简介
├─ firstListobject []非必须首发新品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ firstNumberstring非必须首发新品个数
├─ promotionNumberstring非必须首页促销单品
├─ salesInfostring非必须促销单品简介
├─ likeInfoobject []非必须热门榜单

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ listobject []非必须商品

item 类型: object

├─ cateIdinteger []非必须分类id

item 类型: integer

├─ 非必须
├─ idinteger非必须商品id

format: int32

├─ imagestring非必须商品图片
├─ otPricenumber非必须市场价
├─ pricenumber非必须商品价格
├─ salesinteger非必须销量

format: int32

├─ sortinteger非必须排序

format: int32

├─ stockinteger非必须库存

format: int32

├─ storeNamestring非必须商品名称
├─ unitNamestring非必须单位名
├─ logoUrlstring非必须企业logo
├─ lovelyobject非必须首发新品广告图
├─ menusobject []非必须导航模块

item 类型: object

├─ rollobject []非必须新闻简报消息滚动

item 类型: object

├─ subscribeboolean非必须是否关注
messagestring非必须

隐私、权限声明

1. 本插件需要申请的系统权限列表:

1:用户位置 2:手机号

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问