公共分类
首页模块
搜索模块
- 搜索-商品搜索-带筛选条件
- 搜索-提示语
商品分类
商品详情
支付
购物车
评价模块
品牌模块
专题模块
会员中心-个人信息
会员中心-订单
会员中心-兴趣分类
- 兴趣分类-获取
- 兴趣分类-修改
会员中心-尺码
会员中心-地址管理
会员中心-足迹
- 获取我的足迹
- 删除我的足迹
会员中心-收藏（商品、专题、品牌）

小兔鲜儿-PC前台

公共分类

获取短信验证码-注册或登录-APP

基本信息

Path： /code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mobile	是	13211112222	手机号
type	是	register	发送短信类型，取值范围[register、login]

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 发送成功
result	object	必须

刷新token

基本信息

Path： /login/refresh

Method： PUT

接口描述：

在token过期后，再次刷新token,根据token和用户的信息，换取新的token值

Header必须携带过期token样例：
"Authorization":"Bearer ${token}"
例子：
"Authorization":"Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ7XCJuYW1lXCI6XCLotoXnuqfnrqHnkIblkZhcIixcImlkXCI6XCIxMjkzMTA4NTkwNTk2NDQ0MTYxXCIsXCJ1c2VybmFtZVwiOlwiYWRtaW5cIn0iLCJpYXQiOjE1OTc5NzMyNzcsImV4cCI6MTU5ODIzMjQ3N30.zjzRwT1wVpSMiugyKPwbIjF6iYuC6oTF5J5JgS6Zt1A"

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是	Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ7XCJuYW1lXCI6XCLkvaDnjJxcIixcImlkXCI6XCIxMzY5NTk0OTU0NzM5ODU5NDU4XCIsXCJ1c2VybmFtZVwiOlwiY2VzaGlcIn0iLCJpYXQiOjE2MjA2Mjg0OTYsImV4cCI6MTYyMDg4NzY5Nn0.xuNNA47A10GabH4YXgkQe5IedhFt7HHyY8lfRUP63RE	token

Body

名称	类型	是否必须	默认值	备注	其他信息
account	string	必须		用户名或手机号	undefined: ceshi
id	string	必须		用户id	undefined: 123456

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须	用户信息
├─ id	number	必须	用户ID	undefined: @natural
├─ mobile	string	必须	手机号	undefined: 13200000000
├─ token	string	必须		undefined: 03c891e1abda7801193a
├─ nickname	string	必须		undefined: @cname
├─ avatar	string	必须		undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ gender	string	必须	性别，男、女、未知
├─ birthday	string	必须	生日
├─ cityCode	string	必须	城市编码
├─ provinceCode	string	必须	省份编码
├─ profession	string	必须	职业

获取短信验证码-注册-PC

基本信息

Path： /register/code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mobile	是	13211112222	手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 发送成功
result	object	必须

注册-PC/app

基本信息

Path： /register

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
account	string	必须	abcdef		最大长度: 20 最小长度: 5
mobile	string	必须	18210090581		最大长度: 11 最小长度: 11 undefined: 13219165182
code	string	必须	123456		最大长度: 6 最小长度: 6
password	string	必须	abcdefg		最大长度: 20 最小长度: 6
type	string	必须		PC端默认不传此值，app必传且值为app	undefined: app

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 注册成功
result	object	必须

验证手机验证码-注册-APP

基本信息

Path： /register/code/check

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mobile	是	13211112222	手机号
code	是	123456	验证码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 发送成功
result	object	必须

注册-校验用户名唯一

基本信息

Path： /register/check

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
account	是		用户名或手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
result	boolean	必须		是否存在，true:已存在，false:不存在	undefined: @boolean

注册-手机号和密码注册-APP-未使用

基本信息

Path： /regiser/other

Method： POST

接口描述：

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 注册成功
result	object	必须

获取短信验证码-登录-PC

基本信息

Path： /login/code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mobile	是	13211112222	手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 发送成功
result	object	必须

登录-用户名和密码

基本信息

Path： /login

Method： POST

接口描述：

登录成功后，后台返回的token，请在本地保存，并在每次请求接口时在Header中携带
Header携带token样例：
"Authorization":"Bearer ${token}"
例子：
"Authorization":"Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ7XCJuYW1lXCI6XCLotoXnuqfnrqHnkIblkZhcIixcImlkXCI6XCIxMjkzMTA4NTkwNTk2NDQ0MTYxXCIsXCJ1c2VybmFtZVwiOlwiYWRtaW5cIn0iLCJpYXQiOjE1OTc5NzMyNzcsImV4cCI6MTU5ODIzMjQ3N30.zjzRwT1wVpSMiugyKPwbIjF6iYuC6oTF5J5JgS6Zt1A"

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
account	string	必须		用户名或手机号	undefined: ceshi
password	string	必须		密码	undefined: 123456

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须	用户信息
├─ id	number	必须	用户ID	undefined: @natural
├─ mobile	string	必须	手机号	undefined: 13200000000
├─ token	string	必须		undefined: 03c891e1abda7801193a
├─ nickname	string	必须		undefined: @cname
├─ avatar	string	必须		undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ gender	string	必须	性别，男、女、未知
├─ birthday	string	必须	生日
├─ cityCode	string	必须	城市编码
├─ provinceCode	string	必须	省份编码
├─ profession	string	必须	职业

手机验证码登录

基本信息

Path： /login/code

Method： POST

接口描述：

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须	用户信息
├─ id	number	必须	用户ID	undefined: @natural
├─ mobile	string	必须	手机号	undefined: 13200000000
├─ token	string	必须		undefined: 03c891e1abda7801193a
├─ nickname	string	必须		undefined: @cname
├─ avatar	string	必须		undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ gender	string	必须	性别，男、女、未知
├─ birthday	string	必须	生日
├─ cityCode	string	必须	城市编码
├─ provinceCode	string	必须	省份编码
├─ profession	integer	必须	职业

三方登录_发送已有账号短信

基本信息

Path： /login/social/code

Method： GET

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
mobile	否	13211112222	手机号

Body

名称	类型	是否必须	默认值	备注	其他信息
unionId	string	必须		三方标识
source	integer	必须		注册来源注册来源，1为pc，2为webapp，3为微信小程序，4为Android，5为ios,6为qq,7为微信

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语	undefined: 登录成功

三方登录

基本信息

Path： /login/social

Method： POST

接口描述：

当token与mobile不存在或均为null时，即需要完善资料

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
unionId	string	必须		三方标识
source	integer	必须		注册来源注册来源，1为pc，2为webapp，3为微信小程序，4为Android，5为ios,6为qq,7为微信	undefined: 6

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须	用户信息
├─ id	number	必须	用户ID	undefined: @natural
├─ mobile	string	必须	手机号	undefined: 13200000000
├─ token	string	必须		undefined: 03c891e1abda7801193a
├─ nickname	string	必须		undefined: @cname
├─ avatar	string	必须		undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ gender	string	必须	性别，男、女、未知
├─ birthday	string	必须	生日
├─ cityCode	string	必须	城市编码
├─ provinceCode	string	必须	省份编码
├─ profession	integer	必须	职业

三方登录_账号绑定

基本信息

Path： /login/social/bind

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
unionId	string	必须	三方标识
mobile	string	必须	手机号
code	string	必须	验证码

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须
├─ id	string	必须	id	undefined: @id
├─ mobile	string	必须	手机号	undefined: 13211112222
├─ token	string	必须	token	undefined: @id
├─ nickname	string	必须	昵称	undefined: @cname
├─ avatar	string	必须	头像	undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png

三方登录_账号解绑（解绑qq信息）

基本信息

Path： /login/social/unbind

Method： GET

接口描述：

请求参数

Headers

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

Query

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

Body

名称	类型	是否必须	默认值	备注	其他信息
mobile	string	必须		手机号

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 登录成功
result	object	必须
├─ id	string	必须	id	undefined: @id
├─ mobile	string	必须	手机号	undefined: 13211112222
├─ nickname	string	必须	昵称	undefined: @cname
├─ avatar	string	必须	头像	undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ account	string	必须

三方登录-完善信息

基本信息

Path： /login/social/:unionId/complement

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
unionId	sad123231dsada	unionId

Body

名称	类型	是否必须
account	string	必须
mobile	string	必须
code	string	必须
password	string	必须

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须		undefined: 注册成功
result	object	必须
├─ id	string	必须	用户ID	undefined: @id
├─ mobile	string	必须	手机号	undefined: 13211112222
├─ token	string	必须	token	undefined: @id
├─ nickname	string	必须		undefined: @cname
├─ avatar	string	必须		undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png

文件上传

基本信息

Path： /upload

Method： POST

接口描述：

请求参数

Headers

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

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		文件

返回数据

名称	类型	是否必须	备注
msg	string	必须	提示语
result	object	必须	返回信息
├─ url	string	必须	文件链接

忘记密码-获取短信验证码

基本信息

Path： /reset/mobile/code

Method： GET

接口描述：

验证票据有效时间5分钟

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
ticket	是		上一步中返回的ticket

Body

名称	类型	是否必须	备注
account	string	必须	账号
uuid	string	必须	获取验证码图片时使用的uuid
code	string	必须	验证码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语	undefined: 短信已发送

忘记密码-获取验证码图片-PC

基本信息

Path： /reset/verification

Method： GET

接口描述：

返回数据为验证码图片

请求参数

Query

参数名称	是否必须	示例	备注
uuid	是		览器生成随机id

返回数据

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

忘记密码-验证手机号-APP

基本信息

Path： /reset/mobile

Method： GET

接口描述：

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 验证通过
result	object	必须	返回信息
├─ mobile	string	必须	手机号	undefined: 13211111111
├─ ticket	string	必须	验证票据	undefined: 000000000

忘记密码-验证用户名-PC

基本信息

Path： /reset/account/check

Method： GET

接口描述：

验证码有效时间5分钟

请求参数

Headers

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

Query

参数名称	是否必须	备注
account	是	用户名
code	是	验证码
uuid	是	获取图片验证码所使用的uuid

Body

名称	类型	是否必须	备注
account	string	必须	账号
uuid	string	必须	获取验证码图片时使用的uuid
code	string	必须	验证码

返回数据

名称	类型	是否必须	备注
msg	string	必须	提示语
result	object	必须	返回信息
├─ mobile	string	必须	手机号
├─ ticket	string	必须	验证票据

忘记密码-验证手机验证码

基本信息

Path： /reset/mobile/check

Method： GET

接口描述：

验证票据有效时间5分钟

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
ticket	是		上一步中返回的ticket
code	是		手机验证码

Body

名称	类型	是否必须	备注
account	string	必须	账号
uuid	string	必须	获取验证码图片时使用的uuid
code	string	必须	验证码

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语	undefined: 校验成功
result	object	必须	返回信息
├─ ticket	string	必须	新的验证票据，有效期5分钟	undefined: 111111111

忘记密码-新密码

基本信息

Path： /reset/password

Method： PUT

接口描述：

验证票据有效时间5分钟

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
ticket	string	必须		上一步获取的验证票据
password	string	必须		新的密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语	undefined: 重置密码成功

首页模块

爆款推荐_小程序

基本信息

Path： /home/inVogue/mutli

Method： GET

接口描述：

