苍穹外卖-用户端接口

C端-分类接口

条件查询

基本信息

Path： /user/category/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	否	1	分类类型：1 菜品分类 2 套餐分类

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object []	非必须			item 类型: object
├─ createTime	string	非必须			format: date-time
├─ createUser	integer	非必须			format: int64
├─ id	integer	非必须			format: int64
├─ name	string	非必须
├─ sort	integer	非必须			format: int32
├─ status	integer	非必须			format: int32
├─ type	integer	非必须			format: int32
├─ updateTime	string	非必须			format: date-time
├─ updateUser	integer	非必须			format: int64
msg	string	非必须

C端-地址簿接口

新增地址

基本信息

Path： /user/addressBook

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
cityCode	string	非必须
cityName	string	非必须
consignee	string	非必须
detail	string	必须		详细地址
districtCode	string	非必须
districtName	string	非必须
id	integer	非必须			format: int64
isDefault	integer	非必须			format: int32
label	string	非必须
phone	string	必须		手机号
provinceCode	string	非必须
provinceName	string	非必须
sex	string	必须
userId	integer	非必须			format: int64

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

查询当前登录用户的所有地址信息

基本信息

Path： /user/addressBook/list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
├─ id	number	必须
├─ userId	number	必须
├─ consignee	string	必须
├─ phone	string	必须
├─ sex	string	必须
├─ provinceCode	string	必须
├─ provinceName	string	必须
├─ cityCode	string	必须
├─ cityName	string	必须
├─ districtCode	string	必须
├─ districtName	string	必须
├─ detail	string	必须
├─ label	string	必须
├─ isDefault	number	必须
msg	string	非必须

查询默认地址

基本信息

Path： /user/addressBook/default

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
├─ cityCode	string	非必须
├─ cityName	string	非必须
├─ consignee	string	非必须
├─ detail	string	非必须
├─ districtCode	string	非必须
├─ districtName	string	非必须
├─ id	integer	非必须			format: int64
├─ isDefault	integer	非必须			format: int32
├─ label	string	非必须
├─ phone	string	非必须
├─ provinceCode	string	非必须
├─ provinceName	string	非必须
├─ sex	string	非必须
├─ userId	integer	非必须			format: int64
msg	string	非必须

根据id修改地址

基本信息

Path： /user/addressBook

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
cityCode	string	非必须
cityName	string	非必须
consignee	string	非必须
detail	string	必须		详细地址
districtCode	string	非必须
districtName	string	非必须
id	integer	必须		主键值	format: int64
isDefault	integer	非必须			format: int32
label	string	非必须
phone	string	必须		手机号
provinceCode	string	非必须
provinceName	string	非必须
sex	string	必须
userId	integer	非必须			format: int64

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

根据id删除地址

基本信息

Path： /user/addressBook

Method： DELETE

接口描述：

请求参数

Query

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

根据id查询地址

基本信息

Path： /user/addressBook/{id}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	101	地址id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
data	object	必须
├─ id	number	非必须
├─ phone	string	非必须
├─ consignee	string	非必须
├─ userId	number	非必须
├─ cityCode	string	非必须
├─ provinceName	string	非必须
├─ provinceCode	string	非必须
├─ sex	string	非必须
├─ districtName	string	非必须
├─ districtCode	string	非必须
├─ cityName	string	非必须
├─ isDefault	number	非必须
├─ label	string	非必须
├─ detail	string	非必须
msg	string	非必须

设置默认地址

基本信息

Path： /user/addressBook/default

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
id	integer	必须		地址id	format: int64

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

C端-套餐浏览接口

根据分类id查询套餐

基本信息

Path： /user/setmeal/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
categoryId	是	101	分类id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object []	非必须			item 类型: object
├─ categoryId	integer	非必须			format: int64
├─ createTime	string	非必须			format: date-time
├─ createUser	integer	非必须			format: int64
├─ description	string	非必须
├─ id	integer	非必须			format: int64
├─ image	string	非必须
├─ name	string	非必须
├─ price	number	非必须
├─ status	integer	非必须			format: int32
├─ updateTime	string	非必须			format: date-time
├─ updateUser	integer	非必须			format: int64
msg	string	非必须

根据套餐id查询包含的菜品

基本信息

Path： /user/setmeal/dish/{id}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id	101	套餐id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object []	必须			item 类型: object
├─ copies	integer	必须		份数	format: int32
├─ description	string	必须		菜品描述
├─ image	string	必须		菜品图片路径
├─ name	string	必须		菜品名称
msg	string	非必须

C端-店铺操作接口

获取营业状态

基本信息

Path： /user/shop/status

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	integer	必须		店铺状态：1为营业，0为打烊	format: int32
msg	string	非必须

C端-用户接口

登录

基本信息

Path： /user/user/login

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		微信授权码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	必须
├─ id	integer	必须		用户id	format: int64
├─ openid	string	必须		微信用户openid
├─ token	string	必须		jwt令牌
msg	string	非必须

退出

基本信息

Path： /user/user/logout

Method： POST

接口描述：

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

C端-菜品浏览接口

根据分类id查询菜品

基本信息

Path： /user/dish/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
categoryId	是	101	分类id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object []	非必须			item 类型: object
├─ categoryId	integer	非必须			format: int64
├─ categoryName	string	非必须
├─ description	string	非必须
├─ flavors	object []	非必须		菜品口味	item 类型: object
├─ dishId	integer	非必须			format: int64
├─ id	integer	非必须			format: int64
├─ name	string	非必须
├─ value	string	非必须
├─ id	integer	非必须			format: int64
├─ image	string	非必须		菜品图片路径
├─ name	string	非必须		菜品名称
├─ price	number	非必须		价格
├─ status	integer	非必须			format: int32
├─ updateTime	string	非必须			format: date-time
msg	string	非必须

