电商项目接口文档

其他 2019-02-20 12:01:02 阅读次数: 0

【必读】

接口地址

内网环境：172.17.8.100

外网环境：mobile.bwstudent.com

开发人数建议

建议独立开发

接口请求方式

不同业务类型的接口对应不同的请求方式

  • 查询类业务接口使用GET
  • 新增类业务接口使用POST
  • 修改类业务接口使用PUT
  • 删除类业务接口使用DELETE

公共入参

请求头需要设定几个固定入参，这些参数当用户处于登录状态下为必传项

参数示例
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726

banner跳转协议

点击banner的跳转有两种方式

1.原生跳转

协议规则：wd://commodity_list?arg=1

地址解析：wd://为前缀，通常是前后端一起定义的，commodity_list是要跳转的原生页面，?arg=1问号后面的arg=1是携带的参数。

处理方式：当客户端获取到url后需要先判断，如果是wd://为前缀，则获取到后面的跳转地址commodity_list，假如commodity_list是商品列表页面，跳转到该页面后同时调用 据二级类目查询商品信息 的接口，将arg=1做为本次接口请求的参数，从而实现加载对应的商品列表内容。

本项目涉及跳转的原生页面
跳转的原生页 地址规则 涉及的接口请求
商品列表页面 wd://commodity_list?arg=1 点我查看
商品详情页面 wd://commodity_info?arg=1001 点我查看

2.http跳转

协议规则：http://www.woshiguanggao.com

地址解析：该地址为常见的http链接，不多做描述。这个地址可能是我们自己产品的H5页面也可能是广告主的H5页面，不过都是http方式的请求。

处理方式：获取到url后，直接使用webview打开跳转到这个地址即可。


订单业务

在订单业务中，客户端需要根据判断订单状态来做出对应的业务处理

  • 订单状态为1时，代表待付款状态，在查看订单信息时，需要提供【付款】功能
  • 订单状态为2时，代表确认收货状态，在查看订单信息时，需要提供【确认收货】功能
  • 订单状态为3时，代表当前订单明细里的商品可以进行评价，在查看订单信息时，需要对明细里的商品提供【评价】功能，只有商品状态为未评价时才显示
  • 订单状态为9时，代表当前订单已经完成

用户钱包

用户在注册成功后系统会赠送很多很多的钱给你，以供你购买商品用

短信平台对接

该项目服务端不提供获取短信验证码的功能,客户端该功能的实现可以使用第三方短信平台mob。客户端要确保在调用sdk获取短信验证码之前先调用一下咱们的-校验手机号是否可用-的接口，如果手机号可用再去调用mob的sdk去获取短信验证码。
关于mob的文档资料可以参阅☞点我查看mob对接文档☜

用户相关接口

register

1.注册

接口地址：http://172.17.8.100/small/user/v1/register

请求方式:POST

接口描述:用户注册，手机短信验证请参考必读项中的短信对接方案

@RequestBody入参
Parameter 类型 描述 例子
phone string 手机号 16619948760
pwd string 密码 123
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "注册成功",
"status": "0000"
}
login

2.登陆

接口地址：http://172.17.8.100/small/user/v1/login

请求方式:POST

接口描述:用户登录，已注册用户输入注册手机号与密码进行登录操作

@RequestBody入参
Parameter 类型 描述 例子
phone string 手机号 16619948760
pwd string 密码 123
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
userId int 用户ID
sessionId string 用户登陆凭证
nickName string 用户昵称
phone string 用户手机号
headPic string 用户头像地址
sex int 性别 未提供修改性别的接口，返回默认1=男
出参例子
{
  "result":{
"headPic": "http://172.17.8.100/images/small/head_pic/2018-11-21/20181121100733.jpg",
"nickName": "OP_8mY65",
"phone": "16619958760",
"sessionId": "154276714558512",
"sex": 1,
"userId": 12
},
"message": "登录成功",
"status": "0000"
}
modifyUserNick

3. 修改昵称

接口地址：http://172.17.8.100/small/user/verify/v1/modifyUserNick

请求方式:PUT

接口描述: 用户修改自己的昵称操作

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
nickName string 新昵称 冬天的积雪
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "修改成功",
"status": "0000"
}
modifyUserPwd

4. 修改用户密码

接口地址：http://172.17.8.100/small/user/verify/v1/modifyUserPwd