目前爆款推荐分为了24小时热榜，热销总榜，人气周榜

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须
result	object	非必须
├─ title	string	非必须	活动标题：爆款推荐	undefined: 一站买全
├─ id	string	必须	id信息
├─ bannerPicture	string	必须	活动图片
├─ goodsItems	object []	非必须	活动对应的商品集合	item 类型: object
├─ goods	object []	必须		item 类型: object
├─ desc	string	必须
├─ id	string	必须
├─ name	string	必须
├─ picture	string	必须
├─ price	number	必须
├─ id	string	必须	子类活动项id
├─ name	string	必须	子类活动名称比如：24小时热榜
├─ picture	string	必须	子类活动图片
├─ summary	string	必须	副标题
├─ subTypes	object []	非必须	子类选项	item 类型: object
├─ id	string	必须	子类选项id
├─ name	string	必须	子类选项名称
├─ picture	string	必须	子类选项图片

新鲜好物_小程序

基本信息

Path： /home/new/mutli

Method： GET

接口描述：

目前新鲜好物分为了抢先尝鲜、新品预告

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须
result	object	非必须
├─ title	string	非必须	活动标题：新鲜好物	undefined: 一站买全
├─ id	string	必须	id信息
├─ bannerPicture	string	必须	活动图片
├─ goodsItems	object []	非必须	活动对应的商品集合	item 类型: object
├─ goods	object []	必须		item 类型: object
├─ desc	string	必须
├─ id	string	必须
├─ name	string	必须
├─ picture	string	必须
├─ price	number	必须
├─ id	string	必须	子类活动项id
├─ name	string	必须	子类活动名称比如：抢先尝鲜
├─ picture	string	必须	子类活动图片
├─ summary	string	必须	副标题
├─ subTypes	object []	非必须	子类选项	item 类型: object
├─ id	string	必须	子类选项id
├─ name	string	必须	子类选项名称
├─ picture	string	必须	子类选项图片

新鲜好物-APP

基本信息

Path： /home/new/simple

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	其他信息
msg	string	非必须
result	object	非必须
├─ newProduct	object []	非必须	item 类型: object
├─ id	string	必须
├─ picture	string	必须
├─ name	string	必须
├─ price	number	必须
├─ desc	string	必须
├─ orderNum	number	必须
├─ preSales	object []	非必须	item 类型: object
├─ id	string	必须
├─ picture	string	必须
├─ name	string	必须
├─ price	number	必须
├─ desc	string	必须
├─ orderNum	number	必须

特惠推荐_小程序

基本信息

Path： /home/preference/mutli

Method： GET

接口描述：

目前特惠推荐分为了抢先尝鲜、新品预告

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须
result	object	非必须
├─ title	string	非必须	活动标题：特惠推荐	undefined: 一站买全
├─ id	string	必须	id信息
├─ bannerPicture	string	必须	活动图片
├─ goodsItems	object []	非必须	活动对应的商品集合	item 类型: object
├─ goods	object []	必须		item 类型: object
├─ desc	string	必须
├─ id	string	必须
├─ name	string	必须
├─ picture	string	必须
├─ price	number	必须
├─ id	string	必须	子类活动项id
├─ name	string	必须	子类活动名称比如：
├─ picture	string	必须	子类活动图片
├─ summary	string	必须	副标题
├─ subTypes	object []	非必须	子类选项	item 类型: object
├─ id	string	必须	子类选项id
├─ name	string	必须	子类选项名称
├─ picture	string	必须	子类选项图片

一站买全_小程序

基本信息

Path： /home/oneStop/mutli

Method： GET

接口描述：

目前一站全买分为了搞定熊孩子，家里不凌乱，让音质更出众三个子项

请求参数

Query

参数名称	是否必须	备注
page	否	默认是1
pageSize	否	默认是10
subType	否	子类项活动的id,可以不传，不传，查询全部子类项的第一页数据

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须
result	object	非必须
├─ bannerPicture	string	非必须
├─ goodsItems	object	非必须	不传
├─ id1	object	非必须	是subTypes
├─ goods	object []	非必须		item 类型: object
├─ desc	string	必须
├─ id	string	必须
├─ name	string	必须
├─ picture	string	必须
├─ price	number	必须
├─ id	string	非必须
├─ name	string	非必须
├─ picture	string	非必须
├─ summary	string	非必须
├─ id	string	非必须
├─ subTypes	object []	非必须		item 类型: object
├─ id	string	必须
├─ name	string	必须
├─ picture	string	必须
├─ title	string	非必须

新鲜好物-PC

基本信息

Path： /home/new/multi

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回数据
├─ highlys	object []	必须	力荐新品	最大数量: 2 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static//uploads/img/index-new-pd01.png,http://zhoushugang.gitee.io/erabbit-client-pc-static//uploads/img/index-new-pd02.png
├─ name	string	必须	商品名称	undefined: @ctitle(10,16)
├─ price	number	必须	价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(4,8)
├─ newProduct	object []	必须	新品列表	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: https://yanxuan-item.nosdn.127.net/1d374eef36fb36f618cb0000b0c021eb.png
├─ name	string	必须	商品名称	undefined: @ctitle(10,16)
├─ price	number	必须	价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(4,8)
├─ preSales	object []	必须	预售列表	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/home_goods_5.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(10,16)
├─ price	number	必须	价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(4,8)

爆款推荐

基本信息

Path： /home/inVogue

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回数据
├─ byDay	object []	必须	24小时热销	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_6.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_7.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_8.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	价格	undefined: @float(20,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,20)
├─ orderNum	integer	必须	销量
├─ byWeek	object []	必须	人气周榜	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_6.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_7.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_8.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	价格	undefined: @float(20,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,20)
├─ orderNum	integer	必须	销量
├─ byTotal	object []	必须	热销总榜	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_6.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_7.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_8.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	价格	undefined: @float(20,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,20)
├─ orderNum	integer	必须	销量

一站买全

基本信息

Path： /home/oneStop

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	返回数据	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	名称	undefined: @ctitle(6,10)
├─ summary	string	必须	副标题	undefined: @ctitle(10,16)
├─ picture	string	必须	专场图片	undefined: @image('1240x180', '#ccc','#ccc','')
├─ goods	object []	必须	商品集合	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_6.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_7.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(10,16)
├─ price	number	必须	价格	undefined: @float(10,100,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,16)

首页-聚合-APP

基本信息

Path： /home/index

Method： GET

接口描述：

一次拉取首页所有数据

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须	请求结果描述	undefined: 操作成功
result	object	非必须
├─ imageBanners	object []	非必须	轮播图列表	item 类型: object
├─ id	string	必须	id
├─ imgUrl	string	必须	banner链接
├─ hrefUrl	string	必须	跳转链接
├─ type	string	必须	跳转类型1、页面2、H5 3、小程序（小程序使用）
├─ categoryGrids	object []	非必须	分类列表	item 类型: object
├─ id	string	必须	前台类目Id
├─ name	string	必须	前台类目名称
├─ picture	string	必须	前台类目图片
├─ children	null	必须	子类目集合-此处为null
├─ goods	null	必须	推荐商品集合-此处为null
├─ hotRecommends	object []	非必须	推荐列表	item 类型: object
├─ leftIcon	string	必须	左侧图片
├─ rightIcon	string	必须	右侧图片
├─ title	string	必须	标题
├─ caption	string	必须	简述
├─ freshGoods	object []	非必须	新鲜好物	item 类型: object
├─ id	string	必须	spuId,即商品Id
├─ name	string	必须	商品名称
├─ desc	string	必须	商品描述
├─ price	string	必须	商品价格
├─ picture	string	必须	商品图片
├─ discount	number	必须	折扣信息，如为null时，即无折扣
├─ orderNum	number	必须	销量
├─ hotBrands	object []	非必须	热门品牌	item 类型: object
├─ id	string	必须	品牌Id
├─ name	string	必须	品牌名称
├─ nameEn	string	必须	英文品牌名
├─ logo	string	必须	品牌logo
├─ picture	string	必须	图片
├─ type	null	必须	属性来源：1为本级，2为父级
├─ desc	string	必须	描述
├─ place	string	必须	地址信息
├─ projects	object []	非必须	专题推荐	item 类型: object
├─ creator	string	必须
├─ isDelete	number	必须
├─ createTime	string	必须
├─ updateTime	string	必须
├─ id	string	必须	专题id
├─ classificationId	string	必须	专题分类id
├─ title	string	必须	标题
├─ summary	string	必须	副标题
├─ lowestPrice	number	必须	最低价格
├─ cover	string	必须	专题封面
├─ detailsUrl	string	必须	详情链接
├─ collectNum	number	必须	收藏数
├─ viewNum	number	必须	浏览数
├─ replyNum	number	必须	回复数
├─ categoryBanners	object []	非必须	商品推荐分类列表	item 类型: object
├─ id	string	必须	前台类目Id
├─ name	string	必须	前台类目名称
├─ picture	string	必须	前台类目图片
├─ children	object []	必须	子类目集合	item 类型: object
├─ id	string	必须	前台类目Id-子类目
├─ name	string	必须	前台类目名称-子类目
├─ picture	string	必须	前台类目图片-子类目
├─ children	null	必须	子类目集合--此处为nll(前台类目一共两级)
├─ goods	null	必须	此处为null
├─ goods	object []	必须	推荐商品集合	item 类型: object
├─ id	string	必须	spuId,即商品Id
├─ name	string	必须	商品名称
├─ desc	string	必须	商品描述
├─ price	string	必须	商品价格
├─ picture	string	必须	商品图片
├─ discount	number	必须	折扣信息，如为null时，即无折扣
├─ orderNum	number	必须	销量

首页-广告区域(pc-小程序)

基本信息

Path： /home/banner

Method： GET

接口描述：

除了首页调用广告区域外，其他的页面也会调用广告接口

请求参数

Query

参数名称	是否必须	示例	备注
distributionSite	否		广告区域展示位置（投放位置投放位置，1为首页，2为分类商品页）默认是1

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ imgUrl	string	必须	banner链接	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/images/b1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/images/b2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/images/b3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/images/b4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/images/b5.jpg
├─ hrefUrl	string	必须	跳转链接	undefined: /
├─ type	integer	必须	跳转类型1、页面2、H5 3、小程序（小程序使用）

首页-全部分类（包含推荐商品）

基本信息

Path： /home/category/head

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最小数量: 9 最大数量: 9 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,2)
├─ children	object []	必须	子分类集合	最小数量: 5 最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	子分类名称	undefined: @ctitle(2,3)
├─ picture	string	必须	子分类图片	undefined: https://yanxuan.nosdn.127.net/b438fd2754a938ae071422aabf9f1b57.png?quality=95
├─ goods	object []	必须	推荐商品集合	item 类型: object
├─ id	string	必须	商品ID	undefined: @id
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ desc	string	必须	商品描述	undefined: @ctitle(10,20)
├─ price	string	必须	商品价格	undefined: @float(100,200,2,2)
├─ picture	string	必须	商品图片	undefined: @image

首页-获取推荐商品-APP

基本信息

Path： /home/index/userLike

Method： GET

接口描述：

首页底部推荐商品

请求参数

Query

