尚品汇api接口文档

1.1 服务器地址

开发服务器

http://gmall-h5-api.atguigu.cn（新的）

1.2 公共请求参数

每个接口需要的Header参数值（登录接口不需要）：

参数名称	类型	是否必选	描述
token	String	Y	登录的token
userTempId	String(通过uuidjs生成)	Y	未登陆用户生成的临时ID

例如：

token: d90aa16f24d04c7d882051412f9ec45b 后台生成

userTempId: b2f79046-7ee6-4dbf-88d0-725b1045460b 前台生成

2.1请求地址

/api/user/passport/login

2.2请求方式

POST

2.3参数类型

参数名称	类型	是否必选	描述
phone	string	Y	用户名
password	string	Y	密码

2.4返回示例

成功：

{

code: 200

message: "成功"

data:{

nickName:"Administrator",

name:"Admin",

token: 90aa16f24d04c7d882051412f9ec45b"

}

ok: true

}

失败:

{

code: 201

message: "失败"

data: null

ok: false

}

首页三级分类

3.1请求地址

/api/product/getBaseCategoryList

3.2请求方式

GET

3.3参数类型

参数名称	类型	是否必选	描述
无	无	无	无

3.4返回示例

成功：

{

code: 200

message: "成功"

data: [

{

categoryChild: [

{

categoryChild:[

{

categoryName: "电子书",

categoryId: 1

},…],

categoryName: "电子书刊",

categoryId: 1

},…],

categoryName: "图书、音像、电子书刊",

categoryId: 1

},…],

ok: true

}

搜索商品

4.1请求地址

/api/list

4.2请求方式

POST

4.3参数类型

参数名称	类型	是否必选	描述
category1Id	string	N	一级分类ID
category2Id	string	N	二级分类ID
category3Id	string	N	三级分类ID
categoryName	string	N	分类名称
keyword	string	N	搜索关键字
props	Array	N	商品属性的数组: ["属性ID:属性值:属性名"] 示例: ["2:6.0～6.24英寸:屏幕尺寸"]
trademark	string	N	品牌: "ID:品牌名称" 示例: "1:苹果"
order	string	N	排序方式 1: 综合,2: 价格 asc: 升序,desc: 降序示例: "1:desc"
pageNo	number	N	页码
pageSize	number	N	每页数量

例子

{

"category3Id": "61",

"categoryName": "手机",

"keyword": "小米",

"order": "1:desc",

"pageNo": 1,

"pageSize": 10,

"props": ["1:1700-2799:价格", "2:6.65-6.74英寸:屏幕尺寸"],

"trademark": "4:小米"

}

4.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": {