C端-订单接口

催单

基本信息

Path： /user/order/reminder/{id}

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

再来一单

基本信息

Path： /user/order/repetition/{id}

Method： POST

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

历史订单查询

基本信息

Path： /user/order/historyOrders

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页面
pageSize	是	10	每页记录数
status	否		订单状态

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	null	非必须
data	object	非必须
├─ total	number	非必须
├─ records	object []	非必须			item 类型: object
├─ id	number	非必须
├─ number	string	非必须
├─ status	number	非必须
├─ userId	number	非必须
├─ addressBookId	number	非必须
├─ orderTime	string	非必须
├─ checkoutTime	string	非必须
├─ payMethod	number	非必须
├─ payStatus	number	非必须
├─ amount	number	非必须
├─ remark	string	非必须
├─ userName	null	非必须
├─ phone	string	非必须
├─ address	string	非必须
├─ consignee	string	非必须
├─ cancelReason	null	非必须
├─ rejectionReason	null	非必须
├─ cancelTime	null	非必须
├─ estimatedDeliveryTime	string	非必须
├─ deliveryStatus	number	非必须
├─ deliveryTime	null	非必须
├─ packAmount	number	非必须
├─ tablewareNumber	number	非必须
├─ tablewareStatus	number	非必须
├─ orderDetailList	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ orderId	number	必须
├─ dishId	number	必须
├─ setmealId	null	必须
├─ dishFlavor	null,string	必须
├─ number	number	必须
├─ amount	number	必须
├─ image	string	必须

取消订单

基本信息

Path： /user/order/cancel/{id}

Method： PUT

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	非必须
msg	string	非必须

查询订单详情

基本信息

Path： /user/order/orderDetail/{id}

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ address	string	非必须
├─ addressBookId	integer	非必须			format: int64
├─ amount	number	非必须
├─ cancelReason	string	非必须
├─ cancelTime	string	非必须			format: date-time
├─ checkoutTime	string	非必须			format: date-time
├─ consignee	string	非必须
├─ deliveryStatus	integer	非必须			format: int32
├─ deliveryTime	string	非必须			format: date-time
├─ estimatedDeliveryTime	string	非必须			format: date-time
├─ id	integer	非必须			format: int64
├─ number	string	非必须
├─ orderDetailList	object []	非必须			item 类型: object
├─ amount	number	非必须
├─ dishFlavor	string	非必须
├─ dishId	integer	非必须			format: int64
├─ id	integer	非必须			format: int64
├─ image	string	非必须
├─ name	string	非必须
├─ number	integer	非必须			format: int32
├─ orderId	integer	非必须			format: int64
├─ setmealId	integer	非必须			format: int64
├─ orderTime	string	非必须			format: date-time
├─ packAmount	integer	非必须			format: int32
├─ payMethod	integer	非必须			format: int32
├─ payStatus	integer	非必须			format: int32
├─ phone	string	非必须
├─ rejectionReason	string	非必须
├─ remark	string	非必须
├─ status	integer	非必须			format: int32
├─ tablewareNumber	integer	非必须			format: int32
├─ tablewareStatus	integer	非必须			format: int32
├─ userId	integer	非必须			format: int64
├─ userName	string	非必须
msg	string	非必须

用户下单

基本信息

Path： /user/order/submit

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
addressBookId	integer	必须		地址簿id	format: int64
amount	number	必须		总金额
deliveryStatus	integer	必须		配送状态： 1立即送出 0选择具体时间	format: int32
estimatedDeliveryTime	string	必须		预计送达时间
packAmount	integer	必须		打包费	format: int32
payMethod	integer	必须		付款方式	format: int32
remark	string	必须		备注
tablewareNumber	integer	必须		餐具数量	format: int32
tablewareStatus	integer	必须		餐具数量状态 1按餐量提供 0选择具体数量	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	必须
├─ id	integer	必须		订单id	format: int64
├─ orderAmount	number	必须		订单金额
├─ orderNumber	string	必须		订单号
├─ orderTime	string	必须		下单时间	format: date-time
msg	string	非必须

订单支付

基本信息

Path： /user/order/payment

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
orderNumber	string	必须		订单号
payMethod	integer	必须		支付方式	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object	必须
├─ estimatedDeliveryTime	string	必须		预计送达时间	format: date-time
msg	string	非必须

C端-购物车接口

删除购物车中一个商品

基本信息

Path： /user/shoppingCart/sub

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
dishFlavor	string	非必须		口味
dishId	integer	非必须		菜品id	format: int64
setmealId	integer	非必须		套餐id	format: int64

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	string	非必须
msg	string	非必须

查看购物车

基本信息

Path： /user/shoppingCart/list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	object []	非必须			item 类型: object
├─ amount	number	非必须
├─ createTime	string	非必须			format: date-time
├─ dishFlavor	string	非必须
├─ dishId	integer	非必须			format: int64
├─ id	integer	非必须			format: int64
├─ image	string	非必须
├─ name	string	非必须
├─ number	integer	非必须			format: int32
├─ setmealId	integer	非必须			format: int64
├─ userId	integer	非必须			format: int64
msg	string	非必须

添加购物车

基本信息

Path： /user/shoppingCart/add

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
dishFlavor	string	非必须		口味
dishId	integer	非必须		菜品id	format: int64
setmealId	integer	非必须		套餐id	format: int64

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	string	非必须
msg	string	非必须

清空购物车

基本信息

Path： /user/shoppingCart/clean

Method： DELETE

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须			format: int32
data	string	非必须
msg	string	非必须