参数名称	是否必须	示例	备注
categoryId	否	3213213213	分类Id
page	否	1	页码，未传或为0，则相当于刷新
pageSize	否	10	数量限制，默认为10
spuId	否	213231	商品id
brandId	否	231231	品牌id

返回数据

{"type":"object","title":"empty object","properties":{}}

首页-新鲜好物

基本信息

Path： /home/new

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
limit	否		默认值为 4，指定响应数据中商品的数量

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片链接
├─ name	string	必须	商品名称
├─ price	number	必须	价格
├─ desc	string	必须	备注

首页-人气推荐

基本信息

Path： /home/hot

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	图片
├─ title	string	必须	标题
├─ alt	string	必须	说明

首页-热门品牌

基本信息

Path： /home/brand

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
limit	否	4	数量限制

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示词
result	object []	必须	数据集合	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	图片	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/brand_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/brand_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/brand_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/brand_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/brand_goods_5.jpg
├─ name	string	必须	品牌名称	undefined: @ctitle(2,3)
├─ nameEn	string	必须	品牌英文名称	undefined: @title(2,3)

首页-最新专题

基本信息

Path： /home/special

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
limit	否		数量限制

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最大数量: 3 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ title	string	必须	标题	undefined: @ctitle(8,16)
├─ summary	string	必须	副标题	undefined: @ctitle(8,16)
├─ lowestPrice	number	必须	最低价格	undefined: @float(20,30,2,2)
├─ cover	string	必须	专题封面	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/topic_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/topic_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/topic_goods_3.jpg
├─ detailsUrl	string	必须	详情链接	undefined: @url
├─ collectNum	integer	必须	收藏数	undefined: @integer(100,200)
├─ viewNum	integer	必须	浏览数	undefined: @integer(400,600)
├─ replyNum	integer	必须		undefined: @integer(100,300)

首页-产品区块

基本信息

Path： /home/goods

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	返回数据	最大数量: 4 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,2)
├─ picture	string	必须	图片	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/fresh_goods_cover.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_cover.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/kitchen_goods_cover.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/home_goods_cover.jpg
├─ saleInfo	string	必须	售卖标语	undefined: @ctitle(4,4)
├─ children	object []	必须	子类集合	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	名称	undefined: @ctitle(2,3)
├─ goods	object []	必须	商品集合	最大数量: 8 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	价格	undefined: @float(100,1000,2,2)
├─ picture	string	必须	商品图片	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_6.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_7.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_8.jpg

首页-人气推荐-小程序和app

基本信息

Path： /home/hot/mutli

Method： GET

接口描述：

"leftIcon": "https://yanxuan-item.nosdn.127.net/1d422d423100c7efbd143c7adfe93e0e.png?type=webp&quality=95&thumbnail=245x245&imageView",
        "rightIcon": "https://yanxuan-item.nosdn.127.net/7f6470607bc86b134862458b2f086886.jpg?type=webp&quality=95&thumbnail=245x245&imageView",
        "title": "特惠推荐",
        "caption": "精选全攻略"
target---目标

返回type

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
source-client	miniapp	是		minapp 代表小程序端，app 代表 App端

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	id
├─ picture	string []	必须	图片	item 类型: string
├─		非必须	移动端支持多个图片
├─ title	string	必须	标题
├─ alt	string	必须	说明
├─ target	string	必须	跳转地址

首页-前台类目-小程序

基本信息

Path： /home/category/head/mutli

Method： GET

接口描述：

小程序查询前台分类，只查询一级类目信息（此处pc和app、mini共用了一套前台类目信息）

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最小数量: 9 最大数量: 9 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,2)
├─ icon	string	必须	展示图标	undefined: @image

首页-猜你喜欢-小程序和app

基本信息

Path： /home/goods/guessLike

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	页码默认值1
pageSize	否	10	页大小默认是10

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	非必须	提示语	undefined: 操作成功
result	object	非必须	返回数据
├─ counts	number	非必须	总条数
├─ pageSize	number	非必须	每页条数
├─ pages	number	非必须	总页数
├─ page	number	非必须	当前页数
├─ items	object []	非必须	当前页数据	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ desc	string	必须	商品描述
├─ price	number	必须	商品价格
├─ picture	string	必须	商品图片
├─ discount	number	必须	商品折扣
├─ orderNum	number	必须	商品已下单数量

搜索模块

搜索-商品搜索-带筛选条件

基本信息

Path： /search/all

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
page	integer	非必须	页码
pageSize	integer	非必须	页尺寸
keyword	string	非必须	所输入的关键词
associatedIds	string []	非必须	联想词Id集合	item 类型: string
├─		非必须	联想词Id
categoryId	string	非必须	分类id
brandId	string	非必须	品牌id
onlyDiscount	boolean	非必须	只显示特惠
sortField	string	非必须	排序字段，取值范围：[publishTime,orderNum,price,evaluateNum]
sortMethod	string	非必须	排序规则，asc为正序，desc为倒序，默认为desc

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据信息
├─ conditions	object	必须	条件信息
├─ categories	object []	必须	分类集合	最大数量: 8 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,3)
├─ brands	object []	必须	品牌集合	最大数量: 10 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	品牌名称	undefined: @ctitle(2,4)
├─ nameEn	string	必须	品牌英文名称
├─ logo	string	必须	品牌logo
├─ pageData	object	必须	分页信息
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	商品集合	最大数量: 16 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片	枚举: https://yanxuan-item.nosdn.127.net/65be335760e2375432b4410adbd32b2f.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/34aa50a8aabd592681733f615fc862c4.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/ad15ea988d0591e5d0a9e47c938a69d9.jpg?type=webp&quality=95&thumbnail=245x245&imageView,https://yanxuan-item.nosdn.127.net/7f84dd79d8d8620fe1ed38a709fabef3.jpg?type=webp&quality=95&thumbnail=245x245&imageView
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	商品价格	undefined: @float(10,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(4,8)
├─ discount	number	必须	折扣信息

搜索-提示语

基本信息

Path： /search/tips

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
keyword	是	橘子	所输入的关键词

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ ids	string []	必须	关键字id集合	item 类型: string
├─		非必须	关键字Id
├─ associatedWord	string	必须	联想词

商品分类

二级类目-子类列表-APP-弃用

基本信息

Path： /category/sub

Method： GET

接口描述：

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	分类Id
├─ name	string	必须	分类名称
├─ imageBanners	object []	必须	轮播图集合	item 类型: object
├─ title	string	必须	标题
├─ imgUrl	string	必须	图片链接
├─ hrefUrl	string	必须	跳转链接
├─ children	object []	必须	子类集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	名称
├─ picture	string	必须	图片
├─ children	object []	必须	子类集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	名称
├─ picture	string	必须	图片

商品列表-APP

基本信息

Path： /category/goods/mutli

Method： POST

接口描述：

未提交排序字段（sortField）则视为综合排序

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
categoryId	integer	必须	分类ID
inventory	boolean	非必须	是否有库存
onlyDiscount	boolean	非必须	只显示特惠
brandId	integer	非必须	品牌ID
arttrs	object []	非必须	属性条件数组	item 类型: object
├─ groupName	string	非必须	属性组名称
├─ propertyName	string	非必须	属性名称
sortField	string	非必须	排序字段，取值范围：[publishTime,orderNum,price,evaluateNum]
sortMethod	string	非必须	排序规则，asc为正序，desc为倒序，默认为desc
page	integer	非必须	当前页
pageSize	integer	非必须	页条数
lowPrice	number	非必须	最低价
highPrice	number	非必须	最高价

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据集合
├─ brands	object []	必须	品牌集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	品牌名称
├─ nameEn	string	必须	品牌英文名称
├─ logo	string	必须	品牌logo
├─ pageData	object	必须	分页信息
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片
├─ name	string	必须	商品名称
├─ price	number	必须	商品价格
├─ desc	string	必须	备注
├─ discount	number	必须	折扣信息
├─ joinCount	integer	必须	已拼团数量
├─ oldPrice	number	必须	原价

一级分类列表-APP

基本信息

Path： /category/top

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	其他信息
msg	string	非必须
result	object []	非必须	item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ imageBanners	object []	必须	item 类型: object
├─ title	string	必须
├─ imgUrl	string	必须
├─ hrefUrl	string	必须
├─ subcats	object []	必须	item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ imgUrl	string	必须
├─ goods	object []	必须	item 类型: object
├─ name	string	必须
├─ price	string	必须
├─ imgUrl	string	必须

一级类目-PC

基本信息

Path： /category

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		一级类目ID

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据信息
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,2)
├─ children	object []	必须	子分类集合	最大数量: 8 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(2,3)
├─ picture	string	必须	图片	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/img/cate-01.png,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/img/cate-02.png,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/img/cate-03.png,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/img/cate-04.png,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/img/cate-05.png
├─ goods	object []	必须	商品集合	最大数量: 5 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_1.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_2.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_3.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_4.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_5.jpg,http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/clothes_goods_6.jpg
├─ name	string	必须	商品名称	undefined: @ctitle(12,20)
├─ price	number	必须	商品价格	undefined: @float(10,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(6,12)
├─ discount	number	必须	折扣信息

二级类目-筛选条件-PC

基本信息

Path： /category/sub/filter

Method： GET

接口描述：

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ categories	object []	必须	分类集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	分类名称
├─ brands	object []	必须	品牌集合	最大数量: 6 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	品牌名称	undefined: @ctitle(2,4)
├─ nameEn	string	必须	品牌英文名称	undefined: @title(2,4)
├─ logo	string	必须	品牌Logo
├─ saleProperties	object []	必须	销售属性集合	最大数量: 4 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	属性组名称	undefined: @ctitle(2,4)
├─ properties	object []	必须	属性集合	最大数量: 8 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	属性名称	undefined: @ctitle(2,4)
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	二级分类ID	undefined: @ctitle(2,2)
├─ parentId	string	必须	顶级分类ID	undefined: @id
├─ parentName	string	必须	顶级分类名称	undefined: @ctitle(2,4)

商品列表--分页查询

基本信息

Path： /category/goods

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
categoryId	integer	必须		分类ID
inventory	boolean	非必须		是否有库存
onlyDiscount	boolean	非必须		只显示特惠
brandId	integer	非必须		品牌ID
attrs	object []	非必须		属性条件数组	item 类型: object
├─ groupName	string	非必须		属性组名称
├─ propertyName	string	非必须		属性名称
sortField	string	非必须		排序字段，取值范围：[publishTime,orderNum,price,evaluateNum]
sortMethod	string	非必须		排序规则，asc为正序，desc为倒序，默认为desc
page	integer	非必须	1	当前页	最大值: 100 最小值: 1
pageSize	integer	非必须		页条数
lowPrice	number	非必须		最低价
highPrice	number	非必须		最高价

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据集合
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片
├─ name	string	必须	商品名称
├─ price	number	必须	商品价格
├─ desc	string	必须	备注
├─ discount	number	必须	折扣信息
├─ joinCount	integer	必须	已拼团数量
├─ oldPrice	number	必须	原价

二级类目商品列表--分页查询-小程序-未做

基本信息

Path： /category/goods/mini

Method： POST

接口描述：

请求参数

Headers

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

Body

名称

类型

是否必须

默认值

备注

其他信息

categoryId

integer

必须

分类ID

page

integer

非必须

当前页

最大值: 100

最小值: 1

pageSize

integer

非必须

页条数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据集合
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片
├─ name	string	必须	商品名称
├─ price	number	必须	商品价格
├─ desc	string	必须	备注
├─ discount	number	必须	折扣信息
├─ joinCount	integer	必须	已拼团数量
├─ oldPrice	number	必须	原价

商品列表_临时

基本信息

Path： /category/goods/temporary

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
categoryId	integer	非必须		分类ID
inventory	boolean	非必须		是否有库存
onlyDiscount	boolean	非必须		只显示特惠
brandId	integer	非必须		品牌ID
attrs	object []	非必须		属性条件数组	item 类型: object
├─ groupName	string	非必须		属性组名称
├─ propertyName	string	非必须		属性名称
sortField	string	非必须		排序字段，取值范围：[publishTime,orderNum,price,evaluateNum]
sortMethod	string	非必须		排序规则，asc为正序，desc为倒序，默认为desc
page	integer	非必须	1	当前页	最大值: 100 最小值: 1
pageSize	integer	非必须		页条数
lowPrice	number	非必须		最低价
highPrice	number	非必须		最高价

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据集合
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片
├─ name	string	必须	商品名称
├─ price	number	必须	商品价格
├─ desc	string	必须	备注
├─ discount	number	必须	折扣信息
├─ joinCount	integer	必须	已拼团数量
├─ oldPrice	number	必须	原价

商品详情

基本信息

Path： /goods

Method： GET

接口描述：

规格集合一定要和skus集合下的specs 顺序保持一致

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	商品信息
├─ id	string	必须	id	undefined: 1608018
├─ name	string	必须	商品名称
├─ spuCode	string	必须	spu编码
├─ desc	string	必须	备注
├─ price	number	必须	当前价格
├─ oldPrice	number	必须	原价
├─ discount	number	必须	折扣信息，当折扣信息大于0时有效
├─ inventory	integer	必须	库存
├─ brand	object	必须	品牌信息
├─ id	string	必须	品牌id
├─ name	string	必须	品牌名称
├─ nameEn	string	必须	品牌英文名称
├─ picture	string	必须	图片
├─ salesCount	integer	必须	销量
├─ commentCount	integer	必须	评价数量
├─ collectCount	integer	必须	收藏数量
├─ mainVideos	string []	必须	主图视频集合	item 类型: string
├─		非必须	主图视频链接
├─ videoScale	integer	必须	主图视频比例,1为1:1/16:9，2为3:4
├─ mainPictures	string []	必须	主图图片集合	item 类型: string
├─		非必须	主图图片链接
├─ specs	object []	必须	可选规格集合备注：规格集合一定要和skus集合下的specs 顺序保持一致	item 类型: object
├─ name	string	必须	规格名称
├─ values	object []	必须	可选值集合	item 类型: object
├─ name	string	必须	可选值名称
├─ picture	string	必须	可选值图片链接
├─ available	boolean	必须	是否可售
├─ desc	string	必须	可选值备注
├─ skus	object []	必须	sku集合	item 类型: object
├─ id	string	必须	id
├─ skuCode	string	必须	sku编码
├─ price	number	必须	当前价格
├─ oldPrice	number	必须	原价
├─ inventory	integer	必须	库存
├─ picture	string	必须	sku图片
├─ specs	object []	必须	规格集合(和详情中specs的顺序一定要保持一致)	item 类型: object
├─ name	string	必须	规格名称
├─ valueName	string	必须	可选值名称
├─ categories	object []	必须	所属分类，多级以数组形式体现，如[一级分类，二级分类，三级分类]	item 类型: object
├─ id	string	必须	分类id
├─ name	string	必须	分类名称
├─ details	object	必须	商品详情
├─ properties	object []	必须	商品属性集合	item 类型: object
├─ name	string	必须	属性名称
├─ value	string	必须	属性值
├─ pictures	string []	必须	商品详情图片集合	item 类型: string
├─		非必须	图片链接
├─ isPreSale	boolean	必须	是否为预售商品
├─ isCollect	boolean	必须	是否已收藏
├─ recommends	object []	必须	推荐商品集合，仅APP有此数据	item 类型: object
├─ id	string	必须	商品id	undefined: @id
├─ picture	string	必须	商品图片	枚举: https://yanxuan-item.nosdn.127.net/65be335760e2375432b4410adbd32b2f.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/34aa50a8aabd592681733f615fc862c4.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/ad15ea988d0591e5d0a9e47c938a69d9.jpg?type=webp&quality=95&thumbnail=245x245&imageView,https://yanxuan-item.nosdn.127.net/7f84dd79d8d8620fe1ed38a709fabef3.jpg?type=webp&quality=95&thumbnail=245x245&imageView
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	商品价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,20)
├─ discount	number	必须	折扣信息
├─ userAddresses	object []	必须	用户地址列表	item 类型: object
├─ id	string	必须	地址id
├─ provinceCode	string	必须	省份编码
├─ cityCode	string	必须	城市编码
├─ countyCode	string	必须	所在区/县编码
├─ address	string	必须	详细地址
├─ isDefault	integer	必须	是否为默认，0为是，1为否
├─ fullLocation	string	必须		undefined: @county(true)
├─ evaluationInfo	object	必须	评价信息
├─ orderInfo	object	必须	订单信息
├─ specs	object []	必须	规格信息集合	item 类型: object
├─ name	string	必须	规格名称
├─ valueName	string	必须	值
├─ quantity	string	必须	购买数量
├─ createTime	string	必须	下单时间
├─ member	object	必须	评价用户信息
├─ id	string	必须	用户id
├─ nickname	string	必须	用户昵称
├─ avatar	string	必须	用户头像
├─ score	number	必须	评分，取值范围0-5
├─ content	string	必须	评论正文
├─ pictures	string	必须	评论晒图集合
├─ createTime	string	必须	评论时间
├─ praisePercent	number	必须	好评率
├─ similarProducts	object []	必须	同类商品	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片链接
├─ name	string	必须	商品名称
├─ price	number	必须	价格
├─ desc	string	必须	备注
├─ orderNum	integer	必须	销量
├─ hotByDay	object []	必须	24小时热销	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片链接
├─ name	string	必须	商品名称
├─ price	number	必须	价格
├─ desc	string	必须	备注
├─ orderNum	integer	必须	销量