请求方式:PUT

接口描述: 修改用户密码

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
oldPwd string 原密码 123
newPwd string 新密码 456
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "修改成功",
"status": "0000"
}
modifyHeadPic

5. 用户上传头像

接口地址：http://172.17.8.100/small/user/verify/v1/modifyHeadPic

请求方式:POST

接口描述: 用户上传头像

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
image file 图片文件 图片文件
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
headPath string 上传成功后图片的访问路径
出参例子
{
headPath": "http://172.17.8.100/images/small/head_pic/2018-11-21/20181121102818.jpg",
"message": "上传成功",
"status": "0000"
}
getUserById

6.根据用户ID查询用户信息

接口地址：http://172.17.8.100/small/user/verify/v1/getUserById

请求方式:GET

接口描述:根据用户ID查询用户信息，作为用户资料的展示

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
userId int 用户ID
nickName string 用户昵称
phone string 手机号
password string 密码
sex int 性别 未提供修改性别的接口，返回默认1=男
headPic string 用户头像地址
createTime long 用户注册时间
出参例子
{
result":{
"createTime": 1542816321000,
"headPic": "http://172.17.8.100/images/small/head_pic/2018-11-21/20181121102818.jpg",
"nickName": "风",
"password": "qAMcuRhmMFPH2HhixiA1dA==",
"phone": "16619958760",
"sex": 1,
"userId": 12
},
"message": "查询成功",
"status": "0000"
}
receiveAddressList

7. 收货地址列表

接口地址：http://172.17.8.100/small/user/verify/v1/receiveAddressList

请求方式:GET

接口描述:用户自身的收货地址列表

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONArray 返回结果
result结构
Parameter 类型 描述
id int 收货地址ID
userId int 用户Id
phone string 手机号
realName string 真实姓名
whetherDefault int 是 否为默认地址1：是 2：否
address string 收货地址 客户端根据UI图进行展示,地址的省 市 县 详细地址 以空格间隔,客户端以最后一个空格区分详细地址与省 市 县
zipCode string 邮政编码
createTime long 创建时间
出参例子
{
result":[
{
"address": "北京",
"createTime": 1542474327000,
"id": 6,
"phone": "18736970210",
"realName": "诸葛",
"userId": 12,
"whetherDefault": 1,
"zipCode": "100001"
}
],
"message": "查询成功",
"status": "0000"
}
addReceiveAddress

8. 新增收货地址

接口地址：http://172.17.8.100/small/user/verify/v1/addReceiveAddress

请求方式:POST

接口描述: 用户新增收货地址

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
realName string 收货人真实姓名 李某某
phone string 手机号 收货人手机号
address string 收货地址 客户端将地址的省 市 县 详细地址 以空格间隔 拼接成字符串传给后台 北京 海淀区 八维
zipCode string 邮政编码 101010
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "添加成功",
"status": "0000"
}
setDefaultReceiveAddress

9. 设置默认收货地址

接口地址：http://172.17.8.100/small/user/verify/v1/setDefaultReceiveAddress

请求方式:POST

接口描述: 用户将多个收货列表中的一个设置为默认收货地址

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
id int 收货地址id 1
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "设置成功",
"status": "0000"
}
changeReceiveAddress

10.修改收货信息

接口地址：http://172.17.8.100/small/user/verify/v1/changeReceiveAddress

请求方式:PUT

接口描述:用户对已存在收货地址进行修改操作

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 1000
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
id int 收货地址id 18
realName string 收货人真实姓名 李某某
phone string 手机号 收货人手机号
address string 收货地址 客户端将地址的省 市 县 详细地址 以空格间隔 拼接成字符串传给后台 北京 八维
zipCode string 邮政编码 101010
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "修改成功",
"status": "0000"
}
findUserWallet

11.查询用户钱包

接口地址：http://172.17.8.100/small/user/verify/v1/findUserWallet

请求方式:GET

接口描述:查询用户钱包，用于展示用户的余额与消费明细

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
page int 当前页数 1
count int 当前页显示条数 1
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
balance double 用户当前余额
detailList JSONArray 用户消费明细
detailList结构
Parameter 类型 描述
amount double 用户消费金额
createTime long 用户消费时间
出参例子
{
result":{
"balance": 99999999,
"detailList":[
{
"amount": 2,
"createTime": 1542476199000
}
]
},
"message": "查询成功",
"status": "0000"
}