"trademarkList": [

{

"tmId": 1,

"tmName": "苹果"

…

"attrsList": [

{

"attrId": 1,

"attrValueList": [

"4500-11999",

"2800-4499"

"attrName": "价格"

…

"goodsList": [

{

"id": 2,

"defaultImg": "http://192.168.200.128:8080/xxx.jpg",

"title": "Apple iPhone 11 (A2223)",

"price": 5499,

"createTime": null,

"tmId": null,

"tmName": null,

"category1Id": null,

"category1Name": null,

"category2Id": null,

"category2Name": null,

"category3Id": null,

"category3Name": null,

"hotScore": 0,

"attrs": null

…

"total": 8,

"pageSize": 2,

"pageNo": 1,

"totalPages": 4

"ok": true

}

获取商品详情

5.1请求地址

/api/item/{ skuId }

5.2请求方式

GET

5.3参数类型

参数名称	类型	是否必选	描述
skuId	string	Y	商品ID

5.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": {

"valuesSkuJson": "{\"3|5|7\":6,\"3|4|7\":2,\"2|4|7\":3,\"1|5|7\":5,\"1|4|7\":1,\"2|5|7\":4}",

"price": 5499,

"categoryView": {

"id": 61,

"category1Id": 2,

"category1Name": "手机",

"category2Id": 13,

"category2Name": "手机通讯",

"category3Id": 61,

"category3Name": "手机"

"spuSaleAttrList": [

{

"id": 1,

"spuId": 1,

"baseSaleAttrId": 1,

"saleAttrName": "选择颜色",

"spuSaleAttrValueList": [

{

"id": 1,

"spuId": 1,

"baseSaleAttrId": 1,

"saleAttrValueName": "黑色",

"saleAttrName": "选择颜色",

"isChecked": "0"

…

]

{

"id": 2,

"spuId": 1,

"baseSaleAttrId": 2,

"saleAttrName": "选择版本",

"spuSaleAttrValueList": [

{

"id": 4,

"spuId": 1,

"baseSaleAttrId": 2,

"saleAttrValueName": "64GB",

"saleAttrName": "选择版本",

"isChecked": "1"

…

]

{

"id": 3,

"spuId": 1,

"baseSaleAttrId": 3,

"saleAttrName": "选择套装",

"spuSaleAttrValueList": [

{

"id": 7,

"spuId": 1,

"baseSaleAttrId": 3,

"saleAttrValueName": " 官方标配",

"saleAttrName": "选择套装",

"isChecked": "1"

…

]

}

"skuInfo": {

"id": 2,

"spuId": 1,

"price": 5499,

"skuName": "Apple iPhone 11 (A2223) 64GB 红色移动联通电信双卡双待",

"skuDesc": "主体\n入网型号\nA2223\n品牌\nApple\n产品名称\niPhone 11\n上市年份\n2019年\n上市月份\n9月\n基本信息\n机身颜色\n红色\n机身长度（mm）\n150.9\n机身重量（g）\n194\n机身材质工艺\n以官网信息为准\n机身宽度（mm）\n75.7\n机身材质分类\n玻璃后盖\n机身厚度（mm）\n8.3\n运营商标志或内容\n无",

"weight": "0.47",

"tmId": 1,

"category3Id": 61,

"skuDefaultImg": "http://192.168.200.128:8080/xxxx.jpg",

"isSale": 1,

"skuImageList": [

{

"id": 6,

"skuId": 2,

"imgName": "63e862164165f483.jpg",

"imgUrl": "http://192.168.200.128:8080/group1/M00/00/00/wKjIgF42RLOAd5YSAANTQTjaVjQ819.jpg",

"spuImgId": 2,

"isDefault": "0"

…

"skuAttrValueList": [

{

"id": 6,

"attrId": 1,

"valueId": 6,

"skuId": 2

…

"skuSaleAttrValueList": null

}

"ok": true

}

获取购物车列表

6.1请求地址

/api/cart/cartList

6.2请求方式

GET

6.3参数类型

参数名称	类型	是否必选	描述
无	无	无	无

6.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": [

{

"id": 61,

"userId": "2",

"skuId": 4,

"cartPrice": 5999,

"skuNum": 4,

"imgUrl": "http://192.168.200.128:8080xxx.jpg",

"skuName": "Apple iPhone 11 (A2223) ",

"isChecked": 1,

"skuPrice": 5999

{

"id": 62,

"userId": "2",

"skuId": 2,

"cartPrice": 5499,

"skuNum": 1,

"imgUrl": "http://192.168.200.128:8080/yyyy.jpg",

"skuName": "Apple iPhone 11 (A2223) 64GB 红色",

"isChecked": 0,

"skuPrice": 5499

}

"ok": true

}

添加到购物车(对已有物品进行数量改动)

7.1请求地址

/api/cart/addToCart/{ skuId }/{ skuNum }

7.2请求方式

POST

7.3参数类型

参数名称

类型

是否必选

描述

skuID

string

商品ID

skuNum

string

商品数量

正数代表增加

负数代表减少

7.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": null,

"ok": true

}

切换商品选中状态

8.1请求地址

/api/cart/checkCart/{skuID}/{isChecked}

8.2请求方式

GET

8.3参数类型

参数名称

类型

是否必选

描述

skuID

string

商品ID

isChecked

string

商品选中状态

0代表取消选中

1代表选中

8.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": null,

"ok": true

}

删除购物车商品

9.1请求地址

/api/cart/deleteCart/{skuId}

9.2请求方式

DELETE

9.3参数类型

参数名称	类型	是否必选	描述
skuId	string	Y	商品id

9.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": null,

"ok": true

}

获取订单交易页信息

10.1请求地址

/api/order/auth/trade

10.2请求方式

GET

10.3参数类型

参数名称	类型	是否必选	描述
无	无	无	无

10.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": {

"totalAmount": 23996,

"userAddressList": [

{

"id": 2,

"userAddress": "北京市昌平区2",

"userId": 2,

"consignee": "admin",

"phoneNum": "15011111111",

"isDefault": "1"

}

"tradeNo": "1b23c1efc8144bfc83e51807f4e71d3a",

"totalNum": 1,

"detailArrayList": [

{

"id": null,

"orderId": null,

"skuId": 4,

"skuName": "Apple iPhone 11 移动联通电信4G手机双卡双待",

"imgUrl": "http://192.168.200.128:8080/RLOAElEmAATrIT-1J9Q110.jpg",

"orderPrice": 5999,

"skuNum": 4,

"hasStock": null

}

]

"ok": true

}

获取我的订单列表

11.1请求地址

/api/order/auth/{page}/{limit}

11.2请求方式

GET

11.3参数类型

参数名称	类型	是否必选	描述
page	string	Y	页码
limit	string	Y	每页显示数量

11.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": {

"records": [

{

"id": 70,

"consignee": "admin",

"consigneeTel": "15011111111",

"totalAmount": 29495,

"orderStatus": "UNPAID",

"userId": 2,

"paymentWay": "ONLINE",

"deliveryAddress": "北京市昌平区2",

"orderComment": "",

"outTradeNo": "ATGUIGU1584247289311481",

"tradeBody": "Apple iPhone 11 (A2223) 128GB手机双卡双待 A",

"createTime": "2020-03-15 12:41:29",

"expireTime": "2020-03-16 12:41:29",

"processStatus": "UNPAID",

"trackingNo": null,

"parentOrderId": null,

"imgUrl": null,

"orderDetailList": [

{

"id": 81,

"orderId": 70,

"skuId": 2,

"skuName": "Apple iPhone 11 (A2223) 64GB 红色",

"imgUrl": "http://192.168.200.128:8080/xxx.jpg",

"orderPrice": 5499,

"skuNum": 1,

"hasStock": null

…

"orderStatusName": "未支付",

"wareId": null

…

"total": 41,

"size": 2,

"current": 1,

"pages": 21

"ok": true

}

提交订单

12.1请求地址

/api/order/auth/submitOrder?tradeNo={tradeNo}

12.2请求方式

POST

12.3参数类型

参数名称	类型	是否必选	描述
traderNo	string	Y	交易编号(拼接在路径中)
consignee	string	Y	收件人姓名
consigneeTel	string	Y	收件人电话
deliveryAddress	string	Y	收件地址
paymentWay	string	Y	支付方式 (ONLINE代表在线)
orderComment	string	Y	订单备注
orderDetailList	Array	Y	存储多个商品对象的数组

例子:

{

"consignee": "admin",

"consigneeTel": "15011111111",

"deliveryAddress": "北京市昌平区2",

"paymentWay": "ONLINE",

"orderComment": "xxx",

"orderDetailList": [

{

"id": null,

"orderId": null,

"skuId": 6,

"skuName": " Apple iPhone 11 (A2223) 128GB 红色移动联通电信22",

"imgUrl": "http://182.92.128.115:8080//rBFUDF6V0JmAG9XGAAGL4LZv5fQ163.png",

"orderPrice": 4343,

"skuNum": 2,

"hasStock": null

{

"id": null,

"orderId": null,

"skuId": 4,

"skuName": "Apple iPhone 11 (A2223) 128GB 红色",

"imgUrl": "http://182.92.128.115:80800/rBFUDF6VzaeANzIOAAL1X4gVWEE035.png",

"orderPrice": 5999,

"skuNum": 1,

"hasStock": null

}

]

}

12.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": 71, // orderId 订单号

"ok": true

}

获取订单支付信息

13.1请求地址

/api/payment/weixin/createNative/{orderId}

13.2请求方式

GET

13.3参数类型

参数名称

类型

是否必选

描述

orderId

string

支付订单ID

(通过提交订单得到)

13.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": {

"codeUrl": "weixin://wxpay/bizpayurl?pr=P0aPBJK",

"orderId": 71,

"totalFee": 23996,

"resultCode": "SUCCESS"

"ok": true

}

查询支付订单状态

14.1请求地址

/api/payment/weixin/queryPayStatus/{orderId}

14.2请求方式

GET

14.3参数类型

参数名称	类型	是否必选	描述
orderId	string	Y	支付订单ID

14.4返回示例

成功：

{

"code": 205,

"message": "支付中",

"data": null,

"ok": false

}

获取注册验证码

15.1请求地址

/api/user/passport/code

15.2请求方式

GET

15.3参数类型

参数名称	类型	是否必选	描述
无	无	无	无

15.4返回示例

成功：

返回验证码图片

注册用户

16.1请求地址

/api/user/passport/register

16.2请求方式

POST

16.3参数类型

参数名称	类型	是否必选	描述
phone	string	Y	注册手机号
password	string	Y	密码
code	string	Y	验证码

16.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": null,

"ok": true

}

退出登陆

16.1请求地址

/api/user/passport/logout

16.2请求方式

GET

16.3参数类型

无

16.4返回示例

成功：

{

"code": 200,

"message": "成功",

"data": null,

"ok": true

}

修改的：

添加了token校验获取用户登录信息，用户登录只保存用户的token

token校验

http://182.92.128.115/api/user/passport/auth/getUserInfo

/api/user/passport/sendCode/{phone}

获取验证码

get

/api/user/userAddress/auth/findUserAddressList

获取用户地址信息

get