商品详情-APP

基本信息

Path： /goods/app

Method： GET

接口描述：

规格集合和skus集合下的specs的顺序一定要保持一致~~~~

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	商品信息
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ spuCode	string	必须	spu编码
├─ desc	string	必须	备注
├─ price	number	必须	当前价格
├─ oldPrice	number	必须	原价
├─ discount	number	必须	折扣信息，当折扣信息大于0时有效
├─ inventory	integer	必须	库存
├─ brand	object	必须	品牌信息
├─ id	string	必须	品牌id
├─ name	string	必须	品牌名称
├─ nameEn	string	必须	品牌英文名称
├─ picture	string	必须	图片
├─ mainVideos	string []	必须	主图视频集合	item 类型: string
├─		非必须	主图视频链接
├─ videoScale	integer	必须	主图视频比例,1为1:1/16:9，2为3:4
├─ mainPictures	string []	必须	主图图片集合	item 类型: string
├─		非必须	主图图片链接
├─ specs	object []	必须	可选规格集合备注：规格集合一定要和skus集合下的specs 顺序保持一致	item 类型: object
├─ name	string	必须	规格名称
├─ values	object []	必须	可选值集合	item 类型: object
├─ name	string	必须	可选值名称
├─ picture	string	必须	可选值图片链接
├─ available	boolean	必须	是否可售
├─ desc	string	必须	可选值备注
├─ skus	object []	必须	sku集合	item 类型: object
├─ id	string	必须	id
├─ skuCode	string	必须	sku编码
├─ price	number	必须	当前价格
├─ oldPrice	number	必须	原价
├─ inventory	integer	必须	库存
├─ picture	string	必须	sku图片
├─ specs	object []	必须	规格集合	item 类型: object
├─ name	string	必须	规格名称
├─ valueName	string	必须	可选值名称
├─ details	object	必须	商品详情
├─ properties	object []	必须	商品属性集合	item 类型: object
├─ name	string	必须	属性名称
├─ value	string	必须	属性值
├─ pictures	object []	必须	商品详情图片集合	item 类型: object
├─ url	string	必须	图片链接
├─ height	integer	必须	图片高度
├─ width	integer	必须	图片宽度
├─ isPreSale	boolean	必须	是否为预售商品
├─ isCollect	boolean	必须	是否已收藏
├─ recommends	object []	必须	推荐商品集合，仅APP有此数据	item 类型: object
├─ id	string	必须	商品id	undefined: @id
├─ picture	string	必须	商品图片	枚举: https://yanxuan-item.nosdn.127.net/65be335760e2375432b4410adbd32b2f.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/34aa50a8aabd592681733f615fc862c4.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/ad15ea988d0591e5d0a9e47c938a69d9.jpg?type=webp&quality=95&thumbnail=245x245&imageView,https://yanxuan-item.nosdn.127.net/7f84dd79d8d8620fe1ed38a709fabef3.jpg?type=webp&quality=95&thumbnail=245x245&imageView
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	商品价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(10,20)
├─ discount	number	必须	折扣信息
├─ userAddresses	object []	必须	用户地址列表，用户未登录时该字段为空	item 类型: object
├─ id	string	必须	地址id
├─ provinceCode	string	必须	省份编码
├─ cityCode	string	必须	城市编码
├─ countyCode	string	必须	所在区/县编码
├─ address	string	必须	详细地址
├─ isDefault	integer	必须	是否为默认，0为是，1为否
├─ evaluationInfo	object	必须	评价信息
├─ orderInfo	object	必须	订单信息
├─ quantity	string	必须	购买数量
├─ createTime	string	必须	下单时间
├─ specs	object	必须	评价中商品的规格
├─ name	string	必须
├─ value	string	必须
├─ member	object	必须	评价用户信息
├─ id	string	必须	用户id
├─ account	string	必须	用户昵称：需要后台脱敏
├─ avatar	string	必须	用户头像
├─ score	number	必须	评分，取值范围0-5
├─ content	string	必须	评论正文
├─ pictures	string	必须	评论晒图集合
├─ createTime	string	必须	评论时间
├─ praisePercent	number	必须	好评率
├─ officialReply	string	必须	客服回复
├─ similarProducts	object []	必须	同类商品	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片链接
├─ name	string	必须	商品名称
├─ price	number	必须	价格
├─ desc	string	必须	备注
├─ orderNum	integer	必须	销量
├─ hotByDay	object []	必须	24小时热销	item 类型: object
├─ id	string	必须	id
├─ picture	string	必须	商品图片链接
├─ name	string	必须	商品名称
├─ price	number	必须	价格
├─ desc	string	必须	备注
├─ orderNum	integer	必须	销量

同类推荐(也支持猜你喜欢)

基本信息