订单相关接口

bannerShow

1.创建订单

接口地址：http://172.17.8.100/small/order/verify/v1/createOrder

请求方式:POST

接口描述:创建订单

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
orderInfo string 用户购买的商品数据，封装到一个jsonArray中提交，commodityId是商品ID,amount是购买的数量 [{"commodityId":3,"amount":1},{"commodityId":5,"amount":1}]
totalPrice double 支付总金额 520.55
addressId int 收货地址id 1
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{

}
pay

2.支付

接口地址：http://172.17.8.100/small/order/verify/v1/pay

请求方式:POST

接口描述:支付

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
orderId string 订单id 1441165
payType int 支付类型 3
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{

}
findOrderListByStatus

3. 根据订单状态查询订单信息

接口地址：http://172.17.8.100/small/order/verify/v1/findOrderListByStatus

请求方式:GET

接口描述: 根据订单状态查询订单信息。客户端需要根据返回数据里的订单状态做出对应的业务处理。具体请参考【必读事项】

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
status int 要查询对应状态的订单数据 0=查看全部 1=查看待付款 2=查看待收货 3=查看待评价 9=查看已完成
page int 当前页 1
count int 当前页显示条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
orderId string 订单id
userId int 用户id
payMethod int 支付方式：1余额，2支付宝，3微信
payAmount double 支付金额
expressCompName string 快递公司名称
orderTime long 下单时间
expressSn string 快递单号
orderStatus int 订单状态，不同的状态前端需要做不同的业务处理
detailList jsonArray 订单商品详情
detailList结构
Parameter 类型 描述
orderDetailId int 订单详情id
commodityId int 商品id
commodityName string 商品名称
commodityCount int 商品数量
commodityPic string 商品图片
commodityPrice double 商品单价
commentStatus int 评论状态 1=未评论 2=已评论
出参例子
{

}
deleteOrder

4. 删除订单

接口地址：http://172.17.8.100/small/order/verify/v1/deleteOrder

请求方式:DELETE

接口描述: 删除订单

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
orderId string 订单id 2018112211424963613
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{

}
confirmReceipt

5. 收货

接口地址：http://172.17.8.100/small/order/verify/v1/confirmReceipt

请求方式:PUT

接口描述: 收货

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
orderId string 订单id 156486
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{

}
findShoppingCart

6.查询购物车

接口地址：http://172.17.8.100/small/order/verify/v1/findShoppingCart

请求方式:GET

接口描述:查询购物车

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
pic string 缩略图
price double 价格
count int 购买的数量
出参例子
{

}
syncShoppingCart

7. 同步购物车数据

接口地址：http://172.17.8.100/small/order/verify/v1/syncShoppingCart

请求方式:PUT

接口描述: 同步购物车数据

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
data string 购物车数据 [{"commodityId":5,"count":3},{"commodityId":6,"count":4}]客户端按照此形式进行封装
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{

}
findOrderInfo

8.查询订单明细数据

接口地址：http://172.17.8.100/small/order/verify/v1/findOrderInfo

请求方式:GET

接口描述:查询订单明细数据,使用场景为，查看用户钱包消费明细时调用

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
@RequestParam入参
Parameter 类型 描述 例子
orderId string 订单ID 2018112211424963613
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
orderInfo jsonObject 返回参数
orderInfo结构
Parameter 类型 描述
orderId string 订单id
userId int 用户id
payMethod int 支付方式：1余额，2支付宝，3微信
payAmount double 支付金额
expressCompName string 快递公司名称
orderTime long 下单时间
expressSn string 快递单号
orderStatus int 订单状态
detailList jsonArray 订单商品详情
detailList结构
Parameter 类型 描述
orderDetailId int 订单详情id
commodityId int 商品id
commodityName string 商品名称
commodityCount int 商品数量
commodityPic string 商品图片
commodityPrice double 商品单价
commentStatus int 评论状态 1=未评论 2=已评论
出参例子
{

}

圈子相关接口

findCircleList

1. 圈子列表

接口地址：http://172.17.8.100/small/circle/v1/findCircleList

请求方式:GET

