云商城

Version	Update Time	Status	Author	Description
0.0.1	2023-09-01 18:50:00	创建文档	codingliang	初始化接口文档

Version

Update Time

Status

Author

Description

0.0.1

2023-09-01 18:50:00

创建文档

codingliang

初始化接口文档

1. 关于我

1.1. 关于我详情

URL: http://localhost:10000/cloud-mall/aboutShop/open/info

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 关于我详情

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/aboutShop/open/info

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─type	string	类型;1网页 2内容	-
└─url	string	网页地址;type为1时必填	-
└─descInfo	string	富文本内容;type为2时必填	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─type

string

类型;1网页 2内容

└─url

string

网页地址;type为1时必填

└─descInfo

string

富文本内容;type为2时必填

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 338,
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": 684,
		"id": 725,
		"type": "kk5pqc",
		"url": "www.xn---xn--po3a-p23rv513b.biz",
		"descInfo": "a8k4v9"
	}
}

1.2. 修改关于我

URL: http://localhost:10000/cloud-mall/aboutShop/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改关于我

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
type	string	类型;1网页 2内容	true	-
url	string	网页地址;type为1时必填	false	-
descInfo	string	富文本内容;type为2时必填	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

type

string

类型;1网页 2内容

true

url

string

网页地址;type为1时必填

false

descInfo

string

富文本内容;type为2时必填

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/aboutShop/admin/update? --data '{
	"createBy": 941,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 368,
	"id": 507,
	"type": "718bjb",
	"url": "www.xn---xn--po3a-p23rv513b.biz",
	"descInfo": "qk68i9"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

2. 管理员信息

2.1. 管理员登录

URL: http://localhost:10000/cloud-mall/admin/open/login

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 管理员登录

Body-parameters:

Parameter	Type	Description	Required	Since
username	string	用户名	true	-
password	string	密码	true	-

Parameter

Type

Description

Required

Since

username

string

用户名

true

password

string

密码

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/admin/open/login? --data '{
	"username": "智宸.郭",
	"password": "72mcge"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─token	string	token	-
└─ttl	int64	token过期时间	-
└─nickName	string	用户昵称	-
└─avatar	string	用户头像	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─token

string

token

└─ttl

int64

token过期时间

└─nickName

string

用户昵称

└─avatar

string

用户头像

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"token": "x0g1vp",
		"ttl": 822,
		"nickName": "donn.harber",
		"avatar": "reagq7"
	}
}

2.2. 管理员列表

URL: http://localhost:10000/cloud-mall/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 管理员列表

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页	false	-
pageSize	int32	每页大小	false	-
orderField	string	排序字段	false	-
order	string	排序方式，可选值：asc、desc	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/admin/list?curPage=1&pageSize=10&order=utru3f&orderField=dvgxh1

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─totalCount	int32	总记录数	-
└─pageSize	int32	每页记录数	-
└─totalPage	int32	总页数	-
└─currPage	int32	当前页数	-
└─list	array	列表数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id，修改时不能为空	-
└─username	string	用户名称	-
└─phone	string	手机号	-
└─avatar	string	头像	-
└─password	string	密码	-
└─state	string	状态;0禁用 1 正常	-
└─gender	string	性别;1 男性 2 女性	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，修改时不能为空

└─username

string

用户名称

└─phone

string

手机号

└─avatar

string

头像

└─password

string

密码

└─state

string

状态;0禁用 1 正常

└─gender

string

性别;1 男性 2 女性

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 577,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 360,
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": 649,
				"id": 50,
				"username": "智宸.郭",
				"phone": "15646845106",
				"avatar": "2rhgph",
				"password": "lrqnzo",
				"state": "le91fv",
				"gender": "gedx2d"
			}
		]
	}
}

2.3. 管理员详情

URL: http://localhost:10000/cloud-mall/admin/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 管理员详情

Path-parameters:

Parameter	Type	Description	Required	Since
id	int64	管理员id	true	-

Parameter

Type

Description

Required

Since

int64

管理员id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/admin/info/312

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id，修改时不能为空	-
└─username	string	用户名称	-
└─phone	string	手机号	-
└─avatar	string	头像	-
└─password	string	密码	-
└─state	string	状态;0禁用 1 正常	-
└─gender	string	性别;1 男性 2 女性	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，修改时不能为空

└─username

string

用户名称

└─phone

string

手机号

└─avatar

string

头像

└─password

string

密码

└─state

string

状态;0禁用 1 正常

└─gender

string

性别;1 男性 2 女性

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 30,
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": 60,
		"id": 974,
		"username": "智宸.郭",
		"phone": "15646845106",
		"avatar": "1fea33",
		"password": "orloyj",
		"state": "jpjqpc",
		"gender": "utenp3"
	}
}

2.4. 新增管理员

URL: http://localhost:10000/cloud-mall/admin/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增管理员

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id，修改时不能为空	false	-
username	string	用户名称	true	-
phone	string	手机号	true	-
avatar	string	头像	true	-
password	string	密码	false	-
state	string	状态;0禁用 1 正常	true	-
gender	string	性别;1 男性 2 女性	true	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

username

string

用户名称

true

phone

string

手机号

true

avatar

string

头像

true

password

string

密码

false

state

string

状态;0禁用 1 正常

true

gender

string

性别;1 男性 2 女性

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/admin/save? --data '{
	"createBy": 668,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 834,
	"id": 530,
	"username": "智宸.郭",
	"phone": "15646845106",
	"avatar": "sfsxmt",
	"password": "us56l0",
	"state": "redez9",
	"gender": "kuk0jo"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

2.5. 修改用户

URL: http://localhost:10000/cloud-mall/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改用户

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id，修改时不能为空	false	-
username	string	用户名称	true	-
phone	string	手机号	true	-
avatar	string	头像	true	-
password	string	密码	false	-
state	string	状态;0禁用 1 正常	true	-
gender	string	性别;1 男性 2 女性	true	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

username

string

用户名称

true

phone

string

手机号

true

avatar

string

头像

true

password

string

密码

false

state

string

状态;0禁用 1 正常

true

gender

string

性别;1 男性 2 女性

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/admin/update? --data '{
	"createBy": 263,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 605,
	"id": 435,
	"username": "智宸.郭",
	"phone": "15646845106",
	"avatar": "mqvg25",
	"password": "nfutq8",
	"state": "sxw80j",
	"gender": "sbc9y1"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

2.6. 修改用户密码

URL: http://localhost:10000/cloud-mall/admin/password

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 只有超级管理员才能修改其他用户密码

Query-parameters:

Parameter	Type	Description	Required	Since
userId	int64	用户id 待修改用户的id	false	-
password	string	新密码	false	-

Parameter

Type

Description

Required

Since

userId

int64

用户id 待修改用户的id

false

password

string

新密码

false

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/admin/password --data 'password=6pusaa&userId=315'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

2.7. 删除用户

URL: http://localhost:10000/cloud-mall/admin/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除用户

Body-parameters:

Parameter	Type	Description	Required	Since
ids	array	No comments found.,[array of int64]	false

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/admin/delete --data '[
	377,
	338
]'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

3. app端使用到的聚合接口

3.1. 首页

URL: http://localhost:10000/cloud-mall/app/open/index

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 包含首页轮播图、金刚墙、限时精选、热门推荐数据

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/app/open/index

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─carousels	array	轮播图	-
└─id	int64	轮播图id	-
└─img	string	图片地址	-
└─remark	string	备注	-
└─sort	int32	排序	-
└─state	string	状态;0禁用 1启用	-
└─type	string	跳转类型;0不跳转 1调整页面 2调整网页	-
└─url	string	跳转地址;type不为0时不能为空	-
└─navigations	array	金刚区	-
└─id	int64	id	-
└─name	string	类别名称	-
└─iconName	string	图标地址	-
└─remark	string	备注	-
└─sort	int32	排序	-
└─state	string	状态;0禁用 1启用	-
└─type	string	类别;0不跳转 1调整页面 2调整网页	-
└─url	string	跳转地址;type不为0时不能为空	-
└─limitGoods	array	限时精选榜单	-
└─goodsId	int64	商品id	-
└─sort	int32	排序	-
└─name	string	商品名称	-
└─state	string	商品状态;0下架 1在售 2 待审核	-
└─img	string	商品图片地址;多张图片使用,分割	-
└─price	number	销售价格	-
└─marketPrice	number	市场价格	-
└─hot	string	是否热门推荐;0否1是	-
└─limited	string	是否限时精选;0否1是	-
└─hotGoods	array	热门榜单	-
└─goodsId	int64	商品id	-
└─sort	int32	排序	-
└─name	string	商品名称	-
└─state	string	商品状态;0下架 1在售 2 待审核	-
└─img	string	商品图片地址;多张图片使用,分割	-
└─price	number	销售价格	-
└─marketPrice	number	市场价格	-
└─hot	string	是否热门推荐;0否1是	-
└─limited	string	是否限时精选;0否1是	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─carousels

array

轮播图

└─id

int64

轮播图id

└─img

string

图片地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

跳转类型;0不跳转 1调整页面 2调整网页

└─url

string

跳转地址;type不为0时不能为空

└─navigations

array

金刚区

└─id

int64

└─name

string

类别名称

└─iconName

string

图标地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

类别;0不跳转 1调整页面 2调整网页

└─url

string

跳转地址;type不为0时不能为空

└─limitGoods

array

限时精选榜单

└─goodsId

int64

商品id

└─sort

int32

排序

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─img

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─hot

string

是否热门推荐;0否1是

└─limited

string

是否限时精选;0否1是

└─hotGoods

array

热门榜单

└─goodsId

int64

商品id

└─sort

int32

排序

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─img

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─hot

string

是否热门推荐;0否1是

└─limited

string

是否限时精选;0否1是

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"carousels": [
			{
				"id": 549,
				"img": "fhkpzm",
				"remark": "jxoe2s",
				"sort": 792,
				"state": "l7192b",
				"type": "jxw1kw",
				"url": "www.xn---xn--po3a-p23rv513b.biz"
			}
		],
		"navigations": [
			{
				"id": 193,
				"name": "智宸.郭",
				"iconName": "智宸.郭",
				"remark": "c7m9cc",
				"sort": 542,
				"state": "7oy16j",
				"type": "l9rlum",
				"url": "www.xn---xn--po3a-p23rv513b.biz"
			}
		],
		"limitGoods": [
			{
				"goodsId": 57,
				"sort": 79,
				"name": "智宸.郭",
				"state": "syptmc",
				"img": "iqnfmv",
				"price": 484,
				"marketPrice": 800,
				"hot": "8tq9gl",
				"limited": "zdq2w7"
			}
		],
		"hotGoods": [
			{
				"goodsId": 770,
				"sort": 387,
				"name": "智宸.郭",
				"state": "kz9nb5",
				"img": "5iard4",
				"price": 541,
				"marketPrice": 992,
				"hot": "79oofo",
				"limited": "jnlnzx"
			}
		]
	}
}

4. 品牌分类

4.1. 列表

URL: http://localhost:10000/cloud-mall/brandCategoryRelation/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 列表

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页	false	-
pageSize	int32	每页大小	false	-
orderField	string	排序字段	false	-
order	string	排序方式，可选值：asc、desc	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/brandCategoryRelation/list?curPage=1&orderField=8b63ve&pageSize=10&order=gfaae3

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─totalCount	int32	总记录数	-
└─pageSize	int32	每页记录数	-
└─totalPage	int32	总页数	-
└─currPage	int32	当前页数	-
└─list	array	列表数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─brandId	int64	品牌id	-
└─goodsCategoryId	int64	一级分类id	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─brandId

int64

品牌id

└─goodsCategoryId

int64

一级分类id

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 758,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 762,
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": 425,
				"id": 577,
				"brandId": 729,
				"goodsCategoryId": 427
			}
		]
	}
}

4.2. 信息

URL: http://localhost:10000/cloud-mall/brandCategoryRelation/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 信息

Path-parameters:

Parameter	Type	Description	Required	Since
id	int64	No comments found.	true	-

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/brandCategoryRelation/info/459

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─brandId	int64	品牌id	-
└─goodsCategoryId	int64	一级分类id	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─brandId

int64

品牌id

└─goodsCategoryId

int64

一级分类id

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 896,
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": 883,
		"id": 881,
		"brandId": 653,
		"goodsCategoryId": 572
	}
}

4.3. 保存

URL: http://localhost:10000/cloud-mall/brandCategoryRelation/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 保存

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
brandId	int64	品牌id	false	-
goodsCategoryId	int64	一级分类id	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