Path： /goods/relevant

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	否		商品ID（传入代表查询相关商品，不传代表查询猜你喜欢）
limit	否	4	数量限制

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最大数量: 16 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片	枚举: https://yanxuan-item.nosdn.127.net/65be335760e2375432b4410adbd32b2f.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/34aa50a8aabd592681733f615fc862c4.png?type=webp&imageView&quality=95&thumbnail=210x210,https://yanxuan-item.nosdn.127.net/ad15ea988d0591e5d0a9e47c938a69d9.jpg?type=webp&quality=95&thumbnail=245x245&imageView,https://yanxuan-item.nosdn.127.net/7f84dd79d8d8620fe1ed38a709fabef3.jpg?type=webp&quality=95&thumbnail=245x245&imageView
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	商品价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: @ctitle(5,10)
├─ discount	number	必须	折扣信息	undefined: @float(0,0.99,2,2)

热销推荐

基本信息

Path： /goods/hot

Method： GET

接口描述：

在商品详情页面，同类推荐也使用了此接口

请求参数

Query

参数名称	是否必须	示例	备注
id	否		商品ID
limit	否	4	数量限制
type	否		热销类型，1为24小时，2为周榜，3为总榜，默认为1

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最大数量: 3 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ picture	string	必须	商品图片	undefined: https://yanxuan-item.nosdn.127.net/0803ed26ba11271ee3cfab308f9a926a.jpg?type=webp&quality=95&thumbnail=245x245&imageView
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ price	number	必须	商品价格	undefined: @float(100,200,2,2)
├─ desc	string	必须	备注	undefined: 香氛维C滤芯，洁肤美肌
├─ discount	number	必须	折扣信息

商品的评价信息

基本信息

Path： /goods/:id/evaluate

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	312321312312	商品id，即spu id

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	评价信息
├─ salesCount	integer	必须	销量
├─ praisePercent	number	必须	好评率
├─ evaluateCount	integer	必须	评价数
├─ hasPictureCount	integer	必须	评价有图数
├─ tags	object []	必须	标签统计信息集合	item 类型: object
├─ title	string	必须	标签
├─ tagCount	integer	必须	数量

评价分页数据

基本信息

Path： /goods/:id/evaluate/page

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	312321312312	商品信息

Query

参数名称	是否必须	示例	备注
page	是	1	页码
pageSize	是	10	页尺寸
hasPicture	否	true	是否有图
tag	否	质量好	标签
sortField	否	praiseCount	排序字段，可选值范围[praiseCount,createTime]
sortMethod	否	desc	排序方法，可选值范围[asc,desc],默认为desc

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	评价信息
├─ counts	integer	必须	总数量
├─ pageSize	integer	必须	每页条数
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页数
├─ items	object []	必须	评价集合	item 类型: object
├─ id	string	必须	评价id
├─ orderInfo	object	必须	订单信息
├─ specs	object []	必须	规格信息集合	item 类型: object
├─ name	string	必须	规格名称
├─ valueName	string	必须	值
├─ quantity	integer	必须	购买数量
├─ createTime	string	必须	下单时间
├─ member	object	必须	评价用户信息
├─ id	string	必须	用户id
├─ nickname	string	必须	用户昵称
├─ avatar	string	必须	用户头像
├─ score	number	必须	评分，取值范围0-5
├─ tags	string []	必须	印象标签集合	item 类型: string
├─		非必须	印象标签
├─ content	string	必须	评论正文
├─ pictures	string []	必须	评论晒图集合	item 类型: string
├─		非必须	图片链接
├─ officialReply	string	必须	客服回复
├─ praiseCount	integer	必须	点赞数
├─ createTime	string	必须	评论时间

商品信息-库存价格是否有效（支持本地购物车）

基本信息

Path： /goods/stock/:id

Method： GET

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	1352956998412406785	SKU_ID

Body

名称	类型	是否必须	备注	其他信息
id	integer	必须	商品ID
attrs	object []	非必须		item 类型: object
├─ id	integer	非必须	属性ID
├─ groupId	integer	非必须	属性值ID

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示	undefined: 获取现价和库存成功
result	object	必须
├─ nowPrice	number	必须	现价	undefined: @float(180,200,2,2)
├─ stock	integer	必须	库存	undefined: @natural(99,199)
├─ isEffective	boolean	必须	是否有效商品	undefined: @boolean

商品信息-sku

基本信息

Path： /goods/sku/:id

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id		SKUID

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须
├─ specs	object []	必须	可选规格集合	item 类型: object
├─ name	string	必须	规格名称
├─ values	object []	必须	可选值集合	item 类型: object
├─ name	string	必须	可选值名称
├─ picture	string	必须	可选值图片链接
├─ available	boolean	必须	是否可售
├─ desc	string	必须	可选值备注
├─ skus	object []	必须	sku集合	item 类型: object
├─ id	string	必须	id
├─ skuCode	string	必须	sku编码
├─ price	number	必须	当前价格
├─ oldPrice	number	必须	原价
├─ inventory	integer	必须	库存
├─ specs	object []	必须	规格集合	item 类型: object
├─ name	string	必须	规格名称
├─ valueName	string	必须	可选值名称

支付

支付-支付宝-APP

基本信息

Path： /pay/aliPay/app

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
orderId	是	231312	订单Id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语
result	string	必须		发起app支付返回的body信息

支付-支付宝-PC

基本信息

Path： /pay/aliPay

Method： GET

接口描述：

直接跳转到页面(支付宝的页面，立即支付的页面)

请求参数

Query

参数名称	是否必须	示例	备注
orderId	是	231312	订单Id
redirect	是	http://localhost:8080/#/pay/callback	回跳地址,URI编码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语

支付-支付宝-交易查询-APP

基本信息

Path： /pay/aliPay/transferQuery

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
orderId	是	231312	订单Id
outBizNo	是	wf32e2	交易流水号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语
result	string	必须		查询交易返回的body信息

模拟支付

基本信息

Path： /pay/mock

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
orderId	是	231312	订单Id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语

购物车

获取购物车数量

基本信息

Path： /member/cart/count

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注
msg	string	必须	提示语
result	object	必须	数据信息
├─ count	number	必须	数量

购物车列表

基本信息

Path： /member/cart

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	SPUID	undefined: @id
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ picture	string	必须	图片	undefined: https://yanxuan-item.nosdn.127.net/85ba9eb0817c0e5a184147ae470a52e2.jpg
├─ price	number	必须	加入时价格	undefined: 299
├─ count	integer	必须	数量	undefined: @integer(1,5)
├─ skuId	string	必须	SKUID	undefined: @id
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”	undefined: 颜色:瓷白色尺寸：8寸
├─ selected	boolean	必须	是否选中	undefined: @boolean
├─ nowPrice	number	必须	当前的价格	undefined: @float(200,299,2,2)
├─ stock	integer	必须	库存	undefined: 100
├─ isCollect	boolean	必须	是否收藏	undefined: @boolean
├─ discount	number	必须	折扣信息
├─ isEffective	boolean	必须	是否为有效商品

购物车列表-APP

基本信息

Path： /member/cart/mutli

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据信息
├─ valids	object []	必须	有效商品	item 类型: object
├─ id	string	必须	SPUID
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ price	number	必须	加入时价格
├─ count	integer	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”
├─ specs	object []	必须	规格列表	item 类型: object
├─ name	string	必须	规格键
├─ valueName	string	必须	规格值
├─ selected	boolean	必须	是否选中
├─ nowPrice	number	必须	当前的价格
├─ stock	integer	必须	库存
├─ isCollect	boolean	必须	是否收藏
├─ discount	number	必须	折扣信息
├─ invalids	object []	必须	无效商品	item 类型: object
├─ id	string	必须	SPUID
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ price	number	必须	加入时价格
├─ count	integer	必须	数量
├─ skuId	string	必须	skuId
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”
├─ selected	boolean	必须	是否选中
├─ nowPrice	number	必须	当前的价格
├─ stock	integer	必须	库存
├─ isCollect	boolean	必须	是否收藏
├─ discount	number	必须	折扣信息

合并购物车

基本信息

Path： /member/cart/merge

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须	购物车sku集合	item 类型: object
├─ skuId	string	必须	skuId
├─ selected	boolean	必须	是否选中
├─ count	integer	必须	数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 添加成功
result	object	必须

购物车全选/取消全选

基本信息

Path： /member/cart/selected

Method： PUT

接口描述：

ids参数如果不传，表示用户访问的是全选和取消全选操作，后端根据selected确定用户是全选和取消全选

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
selected	boolean	必须	是否选中
ids	string []	必须	skuId集合	item 类型: string
├─		非必须	skuId

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须			undefined: 添加成功
result	object	必须

加入购物车

基本信息

Path： /member/cart

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
skuId	string	必须		SKUID
count	integer	必须		数量

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须		undefined: 添加成功
result	object	必须
├─ skuId	string	必须	SKUID	undefined: @id
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”	undefined: @ctitle(10,20)
├─ picture	string	必须	商品图片	undefined: https://yanxuan-item.nosdn.127.net/f7a4f643e245d03771d6f12c94e71214.png
├─ price	string	必须	加入时价格	undefined: @float(150,200,2,2)
├─ nowPrice	string	必须	当前的价格	undefined: @float(100,150,2,2)
├─ selected	boolean	必须	是否选中	undefined: @boolean
├─ stock	integer	必须	库存	undefined: @natural(99,999)
├─ count	integer	必须	数量	undefined: @natural(1,5)
├─ discount	number	必须	折扣信息
├─ isCollect	boolean	必须	是否收藏
├─ isEffective	boolean	必须	是否为有效商品
├─ id	string	必须	SPUID	undefined: @id

删除/清空购物车商品

基本信息

Path： /member/cart

Method： DELETE

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
ids	string []	必须	SKUID集合	item 类型: string
├─		非必须	SKUID
clearAll	boolean	必须	是否清空，默认否
clearInvalid	boolean	必须	是否清空无效商品，默认否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语句	undefined: 删除成功

修改购物车商品

基本信息

Path： /member/cart/:id

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id		SKUID

Body

名称	类型	是否必须	默认值	备注	其他信息
selected	boolean	非必须		是否选中
count	integer	必须		数量

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须		undefined: 添加成功
result	object	必须
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ price	number	必须	加入时价格
├─ count	integer	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”
├─ selected	boolean	必须	是否选中
├─ nowPrice	number	必须	当前的价格
├─ stock	integer	必须	库存
├─ isCollect	boolean	必须	是否收藏
├─ discount	number	必须	折扣信息
├─ isEffective	boolean	必须	是否为有效商品

评价模块

发布评价

基本信息

Path： /evaluate/:id

Method： POST

接口描述：

请求参数

Headers

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

路径参数

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

Body

名称	类型	是否必须	备注	其他信息
anonymous	boolean	必须	是否匿名
evaluates	object []	必须	评价信息集合	item 类型: object
├─ id	string	必须	商品Id
├─ skuId	string	必须	skuId
├─ score	number	必须	评分，取值范围0-5
├─ content	string	必须	评价正文
├─ tags	string []	必须	印象标签集合	item 类型: string
├─		非必须	印象标签
├─ pictures	string []	必须	图片或视频链接集合	item 类型: string
├─		非必须	图片或视频链接

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语
result	object	必须		返回信息

获取待评价订单信息

基本信息

Path： /evaluate/order

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	23213213	订单Id

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	返回信息集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ count	string	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“瓷白色 8寸”
├─ price	number	必须	原单价
├─ payPrice	number	必须	实付单价
├─ totalPrice	number	必须	小计总价
├─ totalPayPrice	number	必须	实付价格小计
├─ tags	string []	必须	印象标签集合	item 类型: string
├─		非必须	印象标签