接口描述:圈子列表

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 1010 1078
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONArray 返回结果内容
result结构解析
Parameter 类型 描述
id int 圈子id
userId int 用户id
nickName string 用户昵称
headPic string 用户头像
commodityId int 商品id,客户端将商品id作为拼接商品链接跳转到商品详情页的参数
content string 内容
image string 图片地址
whetherGreat int 当前登录用户是否点赞(2为否，1为是)
greatNum int 点赞数
createTime Long 发布时间
出参例子
{
"result":[
{
"commodityId": 3,
"content": "好用，就是太贵",
"createTime": 1542639261000,
"greatNum": 0,
"headPic": "http://172.17.8.100/images/small/head_pic/2018-11-17/20181117120315.jpg",
"id": 4,
"image": "http://172.17.8.100/images/small/circle_pic/2018-11-19/3509720181119085421.jpg,http://172.17.8.100/images/small/circle_pic/2018-11-19/7196220181119085421.jpg",
"nickName": "风情的人",
"userId": 1,
"whetherGreat": 2
}
],
"message": "查询成功",
"status": "0000"
}
releaseCircle

2. 发布圈子

接口地址：http://172.17.8.100/small/circle/verify/v1/releaseCircle

请求方式:POST

接口描述:用户在写订单下商品评论时，如果勾选【同步到圈子】时调用该接口

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 1010 1078
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
commodityId int 商品id 1
content string 正文 给大家推荐一个好商品
image file 图片 url
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "发布成功",
"status": "0000"
}
deleteCircle

3. 删除我发表过的圈子

接口地址：http://172.17.8.100/small/circle/verify/v1/deleteCircle

请求方式:DELETE

接口描述:删除圈子，用户只能对自己发布的圈子进行删除操作，删除圈子的入口将在我的圈子里，用户在未确认收货与评论时，不允许发布圈子

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 1010 1078
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
circleId int 商品id(多id以逗号间隔) 1,2,4
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "删除成功",
"status": "0000"
}
findMyCircleById

4. 我的圈子

接口地址：http://172.17.8.100/small/circle/verify/v1/findMyCircleById

请求方式:GET

接口描述:我的圈子，用户查看自己发布的圈子的列表

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 1010 1078
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONArray 返回结果内容
result结构解析
Parameter 类型 描述
id int 圈子id
userId int 用户id
nickName string 用户昵称
headPic string 用户头像
commodityId int 商品id
content string 内容
image string 图片地址
greatNum int 点赞数
createTime Long 发布时间
出参例子
{
"result":[
{
"commodityId": 6,
"content": "好用，就是太贵",
"createTime": 1542818290000,
"greatNum": 0,
"headPic": "http://172.17.8.100/images/small/head_pic/2018-11-21/20181121102818.jpg",
"id": 5,
"image": "http://172.17.8.100/images/small/circle_pic/2018-11-21/2580720181121103810.jpg,http://172.17.8.100/images/small/circle_pic/2018-11-21/2104320181121103810.jpg",
"nickName": "风",
"userId": 12
}
],
"message": "查詢成功",
"status": "0000"
}
addCircleGreat

5. 圈子点赞

接口地址：http://172.17.8.100/small/circle/verify/v1/addCircleGreat

请求方式:POST

接口描述:用户在登录状态下，对圈子里其他用户发布的圈子进行点赞的操作

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 10
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
circleId int 圈子id 1
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "点赞成功",
"status": "0000"
}
cancelCircleGreat

6. 取消点赞

接口地址：http://172.17.8.100/small/circle/verify/v1/cancelCircleGreat

请求方式:DELETE

接口描述:取消点赞，用户在登录状态下，对圈子里其他用户发布的圈子进行点赞后，取消点赞的操作

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 10
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
circleId int 圈子id 1
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "取消成功",
"status": "0000"
}

商品相关接口

bannerShow

1.banner展示列表

接口地址：http://172.17.8.100/small/commodity/v1/bannerShow

请求方式:GET

接口描述:banner展示列表

接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构解析
Parameter 类型 描述
imageUrl string 图片地址
jumpUrl string 跳转地址 支持两种跳转 分别为原生和H5
rank int 排序
出参例子
{
"result":[
{"imageUrl": "http://172.17.8.100/images/tech/banner/20181026151647.png", "jumpUrl": "http://172.17.8.100/htm/lottery/index.html",…},
{"imageUrl": "http://172.17.8.100/images/tech/banner/20181026151647.png", "jumpUrl": "http://172.17.8.100/htm/lottery/index.html",…}
],
"message": "查询成功",
"status": "0000"
}
commodityList