brandId

int64

品牌id

false

goodsCategoryId

int64

一级分类id

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brandCategoryRelation/save? --data '{
	"createBy": 449,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 183,
	"id": 411,
	"brandId": 484,
	"goodsCategoryId": 93
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

4.4. 修改

URL: http://localhost:10000/cloud-mall/brandCategoryRelation/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
brandId	int64	品牌id	false	-
goodsCategoryId	int64	一级分类id	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

brandId

int64

品牌id

false

goodsCategoryId

int64

一级分类id

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brandCategoryRelation/update? --data '{
	"createBy": 202,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 677,
	"id": 490,
	"brandId": 254,
	"goodsCategoryId": 64
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

4.5. 删除

URL: http://localhost:10000/cloud-mall/brandCategoryRelation/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除

Body-parameters:

Parameter	Type	Description	Required	Since
ids	array	No comments found.,[array of int64]	false

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brandCategoryRelation/delete --data '[
	892,
	161
]'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

5. 品牌信息

5.1. 列表

URL: http://localhost:10000/cloud-mall/brand/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 列表

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页	false	-
pageSize	int32	每页大小	false	-
orderField	string	排序字段	false	-
order	string	排序方式，可选值：asc、desc	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/brand/list?pageSize=10&order=m3iw5j&orderField=23l9uz&curPage=1

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─totalCount	int32	总记录数	-
└─pageSize	int32	每页记录数	-
└─totalPage	int32	总页数	-
└─currPage	int32	当前页数	-
└─list	array	列表数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─name	string	品牌名称	-
└─icon	string	品牌图标	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─name

string

品牌名称

└─icon

string

品牌图标

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 789,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 969,
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": 135,
				"id": 228,
				"name": "智宸.郭",
				"icon": "ko49ok"
			}
		]
	}
}

5.2. 信息

URL: http://localhost:10000/cloud-mall/brand/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 信息

Path-parameters:

Parameter	Type	Description	Required	Since
id	int64	No comments found.	true	-

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/brand/info/305

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─name	string	品牌名称	-
└─icon	string	品牌图标	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─name

string

品牌名称

└─icon

string

品牌图标

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 191,
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": 413,
		"id": 841,
		"name": "智宸.郭",
		"icon": "rvpmlv"
	}
}

5.3. 保存

URL: http://localhost:10000/cloud-mall/brand/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 保存

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
name	string	品牌名称	false	-
icon	string	品牌图标	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

name

string

品牌名称

false

icon

string

品牌图标

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brand/save? --data '{
	"createBy": 730,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 627,
	"id": 119,
	"name": "智宸.郭",
	"icon": "9h85dt"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

5.4. 修改

URL: http://localhost:10000/cloud-mall/brand/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
name	string	品牌名称	false	-
icon	string	品牌图标	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

name

string

品牌名称

false

icon

string

品牌图标

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brand/update? --data '{
	"createBy": 759,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 552,
	"id": 34,
	"name": "智宸.郭",
	"icon": "xankdl"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

5.5. 删除

URL: http://localhost:10000/cloud-mall/brand/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除

Body-parameters:

Parameter	Type	Description	Required	Since
ids	array	No comments found.,[array of int64]	false

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/brand/delete --data '[
	551,
	280
]'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

6. 轮播图

6.1. 轮播图列表

URL: http://localhost:10000/cloud-mall/carousel/open/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 轮播图列表

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页	false	-
pageSize	int32	每页大小	false	-
orderField	string	排序字段	false	-
order	string	排序方式，可选值：asc、desc	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/carousel/open/list?order=qj2ih8&curPage=1&pageSize=10&orderField=h1onfi

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─totalCount	int32	总记录数	-
└─pageSize	int32	每页记录数	-
└─totalPage	int32	总页数	-
└─currPage	int32	当前页数	-
└─list	array	列表数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─img	string	图片地址	-
└─remark	string	备注	-
└─sort	int32	排序	-
└─state	string	状态;0禁用 1启用	-
└─type	string	跳转类型;0不跳转 1跳转页面 2跳转网页	-
└─url	string	跳转地址;type不为0时不能为空	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─img

string

图片地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

跳转类型;0不跳转 1跳转页面 2跳转网页

└─url

string

跳转地址;type不为0时不能为空

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 257,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 98,
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": 333,
				"id": 327,
				"img": "5stq9e",
				"remark": "w51x4r",
				"sort": 804,
				"state": "yu8hsr",
				"type": "yuws25",
				"url": "www.xn---xn--po3a-p23rv513b.biz"
			}
		]
	}
}

6.2. 轮播图信息

URL: http://localhost:10000/cloud-mall/carousel/admin/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 轮播图信息

Path-parameters:

Parameter	Type	Description	Required	Since
id	int64	No comments found.	true	-

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/carousel/admin/info/470

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─createBy	int64	创建人	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─updateBy	int64	更新人	-
└─id	int64	id	-
└─img	string	图片地址	-
└─remark	string	备注	-
└─sort	int32	排序	-
└─state	string	状态;0禁用 1启用	-
└─type	string	跳转类型;0不跳转 1跳转页面 2跳转网页	-
└─url	string	跳转地址;type不为0时不能为空	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─img

string

图片地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

跳转类型;0不跳转 1跳转页面 2跳转网页

└─url

string

跳转地址;type不为0时不能为空

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 279,
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": 502,
		"id": 114,
		"img": "193fev",
		"remark": "7k0ilf",
		"sort": 651,
		"state": "6slxb3",
		"type": "02rbp7",
		"url": "www.xn---xn--po3a-p23rv513b.biz"
	}
}

6.3. 新增轮播图

URL: http://localhost:10000/cloud-mall/carousel/admin/add

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增轮播图

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
img	string	图片地址	true	-
remark	string	备注	false	-
sort	int32	排序	true	-
state	string	状态;0禁用 1启用	false	-
type	string	跳转类型;0不跳转 1跳转页面 2跳转网页	true	-
url	string	跳转地址;type不为0时不能为空	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

img

string

图片地址

true

remark

string

备注

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

false

type

string

跳转类型;0不跳转 1跳转页面 2跳转网页

true

url

string

跳转地址;type不为0时不能为空

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/carousel/admin/add? --data '{
	"createBy": 230,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 929,
	"id": 65,
	"img": "jubvth",
	"remark": "3mh3al",
	"sort": 698,
	"state": "z0dg9b",
	"type": "8jfwgh",
	"url": "www.xn---xn--po3a-p23rv513b.biz"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

6.4. 修改轮播图

URL: http://localhost:10000/cloud-mall/carousel/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改轮播图

Body-parameters:

Parameter	Type	Description	Required	Since
createBy	int64	创建人	false	-
createTime	string	创建时间	false	-
updateTime	string	更新时间	false	-
updateBy	int64	更新人	false	-
id	int64	id	false	-
img	string	图片地址	true	-
remark	string	备注	false	-
sort	int32	排序	true	-
state	string	状态;0禁用 1启用	false	-
type	string	跳转类型;0不跳转 1跳转页面 2跳转网页	true	-
url	string	跳转地址;type不为0时不能为空	false	-

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

img

string

图片地址

true

remark

string

备注

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

false

type

string

跳转类型;0不跳转 1跳转页面 2跳转网页

true

url

string

跳转地址;type不为0时不能为空

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/carousel/admin/update? --data '{
	"createBy": 765,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 366,
	"id": 451,
	"img": "4w6k2n",
	"remark": "7ux6ta",
	"sort": 799,
	"state": "wg5eqy",
	"type": "dd6fa0",
	"url": "www.xn---xn--po3a-p23rv513b.biz"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

6.5. 删除轮播图

URL: http://localhost:10000/cloud-mall/carousel/admin/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除轮播图

Body-parameters:

Parameter	Type	Description	Required	Since
ids	array	No comments found.,[array of int64]	false

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/carousel/admin/delete --data '[
	381,
	39
]'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

7. 购物车接口

7.1. 用户获取购物车

URL: http://localhost:10000/cloud-mall/user/cart/

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户获取购物车

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/user/cart/

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─items	array	购物车商品项	-
└─key	string	购物车项key	-
└─goodsId	int64	商品id	-
└─skuId	int64	skuId	-
└─check	boolean	是否选中	-
└─goodsName	string	商品名称	-
└─goodsMasterImg	string	商品主图	-
└─saleState	string	销售状态	-
└─goodAttr	string	商品属性	-
└─goodsActualPrice	number	售卖单价	-
└─marketPrice	number	市场价格	-
└─goodsCount	int32	商品数量	-
└─limitNum	int32	限制数量	-
└─goodsTotalAmt	number	总价	-
└─countNum	int32	商品数量	-
└─countType	int32	商品类型数量	-
└─totalAmount	number	总价	-
└─reduce	number	优惠	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─items

array

购物车商品项

└─key

string

购物车项key

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─check

boolean

是否选中

└─goodsName

string

商品名称

└─goodsMasterImg

string

商品主图

└─saleState

string

销售状态

└─goodAttr

string

商品属性

└─goodsActualPrice

number

售卖单价

└─marketPrice

number

市场价格

└─goodsCount

int32

商品数量

└─limitNum

int32

限制数量

└─goodsTotalAmt

number

总价

└─countNum

int32

商品数量

└─countType

int32

商品类型数量

└─totalAmount

number

总价

└─reduce

number

优惠

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"items": [
			{
				"key": "vvyv5y",
				"goodsId": 935,
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"check": true,
				"goodsName": "智宸.郭",
				"goodsMasterImg": "byeiiu",
				"saleState": "xii96e",
				"goodAttr": "co10y2",
				"goodsActualPrice": 551,
				"marketPrice": 774,
				"goodsCount": 106,
				"limitNum": 71,
				"goodsTotalAmt": 108
			}
		],
		"countNum": 312,
		"countType": 786,
		"totalAmount": 555,
		"reduce": 218
	}
}

7.2. 商品加入购物车

URL: http://localhost:10000/cloud-mall/user/cart/

Type: PUT

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 商品加入购物车

Query-parameters:

Parameter

Type

Description

Required

Since

goodId

int64

商品id

true

skuId

int64

skuId 商品开启sku后该值不能为空

false

num

int32

数量

true

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/user/cart/ --data 'skuId=aa9d3f6a-4d77-405c-9e02-a44b067d06e2&goodId=82&num=676'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

7.3. 选中/取消选中购物车中某件商品

URL: http://localhost:10000/cloud-mall/user/cart/check/{key}

Type: PUT

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 选中/取消选中购物车中某件商品

Path-parameters:

Parameter

Type

Description

Required

Since

key

string

购物车项key

true

Query-parameters:

Parameter

Type

Description

Required

Since

check

string

是否选中 1是，其他否

false

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/user/cart/check/tavdeq --data 'check=6if126'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

7.4. 批量选中/取消选中购物车中某件商品

URL: http://localhost:10000/cloud-mall/user/cart/batchCheck

Type: PUT

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 批量选中/取消选中购物车中某件商品

Query-parameters:

Parameter

Type

Description

Required

Since

keys

string

购物项key 多个key使用,分割

false

check

string

是否选中 1是，其他否

false

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/user/cart/batchCheck --data 'check=iwlwks&keys=zm6g3i'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

7.5. 删除购物车中某件商品

URL: http://localhost:10000/cloud-mall/user/cart/{key}

Type: DELETE

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除购物车中某件商品

Path-parameters:

Parameter

Type

Description

Required

Since

key

string

购物车项key

true

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/user/cart/iazuly

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

7.6. 清空购物车

URL: http://localhost:10000/cloud-mall/user/cart/clear

Type: DELETE

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空购物车

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/user/cart/clear

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

8. 快递公司

8.1. 快递公司列表

URL: http://localhost:10000/cloud-mall/expressCompany/open/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 快递公司列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/expressCompany/open/list?orderField=emza1v&order=sl260x&pageSize=10&curPage=1

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，修改时不能为空

└─code

string

编码

└─expressName

string

快递名称

└─sort

int32

排序

└─contactsName

string

联系人姓名

└─contactsPhone

string

联系人手机号码

└─state

string

状态;1正常 0禁用

└─delFlag

string

删除标识 1是 0 否

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 786,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 259,
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": 515,
				"id": 97,
				"code": "68204",
				"expressName": "智宸.郭",
				"sort": 481,
				"contactsName": "智宸.郭",
				"contactsPhone": "15646845106",
				"state": "og0cga",
				"delFlag": "1wbhz2"
			}
		]
	}
}