获取评价信息

基本信息

Path： /evaluate

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	23213213	订单Id

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	返回信息集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ count	string	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“瓷白色 8寸”
├─ price	number	必须	原单价
├─ payPrice	number	必须	实付单价
├─ totalPrice	number	必须	小计总价
├─ totalPayPrice	number	必须	实付价格小计
├─ tags	string []	必须	印象标签集合	item 类型: string
├─		非必须	印象标签
├─ content	string	必须	评价正文
├─ score	number	必须	评分，取值范围0-5
├─ pictures	string []	必须	晒单照片或视频，多图以英文逗号分割	item 类型: string
├─		非必须

品牌模块

获取品牌列表-APP

基本信息

Path： /brand/simple

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
categoryId	否	123	分类Id，0或不传为全部
productionPlace	否	中国	产地，空字符串或不传为全部
firstWord	否	A	首字母

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	品牌id
├─ logo	string	必须	logo
├─ slogan	string	必须	标语、宣传语
├─ name	string	必须	品牌名
├─ nameEn	string	必须	英文品牌名
├─ productionPlace	string	必须	产地
├─ brandImage	string	必须	品牌大图
├─ firstWord	string	必须	首字母

获取品牌列表-PC

基本信息

Path： /brand

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
categoryId	否	123	分类Id，0或不传为全部
productionPlace	否	中国	产地，空字符串或不传为全部

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	item 类型: object
├─ firstWord	string	必须	首字母
├─ brands	object []	必须	品牌集合	item 类型: object
├─ id	string	必须	品牌id
├─ logo	string	必须	logo
├─ slogan	string	必须	标语、宣传语
├─ name	string	必须	品牌名
├─ nameEn	string	必须	英文品牌名
├─ productionPlace	string	必须	产地
├─ brandImage	string	必须	品牌大图
├─ firstWord	string	必须	首字母

获取品牌详情

基本信息

Path： /brand/:id

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	123	品牌id

返回数据

名称	类型	是否必须	备注
msg	string	必须	提示语
result	object	必须	数据信息
├─ id	string	必须	品牌id
├─ logo	string	必须	logo
├─ slogan	string	必须	标语、宣传语
├─ name	string	必须	品牌名
├─ nameEn	string	必须	英文品牌名
├─ productionPlace	string	必须	产地
├─ brandImage	string	必须	品牌大图
├─ firstWord	string	必须	首字母
├─ brandStory	string	必须	品牌故事
├─ collectNum	integer	必须	关注数
├─ isCollect	boolean	必须	是否已关注

获取品牌检索条件

基本信息

Path： /brand/conditions

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据信息
├─ categories	object []	必须	分类集合	item 类型: object
├─ id	string	必须	分类Id
├─ name	string	必须	分类名称
├─ productionPlaces	string []	必须	产地集合	item 类型: string
├─		非必须	产地
├─ firstWords	string []	必须	首字母集合	item 类型: string
├─		非必须	首字母

专题模块

专题收藏/取消收藏

基本信息

Path： /topic/:id/collect

Method： POST

接口描述：

收藏或取消收藏，以当前状态取反

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	1232131	专题id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语	undefined: 收藏成功

获取专题分类列表

基本信息

Path： /topic/classification

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
limit	否	10	最大获取数量

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最小数量: 8 最大数量: 8 item 类型: object
├─ id	string	必须	专题分类id	undefined: @id
├─ name	string	必须	专题分类名称	undefined: @ctitle(4,4)
├─ icon	string	必须	专题分类icon	undefined: @url

获取专题列表

基本信息

Path： /topic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	页码，默认值1
pageSize	否	10	页尺寸，默认值10
classificationId	否		专题分类id
sortField	否		排序字段，默认以updateTime字段倒序，可选值：title、summary、lowestPrice、collectNum、viewNum
sortRule	否		排序规则，asc为正序、desc为倒序，默认为倒序

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	数据集合
├─ counts	integer	必须	总记录数	undefined: 34
├─ pageSize	integer	必须	页尺寸	undefined: 10
├─ pages	string	必须	总页数	undefined: 4
├─ page	string	必须	当前页码	undefined: 1
├─ items	object []	必须	数据集合	最小数量: 5 最大数量: 5 item 类型: object
├─ id	string	必须	专题id	undefined: @id
├─ title	string	必须	标题	undefined: @ctitle(10,20)
├─ summary	string	必须	副标题	undefined: @ctitle(8,16)
├─ lowestPrice	number	必须	最低价格	undefined: @float(10,100,2,2)
├─ cover	string	必须	封面链接	undefined: @url
├─ detailsUrl	string	必须	详情链接	undefined: @url
├─ classification	object	必须	分类信息
├─ id	string	必须	分类id	undefined: @id
├─ name	string	必须	分类名称	undefined: @ctitle(4,4)
├─ icon	string	必须	图片	undefined: @url
├─ updateTime	string	必须	最近更新时间	undefined: @date('yyyy/MM/dd')
├─ collectNum	integer	必须	收藏数	undefined: @float(90,100,2,2)
├─ viewNum	integer	必须	查看数	undefined: @natural(100,999)

获取专题详情

基本信息

Path： /topic/:id

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	12321312	专题id

返回数据

名称	类型	是否必须	备注
msg	string	必须	提示语
result	object	必须	数据信息
├─ id	string	必须	专题id
├─ title	string	必须	标题
├─ summary	string	必须	副标题
├─ lowestPrice	number	必须	最低价格
├─ cover	string	必须	封面链接
├─ detailsUrl	string	必须	详情链接
├─ updateTime	string	必须	最近更新时间
├─ collectNum	string	必须	收藏数
├─ viewNum	string	必须	查看数
├─ classification	object	必须	分类信息
├─ id	string	必须	分类id
├─ name	string	必须	分类名称
├─ icon	string	必须	图片
├─ isCollect	boolean	必须	是否收藏

获取热门专题

基本信息

Path： /topic/hot

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object []	必须	数据集合	最小数量: 6 最大数量: 6 item 类型: object
├─ id	string	必须	专题id	undefined: @id
├─ title	string	必须	标题	undefined: @ctitle(20,30)
├─ summary	string	必须	副标题	undefined: @ctitle(10,20)
├─ cover	string	必须	专题封面	undefined: @url
├─ detailsUrl	string	必须	详情链接	undefined: @url

会员中心-个人信息

获取个人信息

基本信息

Path： /member/profile

Method： GET

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
nickname	string	必须	昵称
gender	string	必须	性别，男、女、未知
birthday	string	必须	生日 YYYY-MM-DD
cityCode	string	必须	城市编码
provinceCode	string	必须	省份编码
profession	string	必须	职业

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果	undefined: 操作成功
result	object	必须	返回信息
├─ id	string	必须	用户Id	undefined: @id
├─ avatar	string	必须	头像	undefined: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png
├─ nickname	string	必须	昵称	undefined: @cname
├─ account	string	必须	账号名称	undefined: @string
├─ gender	string	必须	性别，男、女、未知	枚举: 男,女,未知
├─ birthday	string	必须	生日	undefined: @date
├─ fullLocation	string	必须	省市区的名称：如山东省济南市里历下区	undefined: @string
├─ profession	string	必须	职业

个人信息-修改

基本信息

Path： /member/profile

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
nickname	string	必须	昵称
gender	string	必须	性别，男、女、未知
birthday	string	必须	生日 YYYY-MM-DD
cityCode	string	必须	城市编码
provinceCode	string	必须	省份编码
countyCode	string	必须	区/县编码
profession	integer	必须	职业

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

修改头像

基本信息

Path： /member/profile/avatar

Method： POST

接口描述：

请求参数

Headers

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

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		头像文件

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功
result	string	必须		返回数据	枚举: http://zhoushugang.gitee.io/erabbit-client-pc-static/uploads/avatar_1.png

会员中心-订单

订单-再次购买

基本信息

Path： /member/order/repurchase/:id

Method： GET

接口描述：

请求参数

Headers

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

路径参数

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

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ userAddresses	object []	必须	用户地址列表	item 类型: object
├─ id	string	必须	id
├─ provinceCode	string	必须	省份编码
├─ cityCode	string	必须	城市编码
├─ countyCode	string	必须	所在区/县编码
├─ address	string	必须	详细地址
├─ isDefault	integer	必须	是否为默认，0为是，1为否
├─ goods	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ count	integer	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”
├─ price	number	必须	原单价
├─ payPrice	number	必须	实付单价
├─ totalPrice	number	必须	小计总价
├─ totalPayPrice	number	必须	实付价格小计
├─ summary	object	必须	综述信息
├─ goodsCount	integer	必须	商品件数
├─ totalPrice	number	必须	价格总计
├─ totalPayPrice	number	必须	应付总计
├─ postFee	number	必须	邮费
├─ discountPrice	number	必须	折扣总计

发货--模拟发货（包含了模拟物流）

基本信息

Path： /member/order/consignment/:id

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	订单编号	undefined: @natural
├─ createTime	string	必须	下单时间	undefined: @now
├─ payType	integer	必须	支付方式，1为在线支付，2为货到付款
├─ orderState	integer	必须	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消	undefined: @integer(1,6)
├─ payLatestTime	integer	必须	付款截止时间：剩余的秒数，前台转换成分钟：秒数
├─ postFee	string	必须	邮费
├─ payMoney	string	必须	实付金额	undefined: @float(100,1000,2,2)
├─ payChannel	integer	必须	支付渠道，1支付宝、2微信
├─ totalMoney	string	必须	金额合计
├─ totalNum	string	必须	数量合计
├─ deliveryTimeType	integer	必须	配送时间类型，1为不限，2为工作日，3为双休或假日
├─ receiverContact	string	必须	收货人
├─ receiverMobile	string	必须	收货人手机
├─ receiverAddress	string	必须	收货人地址
├─ payTime	string	必须	付款时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ consignTime	string	必须	发货时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ endTime	string	必须	交易完成时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ closeTime	string	必须	交易关闭时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ evaluationTime	string	必须	完成评价时间	undefined: @date('yyyy-MM-dd HH:mm:ss')

获取我的订单

基本信息

Path： /member/order

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页码
pageSize	是	10	页尺寸
orderState	否	1	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消，未传该参数或0为全部

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ counts	integer	必须	总记录数
├─ pageSize	string	必须	页尺寸
├─ pages	string	必须	总页数
├─ page	string	必须	当前页码
├─ items	object []	必须	数据集合	item 类型: object
├─ id	string	必须	订单编号
├─ createTime	string	必须	下单时间
├─ payType	integer	必须	支付方式，1为在线支付，2为货到付款
├─ orderState	integer	必须	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消
├─ payLatestTime	string	必须	付款截止时间
├─ countdown	integer	必须	倒计时--剩余的秒数 -1 表示已经超时，正数表示倒计时未结束
├─ postFee	number	必须	邮费
├─ payMoney	number	必须	实付金额
├─ totalMoney	number	必须	金额合计
├─ totalNum	string	必须	数量合计
├─ skus	object []	必须	商品集合	item 类型: object
├─ id	string	必须	sku id
├─ spuId	string	必须	spu id
├─ name	string	必须	商品名称
├─ quantity	integer	必须	数量
├─ image	string	必须	图片地址
├─ realPay	number	必须	实付金额
├─ properties	object []	必须	属性集合	item 类型: object
├─ propertyMainName	string	必须	属性名称，如颜色
├─ propertyValueName	string	必须	属性值名称，如黑色
├─ attrsText	string	必须	属性例如“颜色:瓷白色尺寸：8寸”