2.首页商品信息列表

接口地址：http://172.17.8.100/small/commodity/v1/commodityList

请求方式:GET

接口描述:首页商品信息列表，客户端根据UI图进行商品信息列表展示,该接口不支持也不用分页

接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
rxxp jsonObject 热销新品
mlss jsonObject 魔力时尚
pzsh jsonObject 品质生活
zntj，rxxp，mlss，pzsh结构
Parameter 类型 描述
commodityList jsonArray 商品信息
id int 归属标签id
name string 归属标签名称
commodityList结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
masterPic string 缩略图
price double 价格
saleNum int 销量
出参例子
{
"result":{
"rxxp":{
"commodityList":[
{"commodityId": 5, "commodityName": "双头两用修容笔", "masterPic": "http://172.17.8.100/images/small/commodity/mzhf/cz/3/1.jpg",…},
{"commodityId": 25, "commodityName": "秋冬季真皮兔毛女鞋韩版休闲平底毛毛鞋软底百搭浅口水钻加绒棉鞋毛毛鞋潮鞋", "masterPic": "http://172.17.8.100/images/small/commodity/nx/ddx/1/1.jpg",…},
{"commodityId": 19, "commodityName": "环球 时尚拼色街拍百搭小白鞋 韩版原宿ulzzang板鞋 女休闲鞋", "masterPic": "http://172.17.8.100/images/small/commodity/nx/bx/2/1.jpg",…}
],
"id": 1002,
"name": "热销新品"
},
"pzsh":{
"commodityList":[{"commodityId": 6, "commodityName": "轻柔系自然裸妆假睫毛", "masterPic": "http://172.17.8.100/images/small/commodity/mzhf/cz/4/1.jpg",…],
"id": 1004,
"name": "品质生活"
},
"mlss":{
"commodityList":[
{"commodityId": 32, "commodityName": "唐狮女鞋冬季女鞋休闲鞋子女士女鞋百搭帆布鞋女士休闲鞋子女款板鞋休闲女鞋帆布鞋", "masterPic": "http://172.17.8.100/images/small/commodity/nx/fbx/1/1.jpg",…},
{"commodityId": 28, "commodityName": "秋季新款女鞋【牛皮】艾斯臣女鞋单鞋蝴蝶结平底单鞋豆豆鞋女加绒保暖小毛球平底女鞋单鞋豆豆鞋女冬女士单鞋毛毛鞋", "masterPic": "http://172.17.8.100/images/small/commodity/nx/ddx/4/1.jpg",…}
],
"id": 1003,
"name": "魔力时尚"
}
},
"message": "查询成功",
"status": "0000"
}
findCommodityListByLabel

3. 根据商品列表归属标签查询商品信息

接口地址：http://172.17.8.100/small/commodity/v1/findCommodityListByLabel

请求方式:GET

接口描述: 根据商品列表归属标签查询商品信息，根据商品首页返回的参数信息，点击查看单一归属标签下的商品信息的操作

@RequestParam入参
Parameter 类型 描述 例子
labelId string 标签id 1001
page int 当前页 1
count int 当前页显示条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
masterPic string 缩略图
price double 价格
saleNum int 销量
出参例子
{
"result":[
{
"commodityId": 32,
"commodityName": "唐狮女鞋冬季女鞋休闲鞋子女士女鞋百搭帆布鞋女士休闲鞋子女款板鞋休闲女鞋帆布鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/fbx/1/1.jpg",
"price": 88,
"saleNum": 0
},
{
"commodityId": 18,
"commodityName": "白色经典 秋季新款简约百搭轻便休闲女鞋板鞋小白鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/bx/1/1.jpg",
"price": 79,
"saleNum": 0
},
{
"commodityId": 12,
"commodityName": "Lara style美妆BB蛋",
"masterPic": "http://172.17.8.100/images/small/commodity/mzhf/mzgj/2/1.jpg",
"price": 22,
"saleNum": 0
},
{
"commodityId": 4,
"commodityName": "佩佩防晕染眼线液笔",
"masterPic": "http://172.17.8.100/images/small/commodity/mzhf/cz/2/1.jpg",
"price": 19,
"saleNum": 845
},
{
"commodityId": 28,
"commodityName": "秋季新款女鞋【牛皮】艾斯臣女鞋单鞋蝴蝶结平底单鞋豆豆鞋女加绒保暖小毛球平底女鞋单鞋豆豆鞋女冬女士单鞋毛毛鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/ddx/4/1.jpg",
"price": 159,
"saleNum": 0
}
],
"message": "查询成功",
"status": "0000"
}
findCommodityDetailsById

4. 商品详情

接口地址：http://172.17.8.100/small/commodity/v1/findCommodityDetailsById

请求方式:GET

接口描述: 用户点击商品列表信息，进入商品详细信息的操作

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
commodityId int 商品id 6
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
describe string 商品描述
picture string 商品图片地址，以逗号间隔
stock int 库存
details string 商品详情 html格式，客户端需要自行解析
commentNum int 评论数
price double 价格
saleNum int 销量
weight int 重量
categoryId string 所属二级类目id
categoryName string 类目名称
出参例子
{
"result":{
"categoryId": "1001002004",
"categoryName": "卫衣",
"commentNum": 0,
"commodityId": 99,
"commodityName": "字母绣花宽松女款卫衣",
"describe": "字母绣花,均码",
"details": "<div class=\"dc-img\">\r\n <div class=\"dc-img-detail\">\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/150/cda51ebb-b043-42cb-88c0-02ab3231cc36.jpg\" class=\"J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/150/cda51ebb-b043-42cb-88c0-02ab3231cc36.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/116/e4b74544-5199-4781-9cb8-9c849e5d318e.jpg\" class=\"J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/116/e4b74544-5199-4781-9cb8-9c849e5d318e.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/84/66fa09f0-3911-4df8-a42c-2b3823c01283.jpg\" class=\"J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/84/66fa09f0-3911-4df8-a42c-2b3823c01283.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/118/891f80fc-bd8e-4b62-b53e-9746ea6b3dc1.jpg\" class=\"J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/118/891f80fc-bd8e-4b62-b53e-9746ea6b3dc1.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/195/160895c2-e1f0-42e4-b980-e52f65b7f9c9.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/140/df2a8e4a-d560-4ce6-a145-d147a0510c0a.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/3/e90de523-2430-4162-baad-1295fa58662f.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/164/f18c19e3-e881-4fe6-b6d4-ec161f2639d3.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/157/e8b07d3d-a0ae-4260-bb61-0725d54d71a0.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/157/523c656e-6098-41b3-b68e-266adefd4d53.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/87/fe6ad98a-8f99-4603-a10c-cbb819ab71b9.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/123/ac538efd-c56a-47a5-8bcf-ac18f539cc0f.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/46/2ec0a948-e9f5-4fcb-8354-54fe05164dc7.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/36/370de619-f614-498f-a8d6-f265a23bdf76.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/99/270a4c71-af6e-4e69-b6dd-94156d128dc6.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/93/baab62c8-eb76-4dd2-8980-3d7f0db85eff.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/8/5686c8a1-dd4b-4564-b3c7-56252c309ad6.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/125/43c6b4fb-f988-44be-b5a1-50a7a35ea3e1.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/108/3a48f43d-4e68-415a-b607-b650d1ebfc71.jpg\">\r\n </div>\r\n <div class=\"img-6xx-bg\">\r\n <img src=\"//s2.vipstatic.com/img/share/blank.png\" class=\"lazy J-mer-bigImg\" data-original=\"//a.vpimg2.com/upload/merchandise/pdcvis/2016/12/09/149/9d85bb38-02f2-494a-ac02-a7d154d1e3d3.jpg\">\r\n </div>\r\n </div>\r\n <div class=\"dc-img-con\">\r\n </div>\r\n <div class=\"dc-txt-con\">\r\n </div>\r\n</div>",
"picture": "http://172.17.8.100/images/small/commodity/nz/wy/7/1.jpg,http://172.17.8.100/images/small/commodity/nz/wy/7/2.jpg,http://172.17.8.100/images/small/commodity/nz/wy/7/3.jpg,http://172.17.8.100/images/small/commodity/nz/wy/7/4.jpg,http://172.17.8.100/images/small/commodity/nz/wy/7/5.jpg",
"price": 179,
"saleNum": 0,
"stock": 9999,
"weight": 1
},
"message": "查询成功",
"status": "0000"
}
findCommodityByKeyword

5. 根据关键词查询商品信息

接口地址：http://172.17.8.100/small/commodity/v1/findCommodityByKeyword

请求方式:GET

接口描述: 根据关键词查询商品信息，比如：高跟鞋

@RequestParam入参
Parameter 类型 描述 例子
keyword string 关键字 板鞋
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
masterPic string 缩略图
price double 价格
saleNum int 销量
出参例子
{
"result":[
{
"commodityId": 109,
"commodityName": "新款奢华镶钻镜面iphone xs max手机壳苹果7plusl软边时尚保护套",
"masterPic": "http://172.17.8.100/images/small/commodity/sjsm/sjpj/3/1.jpg",
"price": 89,
"saleNum": 0
},
{
"commodityId": 104,
"commodityName": "OPPO R17 全网通 8G+128G 美拍补光灯+美容补水仪套餐 全面屏AI智慧美颜双摄拍照手机",
"masterPic": "http://172.17.8.100/images/small/commodity/sjsm/sj/5/1.jpg",
"price": 3799,
"saleNum": 0
},
{
"commodityId": 119,
"commodityName": "斯泰克 吃鸡神器手游键盘 快捷射击辅助按键四指手机游戏 绝地求生刺激战场游戏手柄合金款 苹果安卓通用 扳机射击按键（2件装）",
"masterPic": "http://172.17.8.100/images/small/commodity/sjsm/yyyl/6/1.jpg",
"price": 39,
"saleNum": 0
},
{
"commodityId": 100,
"commodityName": "【壳膜线套餐】 苹果 iPhone XS 256G 全网通手机",
"masterPic": "http://172.17.8.100/images/small/commodity/sjsm/sj/1/1.jpg",
"price": 10069,
"saleNum": 0
},
{
"commodityId": 111,
"commodityName": "三合一充电器数据线苹果二合一拖安卓手机多用功能多头车载苹果安卓一拖三数据线Type-C铝合金编织线 土豪金",
"masterPic": "http://172.17.8.100/images/small/commodity/sjsm/sjpj/5/1.jpg",
"price": 39,
"saleNum": 0
}
],
"message": "查询成功",
"status": "0000"
}
findCommodityByCategory

6.根据二级类目查询商品信息

接口地址：http://172.17.8.100/small/commodity/v1/findCommodityByCategory

请求方式:GET

接口描述:根据二级类目查询商品信息，点击二级类目展示商品列表信息的操作，比如：女装

@RequestParam入参
Parameter 类型 描述 例子
categoryId string 二级类目id 1001004002
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result jsonObject 返回参数
result结构
Parameter 类型 描述
commodityId int 商品id
commodityName string 商品名称
masterPic string 缩略图
price double 价格
saleNum int 销量
出参例子
{
"result":[
{
"commodityId": 52,
"commodityName": "唐狮女鞋夏季女款凉鞋女士凉鞋女鞋平底女士凉拖夹脚女鞋凉鞋休闲凉鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/lx/7/1.jpg",
"price": 109,
"saleNum": 0
},
{
"commodityId": 49,
"commodityName": "唐狮女士凉鞋女鞋平底凉鞋女士凉拖露趾女鞋凉鞋休闲凉鞋女夏季女款凉鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/lx/4/1.jpg",
"price": 109,
"saleNum": 0
},
{
"commodityId": 46,
"commodityName": "新品韩版闪亮少女一字扣女士凉鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/lx/1/1.jpg",
"price": 149,
"saleNum": 0
},
{
"commodityId": 51,
"commodityName": "唐狮夏季女鞋女士凉鞋女款平底凉鞋百搭女士凉拖夹脚女凉鞋休闲凉鞋女",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/lx/6/1.jpg",
"price": 109,
"saleNum": 0
},
{
"commodityId": 48,
"commodityName": "夏季新款少女百搭一字扣女士凉鞋凉拖女鞋",
"masterPic": "http://172.17.8.100/images/small/commodity/nx/lx/3/1.jpg",
"price": 79,
"saleNum": 0
}
],
"message": "查询成功",
"status": "0000"
}
browseList

7. 我的足迹

接口地址：http://172.17.8.100/small/commodity/verify/v1/browseList

请求方式:GET

接口描述: 我的足迹，用户浏览过的商品信息列表

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestParam入参
Parameter 类型 描述 例子
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
commodityId int 商品id
userId int 用户Id
commodityName string 商品名称
masterPic string 商品缩略图
price double 商品价格
browseNum int 浏览次数
browseTime long 浏览时间
出参例子
{
"result":[
{
"browseNum": 1,
"browseTime": 1542818651000,
"commodityId": 99,
"commodityName": "字母绣花宽松女款卫衣",
"masterPic": "http://172.17.8.100/images/small/commodity/nz/wy/7/1.jpg",
"price": 179,
"userId": 12
}
],
"message": "查询成功",
"status": "0000"
}
CommodityCommentList

8. 商品评论列表

接口地址：http://172.17.8.100/small/commodity/v1/CommodityCommentList

请求方式:GET

接口描述: 商品评论列表

@RequestParam入参
Parameter 类型 描述 例子
commodityId int 商品id 10
page int 当前页 1
count int 当前页显示数据条数 5
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
commodityId int 商品id
userId int 用户Id
headPic string 用户头像
nickName string 用户昵称
content string 评论内容
image string 评论图片
createTime long 评论时间
出参例子
{
"result":[
{
"commodityId": 6,
"content": "好用不贵，经济实惠",
"createTime": 1542641122000,
"headPic": "http://172.17.8.100/images/small/head_pic/2018-11-17/20181117120315.jpg",
"image": "http://172.17.8.100/images/small/comment_pic/2018-11-19/4326920181119092522.jpg,http://172.17.8.100/images/small/comment_pic/2018-11-19/1285020181119092522.jpg",
"nickName": "风情的人",
"userId": 1
}
],
"message": "查询成功",
"status": "0000"
}
addCommodityComment

9. 商品评论

接口地址：http://172.17.8.100/small/commodity/verify/v1/addCommodityComment

请求方式:POST

接口描述: 商品评论，商品评论的入口在订单待评论里,用户在未确认收货时，不能对商品进行评论

@RequestHeader入参
Parameter 类型 描述 例子
userId int 用户ID 18
sessionId string 用户登陆凭证 15320748258726
@RequestBody入参
Parameter 类型 描述 例子
commodityId int 商品id 10
orderId string 订单id 1016454653
content string 评论内容 不错
image file 评论图片 支持多图
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
出参例子
{
"message": "评论成功",
"status": "0000"
}
findFirstCategory

10.查询一级商品类目

接口地址：http://172.17.8.100/small/commodity/v1/findFirstCategory

请求方式:GET

接口描述:查询一级商品类目，用于展示商品一级类目

接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
id string 一级类目id
name string 类目名称
出参例子
{

}
findUserWallet

11.查询二级商品类目

接口地址：http://172.17.8.100/small/commodity/v1/findSecondCategory

请求方式:GET

接口描述:查询二级商品类目，根据商品一级类目，查看其下的二级类目

@RequestParam入参
Parameter 类型 描述 例子
firstCategoryId string 一级类目id 1001002
接口出参
Parameter 类型 描述
status string 状态
message string 提示消息
result JSONObject 返回结果
result结构
Parameter 类型 描述
id string 二级类目id
name string 类目名称
出参例子
{
"result":[
{
"id": "1001004001",
"name": "高跟鞋"
},
{
"id": "1001004002",
"name": "帆布鞋"
},
{
"id": "1001004003",
"name": "豆豆鞋"
},
{
"id": "1001004004",
"name": "板鞋"
},
{
"id": "1001004005",
"name": "凉鞋"
}
],
"message": "查询成功",
"status": "0000"
}

猜你喜欢

转载自blog.csdn.net/weixin_34277853/article/details/87319227
今日推荐
美国拟限制 AI 大模型出口中国和俄罗斯
苹果将与 OpenAI 达成协议，将 ChatGPT 应用于 iPhone
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
报告：Django 仍然是 74% 开发者的首选
《2024 年一季度互联网投融资运行情况》研究报告
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
周排行
curl的POST请求，封装方法
8.1.1. Integer Types
Java基础 Day05(个人复习整理)
Python - Django - 中间件 process_exception
小L的试卷
【Shell编程】 （函数）判断用户是否存在
python(css样式)
spring ant path 匹配原则 - 【笔记】
《JavaScript与JScript从入门到精通》(美)James.Jaworski.中译本.扫描版.pdf
Eclipse运行带参数的java程序
每日归档
更多
2024-05-12(0)
2024-05-11(38)
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022