8.2. 新增快递公司

URL: http://localhost:10000/cloud-mall/expressCompany/admin/add

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 快递公司编码不能随便乱填，具体参考快递100，参考链接：https://api.kuaidi100.com/document/5f0ffb5ebc8da837cbd8aefc#section_1

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

code

string

编码

true

expressName

string

快递名称

true

sort

int32

排序

true

contactsName

string

联系人姓名

true

contactsPhone

string

联系人手机号码

true

state

string

状态;1正常 0禁用

false

delFlag

string

删除标识 1是 0 否

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/expressCompany/admin/add? --data '{
	"createBy": 467,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 184,
	"id": 678,
	"code": "68204",
	"expressName": "智宸.郭",
	"sort": 288,
	"contactsName": "智宸.郭",
	"contactsPhone": "15646845106",
	"state": "lgakeh",
	"delFlag": "zsq810"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

8.3. 修改快递公司

URL: http://localhost:10000/cloud-mall/expressCompany/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改快递公司

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

code

string

编码

true

expressName

string

快递名称

true

sort

int32

排序

true

contactsName

string

联系人姓名

true

contactsPhone

string

联系人手机号码

true

state

string

状态;1正常 0禁用

false

delFlag

string

删除标识 1是 0 否

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/expressCompany/admin/update? --data '{
	"createBy": 720,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 502,
	"id": 586,
	"code": "68204",
	"expressName": "智宸.郭",
	"sort": 490,
	"contactsName": "智宸.郭",
	"contactsPhone": "15646845106",
	"state": "cdhza5",
	"delFlag": "ck9gn9"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

8.4. 删除快递公司

URL: http://localhost:10000/cloud-mall/expressCompany/admin/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除快递公司

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/expressCompany/admin/delete --data '[
	324,
	993
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

9. 文件服务

9.1. 文件上传

URL: http://localhost:10000/cloud-mall/file/open/

Type: POST

Content-Type: multipart/form-data

Description: 文件上传接口，文件大小不能超过5M，只支持jpg、jpeg、bmp、png类型的文件

Query-parameters:

Parameter

Type

Description

Required

Since

file

文件内容

true

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -i http://localhost:10000/cloud-mall/file/open/

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": "raonp4"
}

9.2. 删除文件

URL: http://localhost:10000/cloud-mall/file/open/

Type: DELETE

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除文件

Query-parameters:

Parameter

Type

Description

Required

Since

url

string

文件浏览路径

true

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/file/open/?url=www.xn---xn--po3a-p23rv513b.biz

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

10. 商品分类

10.1. 分类树形列表

URL: http://localhost:10000/cloud-mall/goodsCategory/open/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 分类树形列表

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goodsCategory/open/list

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

分类id

└─name

string

分类名称

└─icon

string

分类icon

└─level

int32

层级;不能超过2级

└─pid

int64

父分类id

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─childCategory

array

子分类

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": [
		{
			"id": 713,
			"name": "智宸.郭",
			"icon": "i40td2",
			"level": 283,
			"pid": 992,
			"sort": 627,
			"state": "xn84cx",
			"childCategory": [
				{
					"$ref": ".."
				}
			]
		}
	]
}

10.2. 新增分类

URL: http://localhost:10000/cloud-mall/goodsCategory/admin/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增分类

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，更新时不能为空

false

name

string

分类名称

true

icon

string

分类icon

true

level

int32

层级;不能超过2级

true

pid

int64

父分类id，level为2时不能为空

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goodsCategory/admin/save? --data '{
	"createBy": 140,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 251,
	"id": 953,
	"name": "智宸.郭",
	"icon": "l648yo",
	"level": 410,
	"pid": 973,
	"sort": 49,
	"state": "2g69l9"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

10.3. 修改分类

URL: http://localhost:10000/cloud-mall/goodsCategory/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改分类

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，更新时不能为空

false

name

string

分类名称

true

icon

string

分类icon

true

level

int32

层级;不能超过2级

true

pid

int64

父分类id，level为2时不能为空

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goodsCategory/admin/update? --data '{
	"createBy": 61,
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": 69,
	"id": 774,
	"name": "智宸.郭",
	"icon": "9h28wx",
	"level": 4,
	"pid": 307,
	"sort": 551,
	"state": "lg88f9"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

10.4. 删除分类

URL: http://localhost:10000/cloud-mall/goodsCategory/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除分类

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goodsCategory/delete --data '[
	581,
	915
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

11. 商品评价

11.1. 评论列表

URL: http://localhost:10000/cloud-mall/goodsComment/open/list; http:/localhost:10000/cloud-mall/goodsComment/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: orderField可选值：reviewCnt评分，createTime评价时间

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

orderId

int64

订单id

false

goodsId

int64

商品id

false

skuId

int64

skuId

false

userId

string

用户id

false

hasImg

string

是否有图;1是 2否

false

reviewType

string

评论类别;1差评 2中评 3好评

false

state

string

评论状态，0隐藏 1显示

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goodsComment/open/list?orderId=311&orderField=zj5bm3&pageSize=10&state=tsv43q&userId=97&goodsId=774&hasImg=r8k0jz&order=f66xyx&skuId=aa9d3f6a-4d77-405c-9e02-a44b067d06e2&curPage=1&reviewType=n7k8z7

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─orderId

int64

订单id

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─userId

string

用户id

└─userImg

string

用户头像

└─reviewContent

string

评价内容

└─reviewType

string

评论类别;1差评 2中评 3好评

└─reviewCnt

int32

评论星数;1-5

└─reviewImgs

string

晒图;多张图片使用,分割

└─state

string

状态;0隐藏 1显示

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 802,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 389,
				"orderId": 714,
				"goodsId": 163,
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"userId": "97",
				"userImg": "gyn7ee",
				"reviewContent": "ccxmq5",
				"reviewType": "ve3r8k",
				"reviewCnt": 282,
				"reviewImgs": "4ojep1",
				"state": "i1bu05",
				"createBy": "rqp3oh",
				"createTime": "2023-12-11 08:25:10",
				"updateTime": "2023-12-11 08:25:10",
				"updateBy": "i2z2fn"
			}
		]
	}
}

11.2. 订单评价详情

URL: http://localhost:10000/cloud-mall/goodsComment/open/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单评价详情

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goodsComment/open/info/549

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─orderId

int64

订单id

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─userId

string

用户id

└─userImg

string

用户头像

└─reviewContent

string

评价内容

└─reviewType

string

评论类别;1差评 2中评 3好评

└─reviewCnt

int32

评论星数;1-5

└─reviewImgs

string

晒图;多张图片使用,分割

└─state

string

状态;0隐藏 1显示

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 974,
		"orderId": 69,
		"goodsId": 218,
		"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
		"userId": "97",
		"userImg": "v38x4r",
		"reviewContent": "uxtdag",
		"reviewType": "nev4ty",
		"reviewCnt": 982,
		"reviewImgs": "2wz1og",
		"state": "3pupft",
		"createBy": "fwybfe",
		"createTime": "2023-12-11 08:25:10",
		"updateTime": "2023-12-11 08:25:10",
		"updateBy": "yyz7x5"
	}
}

11.3. 新增订单评论

URL: http://localhost:10000/cloud-mall/goodsComment/user/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增订单评论

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

orderId

int64

订单id

true

goodsId

int64

商品id

true

skuId

int64

skuId

false

userId

string

用户id

false

userImg

string

用户头像

false

reviewContent

string

评价内容

true

reviewType

string

评论类别;1差评 2中评 3好评

true

reviewCnt

int32

评论星数;1-5

true

reviewImgs

string

晒图;多张图片使用,分割

false

state

string

状态;0隐藏 1显示

false

createBy

string

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

string

更新人

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goodsComment/user/save? --data '{
	"id": 409,
	"orderId": 536,
	"goodsId": 929,
	"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
	"userId": "97",
	"userImg": "6w3maz",
	"reviewContent": "3c6m6t",
	"reviewType": "oikdjz",
	"reviewCnt": 275,
	"reviewImgs": "tk4c6x",
	"state": "uundpf",
	"createBy": "0xreqp",
	"createTime": "2023-12-11 08:25:10",
	"updateTime": "2023-12-11 08:25:10",
	"updateBy": "apf7h1"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

11.4. 修改订单评论状态

URL: http://localhost:10000/cloud-mall/goodsComment/admin/{commentId}/{state}

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改订单评论状态

Path-parameters:

Parameter

Type

Description

Required

Since

commentId

int64

评论id

true

state

string

1显示，其他隐藏

true

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/goodsComment/admin/199/52cx6t

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

11.5. 删除订单评价

URL: http://localhost:10000/cloud-mall/goodsComment/admin/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除订单评价

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goodsComment/admin/delete --data '[
	223,
	938
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12. 商品

12.1. 商品列表（app端）

URL: http://localhost:10000/cloud-mall/goods/open/page

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 提供商品按分类、关键字等分页检索功能。orderField可用值：collectCnt收藏量、saleCnt 销量、price 价格，

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

goodsName

string

商品名称，模糊搜索

false

state

string

商品状态 0下架 1在售 2 待审核

false

categoryId

int64

商品类别id，精确搜索

false

hot

string

是否热门推荐;0否1是

false

limited

string

是否限时精选;0否1是

false

categoryLevel

int32

商品类别等级，商品类别id存在时不能为空

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goods/open/page?hot=fn9ux6&categoryId=652&pageSize=10&limited=wxoveb&categoryLevel=808&order=8i8c02&orderField=ulbnd0&curPage=1&goodsName=智宸.郭&state=ec183b

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

商品id

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─imgs

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─limit

int32

限购数量

└─stockNum

int32

库存数量

└─collectCnt

int32

收藏量

└─saleCnt

int32

已售量

└─visitCnt

int32

浏览量

└─shareCnt

int32

分享量

└─showCollect

string

是否显示收藏数量;0隐藏 1显示

└─showSale

string

是否显示已售数量;0隐藏 1显示

└─showVisit

string

是否显示访问数量;0隐藏 1显示

└─showShare

string

是否显示分享数量;0隐藏 1显示

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 807,
		"name": "智宸.郭",
		"state": "e9iihf",
		"imgs": "8cw4vq",
		"price": 398,
		"marketPrice": 943,
		"limit": 10,
		"stockNum": 323,
		"collectCnt": 526,
		"saleCnt": 563,
		"visitCnt": 103,
		"shareCnt": 169,
		"showCollect": "fvfsbn",
		"showSale": "uh7r5f",
		"showVisit": "n2acq3",
		"showShare": "q7c8g4"
	}
}

12.2. 商品详情（app端）

URL: http://localhost:10000/cloud-mall/goods/open/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 商品详情（app端）

Path-parameters:

Parameter

Type

Description

Required

Since

int64

商品id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goods/open/675

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

商品id

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─imgs

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─limit

int32

限购数量

└─stockNum

int32

库存数量

└─collectCnt

int32

收藏量

└─saleCnt

int32

已售量

└─visitCnt

int32

浏览量

└─shareCnt

int32

分享量

└─showCollect

string

是否显示收藏数量;0隐藏 1显示

└─showSale

string

是否显示已售数量;0隐藏 1显示

└─showVisit

string

是否显示访问数量;0隐藏 1显示

└─showShare

string

是否显示分享数量;0隐藏 1显示

└─desc

string

商品详情

└─goodsServiceTags

array

服务标签

└─id

int64

标签id

└─tagName

string

标签名称

└─tagDesc

string

标签描述

└─enableSku

string

是否开启sku;1是0否

└─skuGroups

array

sku分组列表使用分组属性交集确定skuId

└─attrName

string

属性名称

└─attrValues

array

属性值列表

└─attrValue

string

属性值

└─skuIds

string

具有该属性值的skuId集合 skuId直接使用,分割

└─skus

array

sku信息列表

└─skuId

int64

商品skuId

└─goodsId

int64

商品id

└─skuName

string

sku名称

└─skuDesc

string

sku介绍描述

└─skuImg

string

sku图片

└─price

number

销售价格

└─marketPrice

number

市场价格

└─stockNum

int32

库存数量

└─state

string

状态;0不可售 1可售

└─saleAttrs

array

销售属性

└─attrId

int64

└─goodSkuId

int64

商品skuId

└─attrName

string

销售属性名

└─attrValue

string