获取我的订单详情

基本信息

Path： /member/order/:id

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	订单编号	undefined: @natural
├─ createTime	string	必须	下单时间	undefined: @now
├─ payType	integer	必须	支付方式，1为在线支付，2为货到付款
├─ orderState	integer	必须	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消	undefined: @integer(1,6)
├─ payLatestTime	integer	必须	付款截止时间：剩余的秒数，前台转换成分钟：秒数
├─ countdown	integer	必须	倒计时--剩余的秒数 -1 表示已经超时，正数表示倒计时未结束	undefined: @integer(-1,180)
├─ postFee	string	必须	邮费
├─ payMoney	string	必须	实付金额	undefined: @float(100,1000,2,2)
├─ payChannel	integer	必须	支付渠道，1支付宝、2微信
├─ totalMoney	string	必须	金额合计
├─ totalNum	string	必须	数量合计
├─ deliveryTimeType	integer	必须	配送时间类型，1为不限，2为工作日，3为双休或假日
├─ receiverContact	string	必须	收货人
├─ receiverMobile	string	必须	收货人手机
├─ receiverAddress	string	必须	收货人地址
├─ payTime	string	必须	付款时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ consignTime	string	必须	发货时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ arrivalEstimatedTime	string	必须	预计到货时间	undefined: @date('yyyy-MM-dd')
├─ endTime	string	必须	交易完成时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ closeTime	string	必须	交易关闭时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ evaluationTime	string	必须	完成评价时间	undefined: @date('yyyy-MM-dd HH:mm:ss')
├─ skus	object []	必须	商品集合	item 类型: object
├─ id	string	必须	sku id
├─ spuId	string	必须	spu id
├─ name	string	必须	商品名称
├─ quantity	string	必须	数量
├─ image	string	必须	图片地址
├─ totalMoney	number	必须	小计
├─ realPay	number	必须	实付金额
├─ curPrice	number	必须	单价
├─ properties	object []	必须	属性集合	item 类型: object
├─ propertyMainName	string	必须	属性名称，如颜色
├─ propertyValueName	string	必须	属性值名称，如黑色

取消订单

基本信息

Path： /member/order/:id/cancel

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

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

Body

名称	类型	是否必须	默认值	备注	其他信息
cancelReason	string	必须		取消理由

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	订单编号
├─ createTime	string	必须	下单时间
├─ payType	integer	必须	支付方式，1为在线支付，2为货到付款
├─ orderState	integer	必须	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消
├─ payLatestTime	string	必须	付款截止时间
├─ postFee	string	必须	邮费
├─ payMoney	string	必须	实付金额
├─ payChannel	integer	必须	支付渠道，1支付宝、2微信
├─ totalMoney	string	必须	金额合计
├─ totalNum	string	必须	数量合计
├─ deliveryTimeType	integer	必须	配送时间类型，1为不限，2为工作日，3为双休或假日
├─ receiverContact	string	必须	收货人
├─ receiverMobile	string	必须	收货人手机
├─ receiverAddress	string	必须	收货人地址
├─ payTime	string	必须	付款时间
├─ consignTime	string	必须	发货时间
├─ endTime	string	必须	交易完成时间
├─ closeTime	string	必须	交易关闭时间
├─ skus	object []	必须	商品集合	item 类型: object
├─ id	string	必须	sku id
├─ spuId	string	必须	spu id
├─ name	string	必须	商品名称
├─ quantity	string	必须	数量
├─ image	string	必须	图片地址
├─ totalMoney	number	必须	小计
├─ realPay	number	必须	实付金额
├─ curPrice	number	必须	单价
├─ properties	object []	必须	属性集合	item 类型: object
├─ propertyMainName	string	必须	属性名称，如颜色
├─ propertyValueName	string	必须	属性值名称，如黑色

确认收货

基本信息

Path： /member/order/:id/receipt

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

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

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	订单编号
├─ createTime	string	必须	下单时间
├─ payType	integer	必须	支付方式，1为在线支付，2为货到付款
├─ orderState	integer	必须	订单状态，1为待付款、2为待发货、3为待收货、4为待评价、5为已完成、6为已取消
├─ payLatestTime	string	必须	付款截止时间
├─ postFee	string	必须	邮费
├─ payMoney	string	必须	实付金额
├─ payChannel	integer	必须	支付渠道，1支付宝、2微信
├─ totalMoney	string	必须	金额合计
├─ totalNum	string	必须	数量合计
├─ deliveryTimeType	integer	必须	配送时间类型，1为不限，2为工作日，3为双休或假日
├─ receiverContact	string	必须	收货人
├─ receiverMobile	string	必须	收货人手机
├─ receiverAddress	string	必须	收货人地址
├─ payTime	string	必须	付款时间
├─ consignTime	string	必须	发货时间
├─ endTime	string	必须	交易完成时间
├─ closeTime	string	必须	交易关闭时间
├─ skus	object []	必须	商品集合	item 类型: object
├─ id	string	必须	sku id
├─ spuId	string	必须	spu id
├─ name	string	必须	商品名称
├─ quantity	string	必须	数量
├─ image	string	必须	图片地址
├─ totalMoney	number	必须	小计
├─ realPay	number	必须	实付金额
├─ curPrice	number	必须	单价
├─ properties	object []	必须	属性集合	item 类型: object
├─ propertyMainName	string	必须	属性名称，如颜色
├─ propertyValueName	string	必须	属性值名称，如黑色

查看物流

基本信息

Path： /member/order/:id/logistics

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须		undefined: 查询成功
result	object	必须	查询结果
├─ picture	string	必须	商品图片	undefined: https://yanxuan-item.nosdn.127.net/f7a4f643e245d03771d6f12c94e71214.png
├─ count	integer	必须	商品件数	undefined: @natural(1,3)
├─ company	object	必须	快递公司
├─ name	string	必须	公司名称	undefined: 顺丰快递
├─ number	string	必须	快递编号	undefined: @natural
├─ tel	string	必须	联系电话	undefined: 95338
├─ list	object []	必须	物流日志	item 类型: object
├─ id	string	必须	信息ID	undefined: @natural
├─ text	string	必须	信息文字	undefined: @ctitle(10,20)
├─ time	string	必须	时间	undefined: @date('yyyy-MM-dd HH:mm:ss')

立即购买(即填写订单或结算页)

基本信息

Path： /member/order/pre/now

Method： GET

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
skuId	是	1377177712698855425	商品skuId
count	是	1	购买商品的数量
addressId	是	1371397836297474050	下单时已经选择好的地址id

Body

名称	类型	是否必须	备注
skuId	string	必须	sku Id集合
count	number	必须
addressId	string	必须

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ userAddresses	object []	必须	用户地址列表	item 类型: object
├─ id	string	必须	id
├─ provinceCode	string	必须	省份编码
├─ cityCode	string	必须	城市编码
├─ countyCode	string	必须	所在区/县编码
├─ address	string	必须	详细地址
├─ isDefault	integer	必须	是否为默认，0为是，1为否
├─ selected	boolean	必须	标识：传入的地址信息
├─ goods	object []	必须	商品集合	item 类型: object
├─ id	string	必须	id
├─ name	string	必须	商品名称
├─ picture	string	必须	图片
├─ count	integer	必须	数量
├─ skuId	string	必须	SKUID
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”
├─ price	number	必须	原单价
├─ payPrice	number	必须	实付单价
├─ totalPrice	number	必须	小计总价
├─ totalPayPrice	number	必须	实付价格小计
├─ summary	object	必须	综述信息
├─ goodsCount	integer	必须	商品件数
├─ totalPrice	number	必须	价格总计
├─ totalPayPrice	number	必须	应付总计
├─ postFee	number	必须	邮费
├─ discountPrice	number	必须	折扣总计

生成订单(即填写订单或结算页)

基本信息

Path： /member/order/pre

Method： GET

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
cancelReason	string	必须		取消理由

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ userAddresses	object []	必须	用户地址列表	item 类型: object
├─ id	string	必须	id	undefined: @id
├─ provinceCode	string	必须	省份编码	undefined: 360000
├─ cityCode	string	必须	城市编码	undefined: 360100
├─ countyCode	string	必须	所在区/县编码	undefined: 360113
├─ address	string	必须	详细地址	undefined: 解放路108号物质大厦1003室
├─ isDefault	integer	必须	是否为默认，0为是，1为否	undefined: 0
├─ receiver	string	必须	收货人	undefined: @cname
├─ contact	string	必须	联系方式	undefined: 132****2033
├─ fullLocation	string	必须	完整行政区	undefined: 江西省南昌市红谷滩区
├─ postalCode	string	必须	邮编	undefined: @integer(0,999999,6,6)
├─ goods	object []	必须	商品集合	最大数量: 3 item 类型: object
├─ id	string	必须	id	undefined: @id
├─ name	string	必须	商品名称	undefined: @ctitle(10,20)
├─ picture	string	必须	图片	undefined: https://yanxuan-item.nosdn.127.net/08472a1eddfcbff0f5fbf9e3b0695980.jpg?type=webp&imageView&quality=95&thumbnail=210x210
├─ count	integer	必须	数量	undefined: 1
├─ skuId	string	必须	SKUID	undefined: @id
├─ attrsText	string	必须	属性文字，例如“颜色:瓷白色尺寸：8寸”	undefined: 颜色：白色尺寸：10cm 产地：日本
├─ price	number	必须	原单价	undefined: 128.00
├─ payPrice	number	必须	实付单价	undefined: 128.00
├─ totalPrice	number	必须	小计总价	undefined: 128.00
├─ totalPayPrice	number	必须	实付价格小计	undefined: 128.00
├─ summary	object	必须
├─ goodsCount	integer	必须	商品件数	undefined: 3
├─ totalPrice	number	必须	价格总计	undefined: 384.00
├─ totalPayPrice	number	必须	应付总计	undefined: 384.00
├─ postFee	number	必须	邮费	undefined: 0.00
├─ discountPrice	number	必须	折扣总计	undefined: 0.00

提交订单

基本信息

Path： /member/order

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
goods	object []	必须	商品集合	item 类型: object
├─ skuId	string	必须	skuId
├─ count	integer	必须	数量
addressId	string	必须	所选地址Id
deliveryTimeType	integer	必须	配送时间类型，1为不限，2为工作日，3为双休或假日
payType	integer	必须	支付方式，1为在线支付，2为货到付款
payChannel	integer	必须	支付渠道：支付渠道，1支付宝、2微信--支付方式为在线支付时，传值，为货到付款时，不传值
buyerMessage	string	必须	买家留言

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	提示语
result	object	必须	返回信息
├─ id	string	必须	订单Id	undefined: @id
├─ payType	string	必须	支付方式，1为在线支付，2为货到付款
├─ payChannel	string	必须	支付渠道，1支付宝、2微信