销售属性值

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 679,
		"name": "智宸.郭",
		"state": "dv71u4",
		"imgs": "cuf1wi",
		"price": 598,
		"marketPrice": 756,
		"limit": 10,
		"stockNum": 635,
		"collectCnt": 593,
		"saleCnt": 766,
		"visitCnt": 776,
		"shareCnt": 434,
		"showCollect": "cntqq8",
		"showSale": "zm7i5r",
		"showVisit": "ktyuud",
		"showShare": "fq3c73",
		"desc": "rmdp37",
		"goodsServiceTags": [
			{
				"id": 53,
				"tagName": "智宸.郭",
				"tagDesc": "q205dl"
			}
		],
		"enableSku": "isztke",
		"skuGroups": [
			{
				"attrName": "智宸.郭",
				"attrValues": [
					{
						"attrValue": "v1fz5j",
						"skuIds": "aa9d3f6a-4d77-405c-9e02-a44b067d06e2"
					}
				]
			}
		],
		"skus": [
			{
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"goodsId": 887,
				"skuName": "智宸.郭",
				"skuDesc": "86tk88",
				"skuImg": "w1o272",
				"price": 915,
				"marketPrice": 230,
				"stockNum": 248,
				"state": "jhlzpv",
				"saleAttrs": [
					{
						"attrId": 498,
						"goodSkuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
						"attrName": "智宸.郭",
						"attrValue": "6twptk"
					}
				]
			}
		]
	}
}

12.3. 商品列表（管理端）

URL: http://localhost:10000/cloud-mall/goods/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 商品列表（管理端）

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

goodsName

string

商品名称，模糊搜索

false

state

string

商品状态 0下架 1在售 2 待审核

false

categoryId

int64

商品类别id，精确搜索

false

hot

string

是否热门推荐;0否1是

false

limited

string

是否限时精选;0否1是

false

categoryLevel

int32

商品类别等级，商品类别id存在时不能为空

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goods/admin/list?state=8avatj&order=9d6yi8&categoryLevel=766&orderField=oisaaj&curPage=1&hot=1nub1h&goodsName=智宸.郭&limited=5ghkzy&pageSize=10&categoryId=724

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

商品id

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─imgs

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─limit

int32

限购数量

└─stockNum

int32

库存数量

└─collectCnt

int32

收藏量

└─saleCnt

int32

已售量

└─visitCnt

int32

浏览量

└─shareCnt

int32

分享量

└─showCollect

string

是否显示收藏数量;0隐藏 1显示

└─showSale

string

是否显示已售数量;0隐藏 1显示

└─showVisit

string

是否显示访问数量;0隐藏 1显示

└─showShare

string

是否显示分享数量;0隐藏 1显示

└─hot

string

是否热门推荐;0否1是

└─limited

string

是否限时精选;0否1是

└─sort

int32

排序

└─goodsServiceTags

array

服务标签

└─id

int64

标签id

└─tagName

string

标签名称

└─tagDesc

string

标签描述

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 392,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 642,
				"name": "智宸.郭",
				"state": "mlknu4",
				"imgs": "2lvxrk",
				"price": 484,
				"marketPrice": 738,
				"limit": 10,
				"stockNum": 404,
				"collectCnt": 194,
				"saleCnt": 529,
				"visitCnt": 466,
				"shareCnt": 366,
				"showCollect": "12gxid",
				"showSale": "8by7cb",
				"showVisit": "qzo6z2",
				"showShare": "snecf6",
				"hot": "uqbhgo",
				"limited": "4grdb4",
				"sort": 573,
				"goodsServiceTags": [
					{
						"id": 426,
						"tagName": "智宸.郭",
						"tagDesc": "pdsr50"
					}
				]
			}
		]
	}
}

12.4. 修改商品排序

URL: http://localhost:10000/cloud-mall/goods/admin/sort/{id}

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改商品排序

Path-parameters:

Parameter

Type

Description

Required

Since

int64

商品id

true

Query-parameters:

Parameter

Type

Description

Required

Since

sort

int32

新排序，不能小于0

true

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/goods/admin/sort/254 --data 'sort=0'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.5. 商品热门/精选状态修改

URL: http://localhost:10000/cloud-mall/goods/admin/hot-limited-change

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 商品热门/精选状态修改

Body-parameters:

Parameter

Type

Description

Required

Since

action

string

操作种类：1热门推荐、2限时精选

true

goodIds

array

商品id集合

true

type

string

操作类型：1新增、2取消

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goods/admin/hot-limited-change? --data '{
	"action": "qm3vzf",
	"goodIds": [
		370
	],
	"type": "wuzq8x"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.6. 商品详情（管理员端）

URL: http://localhost:10000/cloud-mall/goods/admin/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 商品详情（管理员端）

Path-parameters:

Parameter

Type

Description

Required

Since

int64

商品id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goods/admin/info/54

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

商品id

└─name

string

商品名称

└─state

string

商品状态;0下架 1在售 2 待审核

└─imgs

string

商品图片地址;多张图片使用,分割

└─price

number

销售价格

└─marketPrice

number

市场价格

└─limit

int32

限购数量

└─stockNum

int32

库存数量

└─collectCnt

int32

收藏量

└─saleCnt

int32

已售量

└─visitCnt

int32

浏览量

└─shareCnt

int32

分享量

└─showCollect

string

是否显示收藏数量;0隐藏 1显示

└─showSale

string

是否显示已售数量;0隐藏 1显示

└─showVisit

string

是否显示访问数量;0隐藏 1显示

└─showShare

string

是否显示分享数量;0隐藏 1显示

└─categoryOneId

int64

一级分类id

└─categoryTwoId

int64

二级分类id

└─brandId

int64

品牌id

└─sort

int32

排序

└─enableSku

string

是否开启sku;开启sku后使用sku价格

└─hot

string

是否热门推荐;0否1是

└─limited

string

是否限时精选;0否1是

└─desc

string

商品详情

└─goodsServiceTags

array

服务标签

└─id

int64

标签id

└─tagName

string

标签名称

└─tagDesc

string

标签描述

└─skuGroups

array

sku分组列表使用分组属性交集确定skuId

└─attrName

string

属性名称

└─attrValues

array

属性值列表

└─attrValue

string

属性值

└─skuIds

string

具有该属性值的skuId集合 skuId直接使用,分割

└─skus

array

sku信息列表

└─skuId

int64

商品skuId

└─goodsId

int64

商品id

└─skuName

string

sku名称

└─skuDesc

string

sku介绍描述

└─skuImg

string

sku图片

└─price

number

销售价格

└─marketPrice

number

市场价格

└─stockNum

int32

库存数量

└─state

string

状态;0不可售 1可售

└─saleAttrs

array

销售属性

└─attrId

int64

└─goodSkuId

int64

商品skuId

└─attrName

string

销售属性名

└─attrValue

string

销售属性值

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 728,
		"name": "智宸.郭",
		"state": "fejv2x",
		"imgs": "o6064g",
		"price": 435,
		"marketPrice": 428,
		"limit": 10,
		"stockNum": 198,
		"collectCnt": 540,
		"saleCnt": 85,
		"visitCnt": 869,
		"shareCnt": 3,
		"showCollect": "uc9qzc",
		"showSale": "meq7x2",
		"showVisit": "v15dlo",
		"showShare": "12n47v",
		"categoryOneId": 114,
		"categoryTwoId": 468,
		"brandId": 822,
		"sort": 101,
		"enableSku": "qyzev2",
		"hot": "yu5giq",
		"limited": "pxdvrp",
		"desc": "nj8rat",
		"goodsServiceTags": [
			{
				"id": 870,
				"tagName": "智宸.郭",
				"tagDesc": "6cwuib"
			}
		],
		"skuGroups": [
			{
				"attrName": "智宸.郭",
				"attrValues": [
					{
						"attrValue": "c34gvg",
						"skuIds": "aa9d3f6a-4d77-405c-9e02-a44b067d06e2"
					}
				]
			}
		],
		"skus": [
			{
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"goodsId": 654,
				"skuName": "智宸.郭",
				"skuDesc": "lllhcu",
				"skuImg": "nsahtb",
				"price": 909,
				"marketPrice": 524,
				"stockNum": 834,
				"state": "xxywi8",
				"saleAttrs": [
					{
						"attrId": 161,
						"goodSkuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
						"attrName": "智宸.郭",
						"attrValue": "7kyf4i"
					}
				]
			}
		]
	}
}

12.7. 新增商品

URL: http://localhost:10000/cloud-mall/goods/admin/add

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增商品

Body-parameters:

Parameter

Type

Description

Required

Since

int64

商品id，修改时不能为空

false

categoryOneId

int64

一级分类id

true

categoryTwoId

int64

二级分类id

true

name

string

商品名称

true

sort

int32

排序

true

hot

string

是否热门推荐;0否1是

true

limited

string

是否限时精选;0否1是

true

state

string

商品状态;0下架 1在售 2 待审核

true

imgs

string

商品图片地址，第一张图片为商品主图;多张图片使用,分割

true

price

number

销售价格

true

marketPrice

number

市场价格

true

limit

int32

限购数量,0为不限购

true

stockNum

int32

库存数量

true

collectCnt

int32

收藏量

true

saleCnt

int32

已售量

true

visitCnt

int32

浏览量

true

shareCnt

int32

分享量

true

showCollect

string

是否显示收藏数量;0隐藏 1显示

true

showSale

string

是否显示已售数量;0隐藏 1显示

true

showVisit

string

是否显示访问数量;0隐藏 1显示

true

showShare

string

是否显示分享数量;0隐藏 1显示

true

desc

string

商品详情

true

serviceTagIds

array

服务标签id集合

false

enableSku

string

是否开启sku;1是0否

true

skus

array

sku集合，开启sku后该值不能为空

false

└─skuId

int64

skuId，修改时不能为空

false

└─skuName

string

sku名称销售属性值使用 + 拼接

true

└─skuDesc

string

sku描述

false

└─skuImg

string

sku图片

true

└─price

number

销售价格

true

└─marketPrice

number

市场价格

true

└─stockNum

int64

库存

true

└─state

string

状态;0不可售 1可售

true

└─saleAttrs

array

销售属性

true

└─attrId

int64

属性id，修改时不能为空

false

└─skuId

int64

skuId

false

└─attrName

string

属性名称

true

└─attrValue

string

属性值

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goods/admin/add? --data '{
	"id": 166,
	"categoryOneId": 183,
	"categoryTwoId": 408,
	"name": "智宸.郭",
	"sort": 892,
	"hot": "pqk089",
	"limited": "thyhax",
	"state": "h4uwfh",
	"imgs": "65htzh",
	"price": 577,
	"marketPrice": 21,
	"limit": 10,
	"stockNum": 822,
	"collectCnt": 48,
	"saleCnt": 831,
	"visitCnt": 30,
	"shareCnt": 513,
	"showCollect": "swj1r2",
	"showSale": "aubtvr",
	"showVisit": "43bc0f",
	"showShare": "a248sq",
	"desc": "0ricfk",
	"serviceTagIds": [
		658
	],
	"enableSku": "qkyr1u",
	"skus": [
		{
			"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
			"skuName": "智宸.郭",
			"skuDesc": "4cqbjl",
			"skuImg": "s810dp",
			"price": 826,
			"marketPrice": 928,
			"stockNum": 733,
			"state": "tptxvt",
			"saleAttrs": [
				{
					"attrId": 917,
					"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
					"attrName": "智宸.郭",
					"attrValue": "qcqv3a"
				}
			]
		}
	]
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.8. 修改商品

URL: http://localhost:10000/cloud-mall/goods/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改商品

Body-parameters:

Parameter

Type

Description

Required

Since

int64

商品id，修改时不能为空

false

categoryOneId

int64

一级分类id

true

categoryTwoId

int64

二级分类id

true

name

string

商品名称

true

sort

int32

排序

true

hot

string

是否热门推荐;0否1是

true

limited

string

是否限时精选;0否1是

true

state

string

商品状态;0下架 1在售 2 待审核

true

imgs

string

商品图片地址，第一张图片为商品主图;多张图片使用,分割

true

price

number

销售价格

true

marketPrice

number

市场价格

true

limit

int32

限购数量,0为不限购

true

stockNum

int32

库存数量

true

collectCnt

int32

收藏量

true

saleCnt

int32

已售量

true

visitCnt

int32

浏览量

true

shareCnt

int32

分享量

true

showCollect

string

是否显示收藏数量;0隐藏 1显示

true

showSale

string

是否显示已售数量;0隐藏 1显示

true

showVisit

string

是否显示访问数量;0隐藏 1显示

true

showShare

string

是否显示分享数量;0隐藏 1显示

true

desc

string

商品详情

true

serviceTagIds

array

服务标签id集合

false

enableSku

string

是否开启sku;1是0否

true

skus

array

sku集合，开启sku后该值不能为空

false

└─skuId

int64

skuId，修改时不能为空

false

└─skuName

string

sku名称销售属性值使用 + 拼接

true

└─skuDesc

string

sku描述

false

└─skuImg

string

sku图片

true

└─price

number

销售价格

true

└─marketPrice

number

市场价格

true

└─stockNum

int64

库存

true

└─state

string

状态;0不可售 1可售

true

└─saleAttrs

array

销售属性

true

└─attrId

int64

属性id，修改时不能为空

false

└─skuId

int64

skuId

false

└─attrName

string

属性名称

true

└─attrValue

string

属性值

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goods/admin/update? --data '{
	"id": 97,
	"categoryOneId": 180,
	"categoryTwoId": 994,
	"name": "智宸.郭",
	"sort": 823,
	"hot": "cb18nb",
	"limited": "9kttd4",
	"state": "w25szu",
	"imgs": "v8cw6c",
	"price": 579,
	"marketPrice": 38,
	"limit": 10,
	"stockNum": 647,
	"collectCnt": 792,
	"saleCnt": 290,
	"visitCnt": 429,
	"shareCnt": 596,
	"showCollect": "9t5k22",
	"showSale": "s1j39l",
	"showVisit": "cnc098",
	"showShare": "ya1j39",
	"desc": "54qbme",
	"serviceTagIds": [
		554
	],
	"enableSku": "rhegr1",
	"skus": [
		{
			"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
			"skuName": "智宸.郭",
			"skuDesc": "f2crlz",
			"skuImg": "uhuhjp",
			"price": 193,
			"marketPrice": 499,
			"stockNum": 953,
			"state": "pr1x93",
			"saleAttrs": [
				{
					"attrId": 707,
					"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
					"attrName": "智宸.郭",
					"attrValue": "lly5h5"
				}
			]
		}
	]
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.9. 商品下架

URL: http://localhost:10000/cloud-mall/goods/admin/off

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 商品下架

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

商品id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goods/admin/off --data '[
	537,
	375
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.10. 商品上架

URL: http://localhost:10000/cloud-mall/goods/admin/online

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 商品上架

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

商品id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/goods/admin/online --data '[
	262,
	857
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

12.11. 商品浏览量+1

URL: http://localhost:10000/cloud-mall/goods/open/share-increase/{goodsId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 商品浏览量+1

Path-parameters:

Parameter

Type

Description

Required

Since

goodsId

string

No comments found.

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/goods/open/share-increase/97

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

13. 导航（金刚区）

13.1. 导航列表

URL: http://localhost:10000/cloud-mall/navigation/open/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导航列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/navigation/open/list?curPage=1&pageSize=10&orderField=x3n74h&order=ntwk54

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，修改时不能为空

└─name

string

类别名称

└─iconName

string

图标地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

类别;0不跳转 1跳转页面 2跳转网页

└─url

string

跳转地址;type不为0时不能为空

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 726,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 10,
				"createTime": "2023-12-11 08:25:11",
				"updateTime": "2023-12-11 08:25:11",
				"updateBy": 684,
				"id": 968,
				"name": "智宸.郭",
				"iconName": "智宸.郭",
				"remark": "eloikg",
				"sort": 385,
				"state": "wzx2lr",
				"type": "mo2vrp",
				"url": "www.xn---xn--po3a-p23rv513b.biz"
			}
		]
	}
}

13.2. 导航详情

URL: http://localhost:10000/cloud-mall/navigation/admin/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导航详情

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/navigation/admin/info/555

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，修改时不能为空

└─name

string

类别名称

└─iconName

string

图标地址

└─remark

string

备注

└─sort

int32

排序

└─state

string

状态;0禁用 1启用

└─type

string

类别;0不跳转 1跳转页面 2跳转网页

└─url

string

跳转地址;type不为0时不能为空

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 932,
		"createTime": "2023-12-11 08:25:11",
		"updateTime": "2023-12-11 08:25:11",
		"updateBy": 591,
		"id": 221,
		"name": "智宸.郭",
		"iconName": "智宸.郭",
		"remark": "g6myex",
		"sort": 651,
		"state": "w8e05h",
		"type": "6rxgp2",
		"url": "www.xn---xn--po3a-p23rv513b.biz"
	}
}

13.3. 新增导航

URL: http://localhost:10000/cloud-mall/navigation/admin/add

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增导航

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

name

string

类别名称

true

iconName

string

图标地址

true

remark

string

备注

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

false

type

string

类别;0不跳转 1跳转页面 2跳转网页

true

url

string

跳转地址;type不为0时不能为空

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/navigation/admin/add? --data '{
	"createBy": 782,
	"createTime": "2023-12-11 08:25:11",
	"updateTime": "2023-12-11 08:25:11",
	"updateBy": 317,
	"id": 670,
	"name": "智宸.郭",
	"iconName": "智宸.郭",
	"remark": "2o827e",
	"sort": 818,
	"state": "6pkc4o",
	"type": "d6qlaj",
	"url": "www.xn---xn--po3a-p23rv513b.biz"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

13.4. 修改导航

URL: http://localhost:10000/cloud-mall/navigation/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改导航

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，修改时不能为空

false

name

string

类别名称

true

iconName

string

图标地址

true

remark

string

备注

false

sort

int32

排序

true

state

string

状态;0禁用 1启用

false

type

string

类别;0不跳转 1跳转页面 2跳转网页

true

url

string

跳转地址;type不为0时不能为空

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/navigation/admin/update? --data '{
	"createBy": 581,
	"createTime": "2023-12-11 08:25:11",
	"updateTime": "2023-12-11 08:25:11",
	"updateBy": 37,
	"id": 604,
	"name": "智宸.郭",
	"iconName": "智宸.郭",
	"remark": "c7q3c7",
	"sort": 852,
	"state": "7s687m",
	"type": "w38g7x",
	"url": "www.xn---xn--po3a-p23rv513b.biz"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

13.5. 删除导航

URL: http://localhost:10000/cloud-mall/navigation/admin/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除导航

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/navigation/admin/delete --data '[
	583,
	299
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

14. 订单收货人信息

14.1. 查看订单收货信息

URL: http://localhost:10000/cloud-mall/orderConsignee/admin/info/{orderId}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查看订单收货信息

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/orderConsignee/admin/info/327

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─orderId

int64

订单id

└─orderConsignee

string

收货人姓名

└─orderConsigneeTel

string

收货人电话

└─orderConsigneeProvince

string

收货人省

└─orderConsigneeCity

string

收货人市

└─orderConsigneeDistrict

string

收货人区县

└─orderConsigneeAddrDetail

string

收货人详细地址

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 646,
		"orderId": 964,
		"orderConsignee": "aoor3o",
		"orderConsigneeTel": "62w8sl",
		"orderConsigneeProvince": "keb20b",
		"orderConsigneeCity": "su2oys",
		"orderConsigneeDistrict": "leht2s",
		"orderConsigneeAddrDetail": "qt4vp7"
	}
}

14.2. 修改订单收货信息

URL: http://localhost:10000/cloud-mall/orderConsignee/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改订单收货信息

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

orderId

int64

订单id

false

orderConsignee

string

收货人姓名

false

orderConsigneeTel

string

收货人电话

false

orderConsigneeProvince

string

收货人省

false

orderConsigneeCity

string

收货人市

false

orderConsigneeDistrict

string

收货人区县

false

orderConsigneeAddrDetail

string

收货人详细地址

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/orderConsignee/admin/update? --data '{
	"id": 769,
	"orderId": 586,
	"orderConsignee": "fcg0z1",
	"orderConsigneeTel": "b1vva6",
	"orderConsigneeProvince": "9h9myp",
	"orderConsigneeCity": "djo87f",
	"orderConsigneeDistrict": "cwstod",
	"orderConsigneeAddrDetail": "593so4"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

15. 订单

15.1. 确认订单

URL: http://localhost:10000/cloud-mall/order/user/order/confirm

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 确认订单

Body-parameters:

Parameter

Type

Description

Required

Since

type

string

类型 1直接购买订单确认、2购物创建订单确认

true

goodId

int64

商品id type为1时该值不能为空

false

skuId

int64

skuId type为1且商品开启sku时该值不能为空

false

num

int32

购买数量 type为1时该值不能为空

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/order/user/order/confirm? --data '{
	"type": "centad",
	"goodId": 538,
	"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
	"num": 968
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─address

object

地址信息

└─id

int64

└─userId

string

用户id

└─receiverName

string

收件人名字

└─phoneNum

string

手机号

└─province

string

省

└─city

string

市

└─county

string

区县

└─address

string

地址详情

└─defaultFlag

string

是否默认;0否 1是

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

└─orderDetails

array

商品信息列表

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─goodsName

string

商品名称

└─goodsMasterImg

string

商品图片

└─goodsAttr

string

商品属性

└─goodsCount

int32

购买数量

└─goodsActualPrice

number

商品购买价格

└─goodsTotalAmt

number

商品价格小计

└─token

object

防重令牌

└─token

string

token

└─ttl

int64

过期时间

└─orderAmount

number

订单总金额

└─deliveryFee

number

快递费

└─discountAmount

number

优惠价格

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"address": {
			"id": 507,
			"userId": "97",
			"receiverName": "智宸.郭",
			"phoneNum": "qlb12u",
			"province": "da3igu",
			"city": "69389p",
			"county": "3ulibj",
			"address": "Apt. 167 曹桥22661号， 曲靖， 港 742970",
			"defaultFlag": "xrzabf",
			"createBy": "gblmk3",
			"createTime": "2023-12-11 08:25:11",
			"updateTime": "2023-12-11 08:25:11",
			"updateBy": "kmz0lh"
		},
		"orderDetails": [
			{
				"goodsId": 851,
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"goodsName": "智宸.郭",
				"goodsMasterImg": "6fnm99",
				"goodsAttr": "xxg4d5",
				"goodsCount": 269,
				"goodsActualPrice": 244,
				"goodsTotalAmt": 448
			}
		],
		"token": {
			"token": "vfsctj",
			"ttl": 573
		},
		"orderAmount": 852,
		"deliveryFee": 357,
		"discountAmount": 989
	}
}

15.2. 提交订单

URL: http://localhost:10000/cloud-mall/order/user/order/submit

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 提交订单

Body-parameters:

Parameter

Type

Description

Required

Since

submitToken

string

提交令牌（防重提交）

true

userAddressId

int64

用户地址id

true

buyerRemark

string

买家备注

false

orderPaidAmt

number

订单实际付款金额用于价格校验

true

submitType

string

提交类型 1直接创建订单、2购物车创建订单

true

orderFrom

string

订单来源;1小程序 2公众号 3其它

true

orderDetails

array

商品列表

true

└─goodsId

int64

商品id

false

└─skuId

int64

skuId 商品开启sku后该值不能为空

false

└─goodsCount

int32

商品数量

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/order/user/order/submit? --data '{
	"submitToken": "5uo0pi",
	"userAddressId": 935,
	"buyerRemark": "4399yi",
	"orderPaidAmt": 45,
	"submitType": "jl6x86",
	"orderFrom": "h12m3e",
	"orderDetails": [
		{
			"goodsId": 870,
			"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
			"goodsCount": 864
		}
	]
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─orderAmount

number

订单金额

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"orderId": 929,
		"orderAmount": 779
	}
}

15.3. 订单列表（app端）

URL: http://localhost:10000/cloud-mall/order/user/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单列表（app端）,orderState可选值：1等待付款、2等待发货、3等待收货、4等待评论、5完成、7全部

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

orderState

string

订单状态，默认为7

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/user/list?curPage=1&order=ljhiqs&orderField=8ly0a6&pageSize=10&orderState=7

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─orderId

int64

订单id

└─totalPrice

number

订单总价

└─state

string

订单状态;1等待付款、2等待发货、3等待收货、4等待评论、5完成、6取消、0售后

└─createTime

string

下单时间

└─orderDetails

array

订单商品详情列表

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─goodsName

string

商品名称

└─goodsMasterImg

string

商品图片

└─goodsAttr

string

商品属性

└─goodsCount

int32

购买数量

└─goodsActualPrice

number

商品购买价格

└─goodsTotalAmt

number