删除订单

基本信息

Path： /member/order

Method： DELETE

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
ids	string []	必须		订单集合	item 类型: string
├─		非必须		订单id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		提示语
result	object	必须		返回信息

会员中心-兴趣分类

兴趣分类-获取

基本信息

Path： /member/profile/interest

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果
result	object []	必须	数据集合	最小数量: 9 最大数量: 9 item 类型: object
├─ id	string	必须	兴趣分类id	undefined: @id
├─ name	string	必须	兴趣分类名称	undefined: @ctitle(2,3)
├─ url	string	必须	兴趣图片url	undefined: https://yanxuan-item.nosdn.127.net/f7a4f643e245d03771d6f12c94e71214.png
├─ check	boolean	必须	是否选中

兴趣分类-修改

基本信息

Path： /member/profile/interest

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
	string []	非必须		兴趣分类集合	item 类型: string
├─		非必须		兴趣分类Id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作成功

会员中心-尺码

我的尺码-获取

基本信息

Path： /member/profile/property

Method： GET

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须		兴趣分类集合	item 类型: object
├─ id	string	必须		兴趣分类Id

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作成功
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	数据Id	undefined: @id
├─ height	number	必须	身高，单位cm	undefined: @integer(160,190)
├─ bodyWeight	number	必须	体重,单位kg	undefined: @integer(40,100)
├─ shoulderWidth	number	必须	肩宽，单位cm	undefined: @integer(30,80)
├─ chestCircumference	number	必须	胸围，单位cm	undefined: @integer(60,100)
├─ waistCircumference	number	必须	腰围，单位cm	undefined: @integer(40,80)
├─ hips	number	必须	臀围，单位cm	undefined: @integer(60,100)
├─ footSize	number	必须	脚长，单位cm	undefined: @integer(10,40)
├─ footCircumference	number	必须	脚围，单位cm	undefined: @integer(20,40)
├─ name	string	必须	角色名称	undefined: @cname
├─ gender	string	必须	性别，男、女、未知	枚举: 男,女,未知
├─ isDefault	integer	必须	是否为默认,0为是，1为否	undefined: @integer(0,1)

我的尺码-新增

基本信息

Path： /member/profile/property

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
height	number	非必须	身高，单位cm
bodyWeight	number	非必须	体重,单位kg
shoulderWidth	number	非必须	肩宽，单位cm
chestCircumference	number	必须	胸围，单位cm
waistCircumference	number	必须	腰围，单位cm
hips	number	必须	臀围，单位cm
footSize	number	必须	脚长，单位cm
footCircumference	number	必须	脚围，单位cm
name	string	必须	角色名称
gender	string	必须	性别，男、女、未知
isDefault	integer	必须	是否为默认,0为是，1为否

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作信息	undefined: 操作成功
result	object	必须
├─ id	string	必须	ID	undefined: @id

我的尺码-修改

基本信息

Path： /member/profile/property/:id

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	111	我的尺码id

Body

名称	类型	是否必须	备注
height	number	非必须	身高，单位cm
bodyWeight	number	非必须	体重,单位kg
shoulderWidth	number	非必须	肩宽，单位cm
chestCircumference	number	必须	胸围，单位cm
waistCircumference	number	必须	腰围，单位cm
hips	number	必须	臀围，单位cm
footSize	number	必须	脚长，单位cm
footCircumference	number	必须	脚围，单位cm
name	string	必须	角色名称
gender	string	必须	性别，男、女、未知
isDefault	integer	必须	是否为默认,0为是，1为否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作信息	undefined: 操作成功

我的尺码-删除

基本信息

Path： /member/profile/property/:id

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	111	我的尺码id

Body

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作信息	undefined: 操作成功

会员中心-地址管理

添加收货地址

基本信息

Path： /member/address

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注
receiver	string	必须	测试	收货人姓名
contact	string	必须		联系方式
provinceCode	string	必须		所在省份编码
cityCode	string	必须		所在城市编码
countyCode	string	必须		所在区/县编码
address	string	必须		详细地址
postalCode	string	必须		邮政编码
addressTags	string	必须		地址标签,以英文逗号分割
isDefault	integer	必须		是否为默认，0为是，1为否

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果	undefined: 操作成功
result	object	必须
├─ id	integer	必须		undefined: @id

删除收货地址

基本信息

Path： /member/address/:id

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	1	收货地址id

Body

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

更新收货地址

基本信息

Path： /member/address/:id

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	123	收货地址id

Body

名称	类型	是否必须	备注
receiver	string	必须	收货人姓名
contact	string	必须	联系方式
provinceCode	string	必须	所在省份编码
cityCode	string	必须	所在城市编码
countyCode	string	必须	所在区/县编码
address	string	必须	详细地址
postalCode	string	必须	邮政编码
addressTags	string	必须	地址标签,以英文逗号分割
isDefault	integer	必须	是否为默认，0为是，1为否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

获取收货地址列表

基本信息

Path： /member/address

Method： GET

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
receiver	string	必须	收货人姓名
contact	string	必须	联系方式
provinceCode	string	必须	所在省份编码
cityCode	string	必须	所在城市编码
countyCode	string	必须	所在区/县编码
address	string	必须	详细地址
postalCode	string	必须	邮政编码
addressTags	string	必须	地址标签,以英文逗号分割
isDefault	integer	必须	是否为默认，0为是，1为否

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果	undefined: 操作成功
result	object []	必须	数据集合	item 类型: object
├─ id	string	必须	收货地址id
├─ receiver	string	必须	收货人姓名	undefined: @cname
├─ provinceCode	string	必须	所在省份编码	undefined: 360000
├─ cityCode	string	必须	所在城市编码	undefined: 360100
├─ countyCode	string	必须	所在区/县编码	undefined: 360113
├─ address	string	必须	详细地址	undefined: @ctitle(10,15)
├─ isDefault	integer	必须	是否为默认，0为是，1为否
├─ contact	string	必须	联系方式	undefined: 13211112222
├─ postalCode	string	必须	邮政编码
├─ addressTags	string	必须	地址标签，号分隔	undefined: 家,江西
├─ fullLocation	string	必须	完整行政区	undefined: @county(true)

会员中心-足迹

获取我的足迹

基本信息

Path： /member/browseHistory

Method： GET

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
page	是	1	当前页码
pageSize	是	10	页尺寸

Body

名称	类型	是否必须	备注
receiver	string	必须	收货人姓名
contact	string	必须	联系方式
provinceCode	string	必须	所在省份编码
cityCode	string	必须	所在城市编码
countyCode	string	必须	所在区/县编码
address	string	必须	详细地址
postalCode	string	必须	邮政编码
addressTags	string	必须	地址标签,以英文逗号分割
isDefault	integer	必须	是否为默认，0为是，1为否

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果	undefined: 操作成功
result	object	必须	分页数据
├─ counts	integer	必须	总记录数	undefined: @integer(40,100)
├─ pageSize	integer	必须	页尺寸
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页码
├─ items	object []	必须	数据集合	最小数量: 10 最大数量: 10 item 类型: object
├─ id	string	必须	spuId,即商品Id	undefined: @natural
├─ name	string	必须	商品名称	undefined: @ctitle
├─ desc	string	必须	商品描述	undefined: @ctitle
├─ price	number	必须	商品价格	undefined: @float(100,200,2,2)
├─ discount	number	必须	折扣信息，如为null时，即无折扣	undefined: @float(0,0,1,1)
├─ browserTime	string	必须	浏览时间	undefined: @datetime
├─ picture	string	必须	商品图片	undefined: https://yanxuan-item.nosdn.127.net/f7a4f643e245d03771d6f12c94e71214.png

删除我的足迹

基本信息

Path： /member/browseHistory/batch

Method： DELETE

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
ids	string []	非必须	需删除的集合	item 类型: string
├─		非必须	spu id
dateType	integer	非必须	1为今天，2为昨天，3为更早以前，4为全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

会员中心-收藏（商品、专题、品牌）

添加收藏

基本信息

Path： /member/collect

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
collectType	integer	必须	收藏类型，1为商品，2为专题，3为品牌
collectObjectIds	string []	必须	收藏对象id集合	item 类型: string
├─		非必须	收藏对象id（多个为批量处理）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

获取收藏

基本信息

Path： /member/collect

Method： GET

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
page	否	1	页码
pageSize	否	10	页尺寸
collectType	是	1	收藏类型，1为商品，2为专题，3为品牌

Body

名称	类型	是否必须	备注	其他信息
ids	string []	非必须	需删除的集合	item 类型: string
├─		非必须	spu id
all	boolean	非必须	是否全部清除

返回数据

名称	类型	是否必须	备注	其他信息
msg	string	必须	操作结果	undefined: 操作成功
result	object	必须	分页数据
├─ counts	integer	必须	总记录数	undefined: 100
├─ pageSize	integer	必须	页尺寸
├─ pages	integer	必须	总页数
├─ page	integer	必须	当前页码
├─ items	object []	必须	数据集合	最小数量: 12 最大数量: 12 item 类型: object
├─ id	string	必须	id	undefined: @natural
├─ name	string	必须	名称	undefined: @ctitle
├─ description	string	必须	描述	undefined: @ctitle
├─ picture	string	必须	图片	undefined: @image
├─ collectType	integer	必须	收藏类型，1为商品，2为专题，3为品牌
├─ price	number	必须	商品-商品价格	undefined: @natural(100,200)
├─ discount	number	必须	商品-折扣信息
├─ productionPlace	string	必须	品牌-产地，多字段通过/分割	undefined: @city
├─ detailsUrl	string	必须	详情链接

取消收藏

基本信息

Path： /member/collect/batch

Method： DELETE

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
ids	string []	非必须	待删除的集合	item 类型: string
├─		非必须	待删除对象id
type	integer	必须	收藏类型，1为商品，2为专题，3为品牌

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		操作结果	undefined: 操作成功

YAPI 接口文档

小兔鲜儿-PC前台

公共分类

获取短信验证码-注册或登录-APP

基本信息

请求参数

返回数据

刷新token

基本信息

请求参数

返回数据

获取短信验证码-注册-PC

基本信息

请求参数

返回数据

注册-PC/app

基本信息

请求参数

返回数据

验证手机验证码-注册-APP

基本信息

请求参数

返回数据

注册-校验用户名唯一

基本信息

请求参数

返回数据

注册-手机号和密码注册-APP-未使用

基本信息

请求参数

返回数据

获取短信验证码-登录-PC

基本信息

请求参数

返回数据

登录-用户名和密码

基本信息

请求参数

返回数据

手机验证码登录

基本信息

请求参数

返回数据

三方登录_发送已有账号短信

基本信息

请求参数

返回数据

三方登录

基本信息

请求参数

返回数据

三方登录_账号绑定

基本信息

请求参数

返回数据

三方登录_账号解绑（解绑qq信息）

基本信息

请求参数

返回数据

三方登录-完善信息

基本信息

请求参数

返回数据

文件上传

基本信息

请求参数

返回数据

忘记密码-获取短信验证码

基本信息

请求参数

返回数据

忘记密码-获取验证码图片-PC

基本信息

请求参数

返回数据

忘记密码-验证手机号-APP

基本信息

请求参数

返回数据

忘记密码-验证用户名-PC