商品价格小计

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 554,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"orderId": 651,
				"totalPrice": 719,
				"state": "ows8zp",
				"createTime": "2023-12-11 08:25:11",
				"orderDetails": [
					{
						"goodsId": 289,
						"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
						"goodsName": "智宸.郭",
						"goodsMasterImg": "n1r8ld",
						"goodsAttr": "8wf5uo",
						"goodsCount": 862,
						"goodsActualPrice": 654,
						"goodsTotalAmt": 382
					}
				]
			}
		]
	}
}

15.4. 订单详情

URL: http://localhost:10000/cloud-mall/order/user/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户端订单详情

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/user/info/758

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─orderNo

string

订单号

└─orderActualPrice

number

订单实际付款金额

└─orderPrice

number

订单价格

└─state

string

订单状态;1等待付款、2等待发货、3等待收货、4等待评论、5完成、6取消、0售后

└─createTime

string

下单时间

└─updateTime

string

订单最后更新时间

└─payWay

string

支付方式 1 微信支付 2余额支付 3支付宝 4网银 5其他

└─payNo

string

支付编号

└─orderConsignee

string

收货人姓名

└─orderConsigneeTel

string

收货人电话

└─orderConsigneeProvince

string

收货人省

└─orderConsigneeCity

string

收货人市

└─orderConsigneeDistrict

string

收货人区县

└─orderConsigneeAddrDetail

string

收货人详细地址

└─orderDetails

array

订单商品详情列表

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─goodsName

string

商品名称

└─goodsMasterImg

string

商品图片

└─goodsAttr

string

商品属性

└─goodsCount

int32

购买数量

└─goodsActualPrice

number

商品购买价格

└─goodsTotalAmt

number

商品价格小计

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"orderId": 275,
		"orderNo": "hk952u",
		"orderActualPrice": 183,
		"orderPrice": 36,
		"state": "oeyn5j",
		"createTime": "2023-12-11 08:25:11",
		"updateTime": "2023-12-11 08:25:11",
		"payWay": "3z7mh4",
		"payNo": "g5snyh",
		"orderConsignee": "0g9e7b",
		"orderConsigneeTel": "93w1d5",
		"orderConsigneeProvince": "k9qk02",
		"orderConsigneeCity": "c1e9z0",
		"orderConsigneeDistrict": "n52n0v",
		"orderConsigneeAddrDetail": "i4ottj",
		"orderDetails": [
			{
				"goodsId": 587,
				"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
				"goodsName": "智宸.郭",
				"goodsMasterImg": "je35ga",
				"goodsAttr": "2xbdx1",
				"goodsCount": 96,
				"goodsActualPrice": 921,
				"goodsTotalAmt": 969
			}
		]
	}
}

15.5. 取消订单

URL: http://localhost:10000/cloud-mall/order/user/cancel/{id}

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户端取消订单，注意订单支付后不可取消

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/order/user/cancel/739

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

15.6. 确认收货

URL: http://localhost:10000/cloud-mall/order/user/receipt/{id}

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户确认收货

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X PUT -i http://localhost:10000/cloud-mall/order/user/receipt/15

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

15.7. 申请退款

URL: http://localhost:10000/cloud-mall/order/user/apply/refund/{id}

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 用户申请退款，只有待发货状态的订单才能申请退款

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Body-parameters:

Parameter

Type

Description

Required

Since

goodsState

string

货物状态

true

refundReason

string

退款原因

true

refundAmt

number

退款金额

true

remark

string

退款说明

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/order/user/apply/refund/74? --data '{
	"goodsState": "1jit8t",
	"refundReason": "thf0s8",
	"refundAmt": 217,
	"remark": "msa7m6"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

15.8. 删除订单

URL: http://localhost:10000/cloud-mall/order/user/delete/{id}

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户端删除订单，注意订单在取消状态下才能被删除

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/order/user/delete/191

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

15.9. 订单列表（管理端）

URL: http://localhost:10000/cloud-mall/order/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单列表（管理端）

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

state

string

状态，精确搜索 1等待付款、2等待发货、3等待收货、4等待评论、5完成、7全部

false

orderNo

string

订单号，模糊搜索

false

userName

string

下单人姓名，模糊搜索

false

userPhone

string

下单人手机号，精确搜索

false

orderConsignee

string

收货人姓名，模糊搜索

false

orderConsigneeTel

string

收货人手机号，精确搜索

false

payWay

string

支付方式 1 微信支付 2余额支付 3支付宝 4网银 5其他

false

startTime

string

下单时间-开始 yyyy-MM-dd

false

endTime

string

下单时间-结束

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/admin/list?state=8wxoqr&userName=智宸.郭&endTime=2023-12-11&payWay=xifj0n&orderNo=4n1rz0&startTime=2023-12-11&orderConsignee=dhohzs&order=xucyki&orderConsigneeTel=3t3xwd&userPhone=15646845106&curPage=1&pageSize=10&orderField=f41to0

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

订单id

└─orderNo

string

订单编号

└─orderPrice

number

订单价格

└─orderActualPrice

number

订单实际付款金额

└─orderFrom

string

订单来源;1小程序 2公众号 3其它

└─orderGoodsCnt

int32

商品数量

└─payWay

string

支付方式 1 微信支付 2余额支付 3支付宝 4网银 5其他

└─state

string

订单状态;1等待付款、2等待发货、3等待收货、4等待评论、5完成、6取消、0售后

└─updateTime

string

订单更新时间（最新操作时间）

└─username

string

下单用户名

└─avatar

string

下单用户头像地址

└─mobile

string

下单用户手机号码

└─orderConsignee

string

收货人姓名

└─orderConsigneeTel

string

收货人电话

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 766,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 579,
				"orderNo": "mkyop6",
				"orderPrice": 838,
				"orderActualPrice": 693,
				"orderFrom": "flywwy",
				"orderGoodsCnt": 640,
				"payWay": "f6zu3u",
				"state": "gvi6d5",
				"updateTime": "2023-12-11 08:25:11",
				"username": "智宸.郭",
				"avatar": "ggyan8",
				"mobile": "15205178218",
				"orderConsignee": "291alz",
				"orderConsigneeTel": "bjd4zi"
			}
		]
	}
}

15.10. 订单详情（管理端）

URL: http://localhost:10000/cloud-mall/order/admin/info/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单详情（管理端）

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/admin/info/211

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

订单id

└─orderNo

string

订单编号

└─orderPrice

number

订单价格

└─orderActualPrice

number

订单实际付款金额

└─orderFrom

string

订单来源;1小程序 2公众号 3其它

└─orderGoodsCnt

int32

商品数量

└─payWay

string

支付方式 1 微信支付 2余额支付 3支付宝 4网银 5其他

└─state

string

订单状态;1等待付款、2等待发货、3等待收货、4等待评论、5完成、6取消、0售后

└─remark

string

订单备注

└─createTime

string

下单时间

└─username

string

下单用户名

└─avatar

string

下单用户头像地址

└─mobile

string

下单用户手机号码

└─orderConsignee

string

收货人姓名

└─orderConsigneeTel

string

收货人电话

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 213,
		"orderNo": "vn1l8v",
		"orderPrice": 520,
		"orderActualPrice": 671,
		"orderFrom": "ewseww",
		"orderGoodsCnt": 537,
		"payWay": "c75qqa",
		"state": "w2olmi",
		"remark": "eploha",
		"createTime": "2023-12-11 08:25:11",
		"username": "智宸.郭",
		"avatar": "73bt8t",
		"mobile": "15205178218",
		"orderConsignee": "j2qzdp",
		"orderConsigneeTel": "w7ks3d"
	}
}

15.11. 订单统计

URL: http://localhost:10000/cloud-mall/order/admin/order-statistics

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查询指定范围时间内订指定状态的所有订单总金额。state可选值：2等待发货、3等待收货、4等待评论、5完成，如果不传，则查询所有状态为2、3、4、5的所有订单总金额

Query-parameters:

Parameter

Type

Description

Required

Since

state

string

订单状态详情查看接口注释

false

startTime

string

下单时间-开始 yyyy-MM-dd

false

endTime

string

下单时间-结束

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/admin/order-statistics?state=s11usq&endTime=2023-12-11&startTime=2023-12-11

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─startTime

string

下单时间-开始 yyyy-MM-dd

└─endTime

string

下单时间-结束

└─totalAmount

number

总金额

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"startTime": "2023-12-11",
		"endTime": "2023-12-11",
		"totalAmount": 847
	}
}

15.12. 订单改价（管理端）

URL: http://localhost:10000/cloud-mall/order/admin/modify-price

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 只有待付款状态下的订单才能改价

Body-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

newPrice

number

新价格

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/order/admin/modify-price? --data '{
	"orderId": 532,
	"newPrice": 420
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

订单id

└─orderNo

string

订单编号

└─orderPrice

number

订单价格

└─orderActualPrice

number

订单实际付款金额

└─orderFrom

string

订单来源;1小程序 2公众号 3其它

└─orderGoodsCnt

int32

商品数量

└─payWay

string

支付方式 1 微信支付 2余额支付 3支付宝 4网银 5其他

└─state

string

订单状态;1等待付款、2等待发货、3等待收货、4等待评论、5完成、6取消、0售后

└─remark

string

订单备注

└─createTime

string

下单时间

└─username

string

下单用户名

└─avatar

string

下单用户头像地址

└─mobile

string

下单用户手机号码

└─orderConsignee

string

收货人姓名

└─orderConsigneeTel

string

收货人电话

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 571,
		"orderNo": "coi5q2",
		"orderPrice": 309,
		"orderActualPrice": 356,
		"orderFrom": "9jm1ly",
		"orderGoodsCnt": 490,
		"payWay": "coe27v",
		"state": "4q7bp1",
		"remark": "i25lgo",
		"createTime": "2023-12-11 08:25:11",
		"username": "智宸.郭",
		"avatar": "6ircj6",
		"mobile": "15205178218",
		"orderConsignee": "9vwhql",
		"orderConsigneeTel": "rrpvll"
	}
}

15.13. 订单商品列表

URL: http://localhost:10000/cloud-mall/order/admin/order/goods/{id}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单商品列表

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/order/admin/order/goods/801

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─goodsId

int64

商品id

└─skuId

int64

skuId

└─goodsName

string

商品名称

└─goodsMasterImg

string

商品图片

└─goodsAttr

string

商品属性

└─goodsCount

int32

购买数量

└─goodsActualPrice

number

商品购买价格

└─goodsTotalAmt

number

商品价格小计

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": [
		{
			"goodsId": 295,
			"skuId": aa9d3f6a-4d77-405c-9e02-a44b067d06e2,
			"goodsName": "智宸.郭",
			"goodsMasterImg": "rtagdf",
			"goodsAttr": "kqb658",
			"goodsCount": 375,
			"goodsActualPrice": 714,
			"goodsTotalAmt": 418
		}
	]
}

16. 订单物流信息

16.1. 物流信息列表

URL: http://localhost:10000/cloud-mall/orderExpress/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 物流信息列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/orderExpress/admin/list?order=5oi2mg&pageSize=10&orderField=91qpd6&curPage=1

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─orderId

int64

订单id

└─orderConsigneeTel

string

收货人手机号

└─expressName

string

快递公司名称

└─expressCode

string

快递公司编码

└─expressNo

string

快递单号

└─detail

string

在途信息详情;json数组字符串

└─state

string

状态;0在途、1 揽收、2疑难、3签收、4退签、5派件、6退回、7转投、8清关、14拒签

└─subFlag

string

订阅标识 1订阅成功 0未订阅

└─updateTime

string

更新时间

└─lastQueryTime

string

最后查询时间

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 753,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 575,
				"orderId": 359,
				"orderConsigneeTel": "yt0gzu",
				"expressName": "智宸.郭",
				"expressCode": "68204",
				"expressNo": "3lhjm9",
				"detail": "uyntb6",
				"state": "dz6hp8",
				"subFlag": "foy9l9",
				"updateTime": "2023-12-11 08:25:11",
				"lastQueryTime": "2023-12-11 08:25:11"
			}
		]
	}
}

16.2. 订单发货

URL: http://localhost:10000/cloud-mall/orderExpress/admin/delivery

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 订单发货

Body-parameters:

Parameter

Type

Description

Required

Since

orderExpressId

int64

订单发货物流id，修改时不能为空

false

orderId

int64

订单id

true

expressId

int64

快递id

true

expressNo

string

快递单号

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/orderExpress/admin/delivery? --data '{
	"orderExpressId": 700,
	"orderId": 982,
	"expressId": 93,
	"expressNo": "pgaldo"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

16.3. 删除发货信息

URL: http://localhost:10000/cloud-mall/orderExpress/admin/delete/{id}

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除发货信息

Path-parameters:

Parameter

Type

Description

Required

Since

int64

订单发货物流id

true

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/orderExpress/admin/delete/55

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

16.4. 根据订单id查询物流信息

URL: http://localhost:10000/cloud-mall/orderExpress/open/order/{orderId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据订单id查询物流信息

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/orderExpress/open/order/354

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─orderConsigneeTel

string

收货人手机号

└─expressName

string

快递名称

└─expressCode

string

快递编码

└─expressNo

string

物流单号

└─detail

string

在途信息详情;json数组字符串

└─subFlag

string

订阅标识 1订阅成功 0未订阅

└─lastQueryTime

string

最后查询时间

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"orderId": 305,
		"orderConsigneeTel": "n9dja1",
		"expressName": "智宸.郭",
		"expressCode": "68204",
		"expressNo": "1nimfr",
		"detail": "x70btp",
		"subFlag": "3lywlo",
		"lastQueryTime": "2023-12-11 08:25:11"
	}
}

16.5. 根据订单快递id查询物流信息

URL: http://localhost:10000/cloud-mall/orderExpress/open/order-express/{orderExpressId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据订单快递id查询物流信息

Path-parameters:

Parameter

Type

Description

Required

Since

orderExpressId

int64

订单快递id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/orderExpress/open/order-express/926

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─orderConsigneeTel

string

收货人手机号

└─expressName

string

快递名称

└─expressCode

string

快递编码

└─expressNo

string

物流单号

└─detail

string

在途信息详情;json数组字符串

└─subFlag

string

订阅标识 1订阅成功 0未订阅

└─lastQueryTime

string

最后查询时间

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"orderId": 180,
		"orderConsigneeTel": "q8i3ym",
		"expressName": "智宸.郭",
		"expressCode": "68204",
		"expressNo": "dmi0le",
		"detail": "lmxdsm",
		"subFlag": "gvrqmy",
		"lastQueryTime": "2023-12-11 08:25:11"
	}
}

16.6. 订阅回调通知

URL: http://localhost:10000/cloud-mall/orderExpress/open/notify

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订阅回调通知

Query-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

No comments found.

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/orderExpress/open/notify?orderId=628

Response-fields:

Field

Type

Description

Since

any object

object

any object.

Response-example:

{
	
}

17. 支付服务

17.1. 获取微信小程序支付参数

URL: http://localhost:10000/cloud-mall/pay/wx/user/getJsApiPayParam/{orderId}

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取微信小程序支付参数

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/pay/wx/user/getJsApiPayParam/535

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─timeStamp

string

时间戳

└─nonceStr

string

随机串

└─packageStr

string

prepay_id=***

└─signType

string

签名类型

└─paySign

string

签名

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"timeStamp": "2023-12-11 08:25:10",
		"nonceStr": "83kot2",
		"packageStr": "7pxsy1",
		"signType": "2tk8kj",
		"paySign": "7musk2"
	}
}

17.2. 微信支付成功回调（成功后无需响应内容）

URL: http://localhost:10000/cloud-mall/pay/wx/open/notify

Type: POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 微信支付成功回调（成功后无需响应内容）

Query-parameters:

Parameter

Type

Description

Required

Since

headers

object

No comments found.

false

└─headers

object

No comments found.

false

body

object

No comments found.

false

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/pay/wx/open/notify

Response-fields:

Field

Type

Description

Since

any object

object

any object.

Response-example:

{
	
}

17.3. 交易结果查询

URL: http://localhost:10000/cloud-mall/pay/wx/open/queryTrading/{payNo}

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 交易结果查询

Path-parameters:

Parameter

Type

Description

Required

Since

payNo

string

支付编号

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/pay/wx/open/queryTrading/v3edkj

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─tradeState

string

交易状态
SUCCESS：支付成功
REFUND：转入退款
NOTPAY：未支付
CLOSED：已关闭
REVOKED：已撤销（仅付款码支付会返回）
USERPAYING：用户支付中（仅付款码支付会返回）
PAYERROR：支付失败（仅付款码支付会返回）

└─transactionId

string

微信交易号

└─successTime

string

支付成功时间

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"tradeState": "9fxdar",
		"transactionId": "97",
		"successTime": "2023-12-11 08:25:12"
	}
}

18. 支付订单

18.1. 支付订单列表

URL: http://localhost:10000/cloud-mall/payOrder/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付订单列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

payNo

string

支付编号

false

orderId

int64

订单id

false

userId

string

用户id

false

thirdUserId

string

支付用户id

false

payId

string

第三方支付订单id

false

payWay

string

支付途径;1 微信支付 2余额支付 3支付宝 4网银 5其他

false

state

string

状态;1 待付款 2已付款

false

refundFlag

string

退款标识;0否、1是

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/payOrder/admin/list?orderField=9iqd9g&pageSize=10&orderId=950&curPage=1&thirdUserId=97&userId=97&payId=97&order=muy26v&payWay=fsefhp&state=bgza81&refundFlag=k0plxj&payNo=4mvafn

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─payNo

string

支付编号

└─orderId

int64

订单id

└─userId

string

用户id

└─thirdUserId

string

支付用户id

└─payId

string

第三方支付订单id

└─payWay

string

支付途径;1 微信支付 2余额支付 3支付宝 4网银 5其他

└─payAmt

number

支付金额

└─payTime

string

支付时间

└─state

string

状态;1 待付款 2已付款

└─refundFlag

string

退款标识;0否、1是

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 975,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 441,
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": 394,
				"id": 237,
				"payNo": "dwe7dn",
				"orderId": 841,
				"userId": "97",
				"thirdUserId": "97",
				"payId": "97",
				"payWay": "jluuwf",
				"payAmt": 752,
				"payTime": "2023-12-11 08:25:12",
				"state": "5enq25",
				"refundFlag": "81714e"
			}
		]
	}
}

18.2. 订单支付信息

URL: http://localhost:10000/cloud-mall/payOrder/admin/info/{orderId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单支付信息

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/payOrder/admin/info/43

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─payNo

string

支付编号

└─orderId

int64

订单id

└─userId

string

用户id

└─thirdUserId

string

支付用户id

└─payId

string

第三方支付订单id

└─payWay

string

支付途径;1 微信支付 2余额支付 3支付宝 4网银 5其他

└─payAmt

number

支付金额

└─payTime

string

支付时间

└─state

string

状态;1 待付款 2已付款

└─refundFlag

string

退款标识;0否、1是

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 358,
		"createTime": "2023-12-11 08:25:12",
		"updateTime": "2023-12-11 08:25:12",
		"updateBy": 877,
		"id": 8,
		"payNo": "wyztp7",
		"orderId": 211,
		"userId": "97",
		"thirdUserId": "97",
		"payId": "97",
		"payWay": "j45xid",
		"payAmt": 384,
		"payTime": "2023-12-11 08:25:12",
		"state": "9mlfhi",
		"refundFlag": "r9hxwv"
	}
}

18.3. 订单支付信息

URL: http://localhost:10000/cloud-mall/payOrder/admin/info/getByPayOrderId

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单支付信息

Query-parameters:

Parameter

Type

Description

Required

Since

payOrderId

int64

支付订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/payOrder/admin/info/getByPayOrderId?payOrderId=4

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─payNo

string

支付编号

└─orderId

int64

订单id

└─userId

string

用户id

└─thirdUserId

string

支付用户id

└─payId

string

第三方支付订单id

└─payWay

string

支付途径;1 微信支付 2余额支付 3支付宝 4网银 5其他

└─payAmt

number

支付金额

└─payTime

string

支付时间

└─state

string

状态;1 待付款 2已付款

└─refundFlag

string

退款标识;0否、1是

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 14,
		"createTime": "2023-12-11 08:25:12",
		"updateTime": "2023-12-11 08:25:12",
		"updateBy": 568,
		"id": 796,
		"payNo": "detrzw",
		"orderId": 159,
		"userId": "97",
		"thirdUserId": "97",
		"payId": "97",
		"payWay": "z54rpm",
		"payAmt": 681,
		"payTime": "2023-12-11 08:25:12",
		"state": "e50x05",
		"refundFlag": "df3a7b"
	}
}

19. 支付退款

19.1. 支付退款列表

URL: http://localhost:10000/cloud-mall/payRefund/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付退款列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

payOrderId

int64

支付订单id

false

payNo

string

支付订单号

false

refundNo

string

退款单号

false

state

string

退款状态 1申请成功、2退款成功、3退款异常

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/payRefund/admin/list?payNo=hsre22&order=ea94dd&state=brv2n3&pageSize=10&refundNo=si6b5q&orderField=79awn7&payOrderId=820&curPage=1

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─payOrderId

int64

支付订单id

└─payNo

string

支付订单号

└─refundNo

string

退款单号

└─refundAmt

number

退款金额

└─goodsState

string

货物状态

└─refundReason

string

退款原因

└─remark

string

退款说明

└─state

string

退款状态 1申请成功、2退款成功、3退款异常、4退款关闭

└─createTime

string

创建时间

└─finishTime

string

完成时间

└─userId

int64

No comments found.

└─userName

string

No comments found.

└─userHead

string

No comments found.

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 305,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 486,
				"payOrderId": 492,
				"payNo": "7jhwjg",
				"refundNo": "un4npq",
				"refundAmt": 47,
				"goodsState": "fhew6z",
				"refundReason": "ajkr6w",
				"remark": "8ncad6",
				"state": "ydkh8m",
				"createTime": "2023-12-11 08:25:12",
				"finishTime": "2023-12-11 08:25:12",
				"userId": 399,
				"userName": "智宸.郭",
				"userHead": "wrc9tg"
			}
		]
	}
}

19.2. 退款详细信息

URL: http://localhost:10000/cloud-mall/payRefund/admin/info/{payOrderId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 退款详细信息

Path-parameters:

Parameter

Type

Description

Required

Since

payOrderId

int64

支付订单id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/payRefund/admin/info/213

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─payOrderId

int64

支付订单id

└─payNo

string

支付订单号

└─refundNo

string

退款单号

└─refundAmt

number

退款金额

└─goodsState

string

货物状态

└─refundReason

string

退款原因

└─remark

string

退款说明

└─state

string

退款状态 1申请成功、2退款成功、3退款异常、4退款关闭

└─createTime

string

创建时间

└─finishTime

string

完成时间

└─userId

int64

No comments found.

└─userName

string

No comments found.

└─userHead

string

No comments found.

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 698,
		"payOrderId": 658,
		"payNo": "tcckis",
		"refundNo": "hd0vcg",
		"refundAmt": 90,
		"goodsState": "zyijw7",
		"refundReason": "jq907q",
		"remark": "j7m2dg",
		"state": "w4xqav",
		"createTime": "2023-12-11 08:25:12",
		"finishTime": "2023-12-11 08:25:12",
		"userId": 43,
		"userName": "智宸.郭",
		"userHead": "s0156c"
	}
}

20. 热门搜索

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 历史热门搜索列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/searchHot/open/list?order=bhbntj&orderField=4ktz75&curPage=1&pageSize=10

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

└─keyword

string

关键字

└─searchCnt

int32

搜索次数

└─sort

int32

排序

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 578,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 784,
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": 899,
				"id": 895,
				"keyword": "dd1g21",
				"searchCnt": 649,
				"sort": 99
			}
		]
	}
}

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增热门搜索

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

false

keyword

string

关键字

true

searchCnt

int32

搜索次数

true

sort

int32

排序

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/searchHot/admin/add? --data '{
	"createBy": 596,
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": 231,
	"id": 909,
	"keyword": "9okt25",
	"searchCnt": 81,
	"sort": 920
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除热门搜索

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/searchHot/admin/delete --data '[
	695,
	770
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

21. 服务标签

21.1. 服务标签列表

URL: http://localhost:10000/cloud-mall/serviceTag/admin/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 服务标签列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

tagName

string

标签名称，模糊查询

false

state

string

状态; 0禁用 1启用 2全部

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/serviceTag/admin/list?order=d488as&tagName=智宸.郭&orderField=rhcztg&pageSize=10&state=mjs688&curPage=1

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，新增时不能为空

└─tagName

string

标签名称

└─tagDesc

string

标签描述

└─state

string

状态;0禁用 1启用

└─sort

int32

排序

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 989,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"createBy": 508,
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": 62,
				"id": 911,
				"tagName": "智宸.郭",
				"tagDesc": "r2li04",
				"state": "c5wjlf",
				"sort": 631
			}
		]
	}
}

21.2. 服务标签信息

URL: http://localhost:10000/cloud-mall/serviceTag/admin/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 服务标签信息

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/serviceTag/admin/info/922

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─createBy

int64

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

int64

更新人

└─id

int64

id，新增时不能为空

└─tagName

string

标签名称

└─tagDesc

string

标签描述

└─state

string

状态;0禁用 1启用

└─sort

int32

排序

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"createBy": 410,
		"createTime": "2023-12-11 08:25:12",
		"updateTime": "2023-12-11 08:25:12",
		"updateBy": 424,
		"id": 647,
		"tagName": "智宸.郭",
		"tagDesc": "96nael",
		"state": "qsd5l1",
		"sort": 543
	}
}

21.3. 新增服务标签

URL: http://localhost:10000/cloud-mall/serviceTag/admin/add

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增服务标签

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，新增时不能为空

false

tagName

string

标签名称

true

tagDesc

string

标签描述

true

state

string

状态;0禁用 1启用

true

sort

int32

排序

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/serviceTag/admin/add? --data '{
	"createBy": 927,
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": 797,
	"id": 860,
	"tagName": "智宸.郭",
	"tagDesc": "rx2z9o",
	"state": "8j6zu1",
	"sort": 846
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

21.4. 修改服务标签

URL: http://localhost:10000/cloud-mall/serviceTag/admin/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改服务标签

Body-parameters:

Parameter

Type

Description

Required

Since

createBy

int64

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

int64

更新人

false

int64

id，新增时不能为空

false

tagName

string

标签名称

true

tagDesc

string

标签描述

true

state

string

状态;0禁用 1启用

true

sort

int32

排序

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/serviceTag/admin/update? --data '{
	"createBy": 67,
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": 915,
	"id": 956,
	"tagName": "智宸.郭",
	"tagDesc": "8mm257",
	"state": "wqqo1n",
	"sort": 446
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

22. 用户地址

22.1. 用户地址列表

URL: http://localhost:10000/cloud-mall/address/user/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户地址列表

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/address/user/list

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

└─userId

string

用户id

└─receiverName

string

收件人名字

└─phoneNum

string

手机号

└─province

string

省

└─city

string

市

└─county

string

区县

└─address

string

地址详情

└─defaultFlag

string

是否默认;0否 1是

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": [
		{
			"id": 82,
			"userId": "97",
			"receiverName": "智宸.郭",
			"phoneNum": "47bazn",
			"province": "ukkweq",
			"city": "agnb1m",
			"county": "xytc0i",
			"address": "Apt. 167 曹桥22661号， 曲靖， 港 742970",
			"defaultFlag": "wucl0h",
			"createBy": "e1d268",
			"createTime": "2023-12-11 08:25:12",
			"updateTime": "2023-12-11 08:25:12",
			"updateBy": "fqomhf"
		}
	]
}

22.2. 用户地址详情

URL: http://localhost:10000/cloud-mall/address/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户地址详情

Path-parameters:

Parameter

Type

Description

Required

Since

int64

地址id

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/address/info/860

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─userId

string

用户id

└─receiverName

string

收件人名字

└─phoneNum

string

手机号

└─province

string

省

└─city

string

市

└─county

string

区县

└─address

string

地址详情

└─defaultFlag

string

是否默认;0否 1是

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 605,
		"userId": "97",
		"receiverName": "智宸.郭",
		"phoneNum": "5urpta",
		"province": "v4jryv",
		"city": "iy1itj",
		"county": "8r3nls",
		"address": "Apt. 167 曹桥22661号， 曲靖， 港 742970",
		"defaultFlag": "n7vgv2",
		"createBy": "6sheva",
		"createTime": "2023-12-11 08:25:12",
		"updateTime": "2023-12-11 08:25:12",
		"updateBy": "yzkecg"
	}
}

22.3. 新增用户地址

URL: http://localhost:10000/cloud-mall/address/user/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增用户地址

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

userId

string

用户id

false

receiverName

string

收件人名字

true

phoneNum

string

手机号

true

province

string

省

true

city

string

市

true

county

string

区县

true

address

string

地址详情

true

defaultFlag

string

是否默认;0否 1是

true

createBy

string

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

string

更新人

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/address/user/save? --data '{
	"id": 428,
	"userId": "97",
	"receiverName": "智宸.郭",
	"phoneNum": "0bxz5v",
	"province": "s0lxfx",
	"city": "ol37bb",
	"county": "eqqdoa",
	"address": "Apt. 167 曹桥22661号， 曲靖， 港 742970",
	"defaultFlag": "2nhwjr",
	"createBy": "o7hh9e",
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": "ivz9ob"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

22.4. 用户地址修改

URL: http://localhost:10000/cloud-mall/address/user/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 用户地址修改

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

userId

string

用户id

false

receiverName

string

收件人名字

true

phoneNum

string

手机号

true

province

string

省

true

city

string

市

true

county

string

区县

true

address

string

地址详情

true

defaultFlag

string

是否默认;0否 1是

true

createBy

string

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

string

更新人

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/address/user/update? --data '{
	"id": 966,
	"userId": "97",
	"receiverName": "智宸.郭",
	"phoneNum": "wqn2vk",
	"province": "qtvo64",
	"city": "lpu7n0",
	"county": "sqmgir",
	"address": "Apt. 167 曹桥22661号， 曲靖， 港 742970",
	"defaultFlag": "ek6zpp",
	"createBy": "v0zaw8",
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": "gdcanw"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

22.5. 删除用户地址

URL: http://localhost:10000/cloud-mall/address/user/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除用户地址

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

地址id,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/address/user/delete --data '[
	550,
	358
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

23. 用户商品收藏

23.1. 用户收藏列表

URL: http://localhost:10000/cloud-mall/collect/user/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户收藏列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/collect/user/list?pageSize=10&curPage=1&order=7n14gm&orderField=ouunj2

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─userId

string

用户id

└─goodsId

int64

商品id

└─goodsMainImageUrl

string

商品主图

└─goodsName

string

商品名称

└─goodsMarketPrice

number

商品市场价

└─goodsPrice

number

商品销售价

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 439,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 285,
				"userId": "97",
				"goodsId": 643,
				"goodsMainImageUrl": "www.xn---xn--po3a-p23rv513b.biz",
				"goodsName": "智宸.郭",
				"goodsMarketPrice": 703,
				"goodsPrice": 577,
				"createBy": "w9szm3",
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": "ggn7ok"
			}
		]
	}
}

23.2. 新增/取消收藏

URL: http://localhost:10000/cloud-mall/collect/user/{goodsId}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 没有收藏的商品调用该接口标识收藏商品，已收藏的商品调用该接口标识取消收藏

Path-parameters:

Parameter

Type

Description

Required

Since

goodsId

int64

商品id

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/collect/user/992

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

23.3. 获取用户是否收藏商品

URL: http://localhost:10000/cloud-mall/collect/user/{goodsId}

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取用户是否收藏商品

Path-parameters:

Parameter

Type

Description

Required

Since

goodsId

int64

商品id

true

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/collect/user/283

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": true
}

23.4. 清空收藏

URL: http://localhost:10000/cloud-mall/collect/user/clear

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空收藏

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/collect/user/clear

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

24. 用户商品足迹

24.1. 用户足迹列表

URL: http://localhost:10000/cloud-mall/footprint/user/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户足迹列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/footprint/user/list?pageSize=10&curPage=1&order=70deda&orderField=oodegq

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─userId

string

用户id

└─goodsId

int64

商品id

└─goodsName

string

商品名称

└─goodsMainImageUrl

string

商品主图

└─goodsMarketPrice

number

商品市场价格

└─goodsPrice

number

商品价格

└─cnt

int32

浏览次数

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 297,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 358,
				"userId": "97",
				"goodsId": 971,
				"goodsName": "智宸.郭",
				"goodsMainImageUrl": "www.xn---xn--po3a-p23rv513b.biz",
				"goodsMarketPrice": 788,
				"goodsPrice": 394,
				"cnt": 215,
				"createBy": "lga6ac",
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": "9jt7o9"
			}
		]
	}
}

24.2. 新增商品足迹

URL: http://localhost:10000/cloud-mall/footprint/user/{goodsId}/add

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户每次进入商品详情时都要调用一次

Path-parameters:

Parameter

Type

Description

Required

Since

goodsId

int64

商品id

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/footprint/user/417/add

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

24.3. 删除足迹

URL: http://localhost:10000/cloud-mall/footprint/user/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除足迹

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

足迹id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/footprint/user/delete --data '[
	481,
	825
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

24.4. 清空足迹

URL: http://localhost:10000/cloud-mall/footprint/user/clear

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空足迹

Request-example:

curl -X DELETE -i http://localhost:10000/cloud-mall/footprint/user/clear

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

25. 搜索历史记录前端使用缓存记录用户搜索记录

25.1. 列表

URL: http://localhost:10000/cloud-mall/usersearchhistory/list

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 列表

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页

false

pageSize

int32

每页大小

false

orderField

string

排序字段

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -i http://localhost:10000/cloud-mall/usersearchhistory/list?pageSize=10&curPage=1&order=ws7356&orderField=toihbu

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─userId

string

用户id

└─keyword

string

关键字

└─searchCnt

int32

搜索次数

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"totalCount": 208,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 331,
				"userId": "97",
				"keyword": "3gytqt",
				"searchCnt": 478,
				"createBy": "v7ok2x",
				"createTime": "2023-12-11 08:25:12",
				"updateTime": "2023-12-11 08:25:12",
				"updateBy": "xekrl5"
			}
		]
	}
}

25.2. 信息

URL: http://localhost:10000/cloud-mall/usersearchhistory/info/{id}

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 信息

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X POST -i http://localhost:10000/cloud-mall/usersearchhistory/info/773

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─userId

string

用户id

└─keyword

string

关键字

└─searchCnt

int32

搜索次数

└─createBy

string

创建人

└─createTime

string

创建时间

└─updateTime

string

更新时间

└─updateBy

string

更新人

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": {
		"id": 983,
		"userId": "97",
		"keyword": "7l1no5",
		"searchCnt": 470,
		"createBy": "vdf5kl",
		"createTime": "2023-12-11 08:25:12",
		"updateTime": "2023-12-11 08:25:12",
		"updateBy": "quvmfv"
	}
}

25.3. 保存

URL: http://localhost:10000/cloud-mall/usersearchhistory/save

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 保存

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

userId

string

用户id

false

keyword

string

关键字

false

searchCnt

int32

搜索次数

false

createBy

string

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

string

更新人

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/usersearchhistory/save? --data '{
	"id": 10,
	"userId": "97",
	"keyword": "6abgjy",
	"searchCnt": 207,
	"createBy": "2s9m9z",
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": "u9gmqg"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

25.4. 修改

URL: http://localhost:10000/cloud-mall/usersearchhistory/update

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

userId

string

用户id

false

keyword

string

关键字

false

searchCnt

int32

搜索次数

false

createBy

string

创建人

false

createTime

string

创建时间

false

updateTime

string

更新时间

false

updateBy

string

更新人

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/usersearchhistory/update? --data '{
	"id": 251,
	"userId": "97",
	"keyword": "bs9oji",
	"searchCnt": 649,
	"createBy": "hter3h",
	"createTime": "2023-12-11 08:25:12",
	"updateTime": "2023-12-11 08:25:12",
	"updateBy": "ealjfb"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

25.5. 删除

URL: http://localhost:10000/cloud-mall/usersearchhistory/delete

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 删除

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:10000/cloud-mall/usersearchhistory/delete --data '[
	883,
	758
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
	"success": true,
	"message": "success",
	"code": "68204",
	"data": null
}

26. 错误码列表

Error code	Description
10000	系统未知异常
10001	请求方法不支持
10002	缺少必要的请求头
11001	参数格式校验失败
11002	body为空
11003	参数异常
11004	无效的时间格式
11005	系统异常
12000	角色已存在
13000	手机号码已存在
13001	登录失败
13002	用户状态异常
13003	无效的token
13004	token为空
13007	用户不存在
14001	支付签名验证失败
14002	支付参数获取失败
14003	支付验签失败
14004	支付结果查询失败
15001	快递查询失败
15002	第三方服务请求失败
16000	数据已存在
16001	数据不存在
16003	批量操作数据库失败
16006	文件格式不支持
16007	文件上传错误
16008	临时文件不存在
16007	文件为空
16008	文件太大