电商生鲜网站开发（接口文档）

已于 2022-08-26 15:59:01 修改
阅读量1.9k 收藏 13
点赞数
分类专栏： web java 文章标签： java http restful
于 2022-03-09 20:01:44 首次发布
转载请注明原创链接
本文链接：https://blog.csdn.net/a2272062968/article/details/123385857
版权
java 同时被 2 个专栏收录
99 篇文章 36 订阅
订阅专栏
web
62 篇文章 3 订阅
订阅专栏

Spring Boot 生鲜电商项目接口文档

用户模块

注册新用户

请求地址/register
请求方式POST

参数

参数参数含义示例备注
userName用户名xiaomu
password密码12345678

请求示例

/register?userName=xiaomu&password=12345678

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

登录

请求地址/login
请求方式POST

参数

参数参数含义示例备注
userName用户名xiaomu
password密码12345678

请求示例

/login?userName=xiaomu&password=12345678

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "id": 9,
        "username": "xiaomu2",
        "password": null,
        "personalizedSignature": "祝你今天好心情",
        "role": 2,
        "createTime": "2020-02-09T12:39:47.000+0000",
        "updateTime": "2020-02-10T16:56:02.000+0000"
    }
}

更新个性签名

请求地址/user/update
请求方式POST

参数

参数参数含义示例备注
signature更新的签名内容更新了我的签名

请求示例

/user/update?signature=更新了我的签名

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

退出登录

请求地址/user/logout
请求方式POST

参数

参数参数含义示例备注
无

请求示例

/user/logout

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

管理员登录

请求地址/adminLogin
请求方式POST

参数

参数参数含义示例备注
userName用户名xiaomu
password密码12345678

请求示例

/adminLogin?userName=xiaomu&password=12345678

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "id": 9,
        "username": "xiaomu2",
        "password": null,
        "personalizedSignature": "祝你今天好心情",
        "role": 2,
        "createTime": "2020-02-09T12:39:47.000+0000",
        "updateTime": "2020-02-10T16:56:02.000+0000"
    }
}

商品分类模块

后台管理：

增加目录分类

请求地址/admin/category/add
请求方式POST

参数

参数参数含义示例备注
name目录名新鲜水果
type目录层级1不超过3级
parentId父目录的ID21级目录的parentId为0
orderNum排序5同级目录的排序

请求示例

/admin/category/add

body：

{"name":"食品","type":1,"parentId":0,"orderNum":1}

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

更新目录分类

请求地址/admin/category/update
请求方式POST

参数

参数参数含义示例备注
id目录的id4
name目录名新鲜水果
type目录层级1不超过3级
parentId父目录的ID21级目录的parentId为0
orderNum排序5同级目录的排序

请求示例

/admin/category/update

body：

{"id":"1","name":"食品品品品","type":1,"parentId":0,"orderNum":1}

返回示例


{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

删除分类

请求地址/admin/category/delete
请求方式POST

参数

参数参数含义示例备注
id目录的id4

请求示例

/admin/category/delete?id=1

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

分类列表（平铺）

请求地址/admin/category/list?pageNum=1&pageSize=10
请求方式GET

参数

参数参数含义示例备注
pageNum页数1
pageSize每页条数10

请求示例

/admin/category/list?pageNum=1&pageSize=10

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "total": 19,
        "list": [
            {
                "id": 3,
                "name": "新鲜水果",
                "type": 1,
                "parentId": 0,
                "orderNum": 1,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T09:11:26.000+0000"
            },
            {
                "id": 5,
                "name": "海鲜水产",
                "type": 1,
                "parentId": 0,
                "orderNum": 2,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:20.000+0000"
            },
            {
                "id": 6,
                "name": "精选肉类",
                "type": 1,
                "parentId": 0,
                "orderNum": 3,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:21.000+0000"
            },
            {
                "id": 9,
                "name": "冷饮冻食",
                "type": 1,
                "parentId": 0,
                "orderNum": 4,
                "createTime": "2019-12-20T05:45:28.000+0000",
                "updateTime": "2019-12-28T08:25:22.000+0000"
            },
            {
                "id": 10,
                "name": "蔬菜蛋品",
                "type": 1,
                "parentId": 0,
                "orderNum": 5,
                "createTime": "2019-12-20T05:45:28.000+0000",
                "updateTime": "2019-12-28T08:25:23.000+0000"
            },
            {
                "id": 27,
                "name": "美味菌菇",
                "type": 1,
                "parentId": 0,
                "orderNum": 7,
                "createTime": "2019-12-20T05:45:28.000+0000",
                "updateTime": "2020-02-10T15:20:36.000+0000"
            },
            {
                "id": 4,
                "name": "橘子橙子",
                "type": 2,
                "parentId": 3,
                "orderNum": 1,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:10.000+0000"
            },
            {
                "id": 7,
                "name": "螃蟹",
                "type": 2,
                "parentId": 5,
                "orderNum": 1,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:15.000+0000"
            },
            {
                "id": 17,
                "name": "冰淇淋",
                "type": 2,
                "parentId": 9,
                "orderNum": 1,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:18.000+0000"
            },
            {
                "id": 16,
                "name": "牛羊肉",
                "type": 2,
                "parentId": 6,
                "orderNum": 1,
                "createTime": "2019-12-17T17:17:00.000+0000",
                "updateTime": "2019-12-28T08:25:18.000+0000"
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "size": 10,
        "startRow": 1,
        "endRow": 10,
        "pages": 2,
        "prePage": 0,
        "nextPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
    }
}

前台：

分类列表（递归）

参数参数含义示例备注
无

请求示例

/category/list

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": [
        {
            "id": 3,
            "name": "新鲜水果",
            "type": 1,
            "parentId": 0,
            "orderNum": 1,
            "childCategory": [
                {
                    "id": 4,
                    "name": "橘子橙子",
                    "type": 2,
                    "parentId": 3,
                    "orderNum": 1,
                    "childCategory": [
                        {
                            "id": 19,
                            "name": "果冻橙",
                            "type": 3,
                            "parentId": 4,
                            "orderNum": 1,
                            "childCategory": []
                        }
                    ]
                },
                {
                    "id": 11,
                    "name": "草莓",
                    "type": 2,
                    "parentId": 3,
                    "orderNum": 2,
                    "childCategory": []
                },
                {
                    "id": 12,
                    "name": "奇异果",
                    "type": 2,
                    "parentId": 3,
                    "orderNum": 3,
                    "childCategory": []
                },
                {
                    "id": 14,
                    "name": "车厘子",
                    "type": 2,
                    "parentId": 3,
                    "orderNum": 4,
                    "childCategory": []
                },
                {
                    "id": 28,
                    "name": "其他水果",
                    "type": 2,
                    "parentId": 3,
                    "orderNum": 4,
                    "childCategory": []
                }
            ]
        },
        {
            "id": 5,
            "name": "海鲜水产",
            "type": 1,
            "parentId": 0,
            "orderNum": 2,
            "childCategory": [
                {
                    "id": 7,
                    "name": "螃蟹",
                    "type": 2,
                    "parentId": 5,
                    "orderNum": 1,
                    "childCategory": []
                },
                {
                    "id": 8,
                    "name": "鱼类",
                    "type": 2,
                    "parentId": 5,
                    "orderNum": 2,
                    "childCategory": []
                },
                {
                    "id": 13,
                    "name": "海参",
                    "type": 2,
                    "parentId": 5,
                    "orderNum": 3,
                    "childCategory": []
                }
            ]
        },
        {
            "id": 6,
            "name": "精选肉类",
            "type": 1,
            "parentId": 0,
            "orderNum": 3,
            "childCategory": [
                {
                    "id": 16,
                    "name": "牛羊肉",
                    "type": 2,
                    "parentId": 6,
                    "orderNum": 1,
                    "childCategory": []
                }
            ]
        },
        {
            "id": 9,
            "name": "冷饮冻食",
            "type": 1,
            "parentId": 0,
            "orderNum": 4,
            "childCategory": [
                {
                    "id": 17,
                    "name": "冰淇淋",
                    "type": 2,
                    "parentId": 9,
                    "orderNum": 1,
                    "childCategory": []
                }
            ]
        },
        {
            "id": 10,
            "name": "蔬菜蛋品",
            "type": 1,
            "parentId": 0,
            "orderNum": 5,
            "childCategory": [
                {
                    "id": 18,
                    "name": "蔬菜综合",
                    "type": 2,
                    "parentId": 10,
                    "orderNum": 1,
                    "childCategory": []
                }
            ]
        },
        {
            "id": 27,
            "name": "美味菌菇",
            "type": 1,
            "parentId": 0,
            "orderNum": 7,
            "childCategory": [
                {
                    "id": 15,
                    "name": "火锅食材",
                    "type": 2,
                    "parentId": 27,
                    "orderNum": 5,
                    "childCategory": []
                }
            ]
        }
    ]
}

商品模块

后台管理：

增加商品

请求地址/admin/product/add
请求方式POST

参数

参数参数含义示例备注
name商品名称猕猴桃
categoryId目录ID5
price价格1000单位是分
stock库存10
detail商品描述新西兰黄心，黄金奇异果
image商品图片http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png

请求示例

/admin/product/add

body：

{"name":"猕猴桃","categoryId":5,"price":1000,"stock":10,"status":1,"detail":"新西兰黄心，黄金奇异果","image":"http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png"}

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

上传图片

请求地址/admin/upload/file
请求方式POST

参数：

body 的类型是 form-data，key 是 file，value 是里传 file 类型的文件：
在这里插入图片描述

返回:

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": "http://127.0.0.1:8082/upload/b899f512-3467-4c71-8d2d-2d491b21f429.png"
}

更新商品

请求地址/admin/product/update
请求方式POST

参数

参数参数含义示例备注
id商品ID1
name商品名称猕猴桃
categoryId目录ID5
price价格1000单位是分
stock库存10
detail商品描述新西兰黄心，黄金奇异果
image商品图片http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png

请求示例

/admin/product/add

body：

{"id":3,"name":"早餐小面包 3","categoryId":5,"price":1000,"stock":10,"status":1,"detail":"好吃的小面包","image":"http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png"}

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

删除商品

请求地址/admin/product/delete
请求方式POST

参数

参数参数含义示例备注
id商品的id1

请求示例

/admin/product/delete?id=1

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

批量上下架商品

请求地址/admin/product/delete
请求方式POST

参数

参数参数含义示例备注
ids要更改的商品的id1,2,4数组
sellStatus上下架状态11是上架，0是下架

请求示例

/admin/product/batchUpdateSellStatus?ids=1,2,4&sellStatus=1

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

商品列表(后台）

请求地址/admin/product/list
请求方式GET

参数

参数参数含义示例备注
pageNum页数1默认会按照修改时间倒序
pageSize每页条数10

请求示例

/admin/product/list?pageSize=5&pageNum=1

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "total": 20,
        "list": [
            {
                "id": 40,
                "name": "胡萝卜",
                "image": "http://127.0.0.1:8083/images/huluobo.jpg",
                "detail": "商品名称：绿鲜知胡萝卜商品编号：4116192商品毛重：1.07kg商品产地：北京包装：简装分类：萝卜烹饪建议：火锅，炒菜，炖菜",
                "categoryId": 18,
                "price": 222,
                "stock": 222,
                "status": 1,
                "createTime": "2019-12-28T08:06:34.000+0000",
                "updateTime": "2020-02-10T16:53:25.000+0000"
            }
        ],
        "pageNum": 1,
        "pageSize": 1,
        "size": 1,
        "startRow": 1,
        "endRow": 1,
        "pages": 20,
        "prePage": 0,
        "nextPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 8
    }
}

前台：

商品列表

请求地址/product/list
请求方式GET

参数

参数参数含义示例备注
orderBy排序方式price descprice desc 或者 price asc
categoryId商品分类 Id1
keyword搜索的关键词桃
pageNum页数1
pageSize每页条数10

请求示例

/product/list?orderBy=price desc&categoryId=4

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "total": 20,
        "list": [
            {
                "id": 2,
                "name": "澳洲进口大黑车厘子大樱桃包甜黑樱桃大果多汁 500g 特大果",
                "image": "http://127.0.0.1:8083/images/chelizi2.jpg",
                "detail": "商品毛重：1.0kg货号：608323093445原产地：智利类别：美早热卖时间：1月，11月，12月国产/进口：进口售卖方式：单品",
                "categoryId": 14,
                "price": 50,
                "stock": 100,
                "status": 1,
                "createTime": "2019-12-18T08:08:15.000+0000",
                "updateTime": "2020-02-10T16:08:25.000+0000"
            },
            {
                "id": 3,
                "name": "茶树菇 美味菌菇 东北山珍 500g",
                "image": "http://127.0.0.1:8083/images/chashugu.jpg",
                "detail": "商品名：茶树菇 商品特点：美味菌菇 东北山珍 500g",
                "categoryId": 15,
                "price": 1000,
                "stock": 6,
                "status": 1,
                "createTime": "2019-12-18T08:10:50.000+0000",
                "updateTime": "2020-02-10T16:42:42.000+0000"
            },
            {
                "id": 14,
                "name": "Zespri佳沛 新西兰阳光金奇异果 6个装",
                "image": "http://127.0.0.1:8083/images/mihoutao2.jpg",
                "detail": "商品编号：4635056商品毛重：0.71kg商品产地：新西兰类别：金果包装：简装国产/进口：进口原产地：新西兰",
                "categoryId": 12,
                "price": 39,
                "stock": 77,
                "status": 1,
                "createTime": "2019-12-18T08:11:13.000+0000",
                "updateTime": "2020-02-10T15:36:48.000+0000"
            },
            {
                "id": 17,
                "name": "红颜奶油草莓 约重500g/20-24颗 新鲜水果",
                "image": "http://127.0.0.1:8083/images/caomei2.jpg",
                "detail": "商品毛重：0.58kg商品产地：丹东/南通/武汉类别：红颜草莓包装：简装国产/进口：国产",
                "categoryId": 11,
                "price": 99,
                "stock": 84,
                "status": 1,
                "createTime": "2019-12-18T08:11:13.000+0000",
                "updateTime": "2020-02-10T15:37:48.000+0000"
            },
            {
                "id": 21,
                "name": "智利原味三文鱼排（大西洋鲑）240g/袋 4片装",
                "image": "http://127.0.0.1:8083/images/sanwenyu2.jpg",
                "detail": "商品毛重：260.00g商品产地：中国大陆保存状态：冷冻国产/进口：进口包装：简装类别：三文鱼海水/淡水：海水烹饪建议：煎炸，蒸菜，烧烤原产地：智利",
                "categoryId": 8,
                "price": 499,
                "stock": 1,
                "status": 1,
                "createTime": "2019-12-28T07:13:07.000+0000",
                "updateTime": "2020-02-10T15:38:46.000+0000"
            },
            {
                "id": 22,
                "name": "即食海参大连野生辽刺参 新鲜速食 特级生鲜海产 60~80G",
                "image": "http://127.0.0.1:8083/images/haishen.jpg",
                "detail": "商品毛重：1.5kg商品产地：中国大陆贮存条件：冷冻重量：50-99g国产/进口：国产适用场景：养生滋补包装：袋装原产地：辽宁年限：9年以上等级：特级食品工艺：冷冻水产热卖时间：9月类别：即食海参固形物含量：70%-90%特产品类：大连海参售卖方式：单品",
                "categoryId": 13,
                "price": 699,
                "stock": 3,
                "status": 1,
                "createTime": "2019-12-28T07:16:29.000+0000",
                "updateTime": "2020-02-10T16:04:29.000+0000"
            },
            {
                "id": 23,
                "name": "澳大利亚直采鲜橙 精品澳橙12粒 单果130-180g",
                "image": "http://127.0.0.1:8083/images/chengzi.jpg",
                "detail": "商品毛重：2.27kg商品产地：澳大利亚类别：脐橙包装：简装国产/进口：进口原产地：澳大利亚",
                "categoryId": 4,
                "price": 12,
                "stock": 12,
                "status": 1,
                "createTime": "2019-12-28T08:02:13.000+0000",
                "updateTime": "2020-02-10T16:40:15.000+0000"
            },
            {
                "id": 24,
                "name": "智利帝王蟹礼盒装4.4-4.0斤/只 生鲜活鲜熟冻大螃蟹",
                "image": "http://127.0.0.1:8083/images/diwangxie.jpg",
                "detail": "商品毛重：3.0kg商品产地：智利大闸蟹售卖方式：公蟹重量：2000-4999g套餐份量：5人份以上国产/进口：进口海水/淡水：海水烹饪建议：火锅，炒菜，烧烤，刺身，加热即食包装：简装原产地：智利保存状态：冷冻公单蟹重：5.5两及以上分类：帝王蟹特产品类：其它售卖方式：单品",
                "categoryId": 7,
                "price": 222,
                "stock": 222,
                "status": 1,
                "createTime": "2019-12-28T08:06:34.000+0000",
                "updateTime": "2020-02-10T16:05:05.000+0000"
            },
            {
                "id": 25,
                "name": "新疆库尔勒克伦生无籽红提 国产新鲜红提葡萄 提子 5斤装",
                "image": "http://127.0.0.1:8083/images/hongti.jpg",
                "detail": "商品毛重：2.5kg商品产地：中国大陆货号：XZL201909002重量：2000-3999g套餐份量：2人份国产/进口：国产是否有机：非有机单箱规格：3个装，4个装，5个装类别：红提包装：简装原产地：中国大陆售卖方式：单品",
                "categoryId": 28,
                "price": 222,
                "stock": 222,
                "status": 1,
                "createTime": "2019-12-28T08:06:34.000+0000",
                "updateTime": "2020-02-10T16:44:05.000+0000"
            },
            {
                "id": 26,
                "name": "越南进口红心火龙果 4个装 红肉中果 单果约330-420g",
                "image": "http://127.0.0.1:8083/images/hongxinhuolongguo.jpg",
                "detail": "商品毛重：1.79kg商品产地：越南重量：1000-1999g类别：红心火龙果包装：简装国产/进口：进口",
                "categoryId": 28,
                "price": 222,
                "stock": 222,
                "status": 1,
                "createTime": "2019-12-28T08:06:34.000+0000",
                "updateTime": "2020-02-10T16:44:11.000+0000"
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "size": 10,
        "startRow": 1,
        "endRow": 10,
        "pages": 2,
        "prePage": 0,
        "nextPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
    }
}

商品详情

请求地址/product/detail
请求方式GET

参数

参数参数含义示例备注
id商品ID2

请求示例

/product/detail?id=2

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "id": 2,
        "name": "澳洲进口大黑车厘子大樱桃包甜黑樱桃大果多汁 500g 特大果",
        "image": "http://127.0.0.1:8083/images/chelizi2.jpg",
        "detail": "商品毛重：1.0kg货号：608323093445原产地：智利类别：美早热卖时间：1月，11月，12月国产/进口：进口售卖方式：单品",
        "categoryId": 14,
        "price": 50,
        "stock": 100,
        "status": 1,
        "createTime": "2019-12-18T08:08:15.000+0000",
        "updateTime": "2020-02-10T16:08:25.000+0000"
    }
}

购物车模块（都是前台的）

1 购物车列表

请求地址/cart/list
请求方式GET

参数

参数参数含义示例备注
无

请求示例

/cart/list

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": [
        {
            "id": 5,
            "productId": 3,
            "userId": 9,
            "quantity": 1,
            "selected": 1,
            "price": 1000,
            "totalPrice": 1000,
            "productName": "茶树菇 美味菌菇 东北山珍 500g",
            "productImage": "http://127.0.0.1:8083/images/chashugu.jpg"
        }
    ]
}

2 添加商品到购物车

请求地址/cart/add
请求方式POST

参数

参数参数含义示例备注
productId商品ID5
count数量1

请求示例

/cart/add?productId=5&count=1

返回的是“购物车列表”

3 更新购物车某个商品的数量

请求地址/cart/update
请求方式POST

参数

参数参数含义示例备注
productId商品ID5
count数量1

请求示例

/cart/update?productId=5&count=1

返回的是“购物车列表”

4 删除购物车的某个商品

请求地址/cart/delete
请求方式POST

参数

参数参数含义示例备注
productId商品ID5

请求示例

/cart/delete?productId=5

返回的是“购物车列表”

5 选中/不选中购物车的某个商品

请求地址/cart/select
请求方式POST

参数

参数参数含义示例备注
productId商品ID5
selected是否选中10 是不选中，1 是选中

请求示例

/cart/select?productId=2&selected=1

返回的是“购物车列表”

6 全选/全不选购物车的某个商品

请求地址/cart/selectAll
请求方式POST

参数

参数参数含义示例备注
selected是否选中10 是不选中，1 是选中

请求示例

/cart/selectAll?selected=1

返回的是“购物车列表”

订单模块

前台显示

前台：创建订单

请求地址/order/create
请求方式POST

参数

参数参数含义示例备注
receiverName收件人姓名小慕
receiverMobile收件人电话18888888888
receiverAddress收件人地址中国慕城

请求示例

/order/create

body:

{"receiverName":"小慕","receiverMobile":"18888888888","receiverAddress":"中国慕城"}
这三个参数都是必传

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": orderNo
}

前台：订单详情

请求地址/order/detail
请求方式GET

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/order/detail?orderNo=101442166222

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "orderNo": "116214445684",
        "userId": 9,
        "totalPrice": 1000,
        "receiverName": "小慕",
        "receiverMobile": "18888888888",
        "receiverAddress": "中国慕城",
        "orderStatus": 10,
        "postage": 0,
        "paymentType": 1,
        "deliveryTime": null,
        "payTime": null,
        "endTime": null,
        "createTime": "2020-02-11T08:21:44.000+0000",
        "orderItemVOList": [
            {
                "orderNo": "116214445684",
                "productName": "茶树菇 美味菌菇 东北山珍 500g",
                "productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
                "unitPrice": 1000,
                "quantity": 1,
                "totalPrice": 1000
            }
        ],
        "orderStatusName": "未付款（初始状态）"
    }
}

前台：订单列表

请求地址/order/list
请求方式GET
参数参数含义示例备注
pageNum页数1
pageSize每页条数10

请求示例

/order/list?pageNum=1&pageSize=10

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "total": 1,
        "list": [
            {
                "orderNo": "116214445684",
                "userId": 9,
                "totalPrice": 1000,
                "receiverName": "小慕",
                "receiverMobile": "18888888888",
                "receiverAddress": "中国慕城",
                "orderStatus": 10,
                "postage": 0,
                "paymentType": 1,
                "deliveryTime": null,
                "payTime": null,
                "endTime": null,
                "createTime": "2020-02-11T08:21:44.000+0000",
                "orderItemList": [
                    {
                        "orderNo": "116214445684",
                        "productName": "茶树菇 美味菌菇 东北山珍 500g",
                        "productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
                        "unitPrice": 1000,
                        "quantity": 1,
                        "totalPrice": 1000
                    }
                ],
                "orderStatusName": "未付款（初始状态）"
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "size": 1,
        "startRow": 1,
        "endRow": 1,
        "pages": 1,
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1
    }
}

前台：取消订单

请求地址/order/cancel
请求方式POST

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/order/cancel?orderNo=101442166222

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

生成支付二维码

在支付的时候显示的二维码

请求地址/order/qrcode
请求方式POST

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/order/cancel?orderNo=101442166222

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": "127.0.0.1:8082/images/101442166222.png"
}

前台：支付订单

请求地址/pay
请求方式GET

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/pay?orderNo=101442166222

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

后台管理

后台：订单列表

请求地址/admin/order/list
请求方式GET

参数参数含义示例备注
pageNum页数1
pageSize每页条数10

请求示例

/admin/order/list?pageNum=1&pageSize=10

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": {
        "total": 1,
        "list": [
            {
                "orderNo": "116214445684",
                "userId": 9,
                "totalPrice": 1000,
                "receiverName": "小慕",
                "receiverMobile": "18888888888",
                "receiverAddress": "中国慕城",
                "orderStatus": 10,
                "postage": 0,
                "paymentType": 1,
                "deliveryTime": null,
                "payTime": null,
                "endTime": null,
                "createTime": "2020-02-11T08:21:44.000+0000",
                "orderItemList": [
                    {
                        "orderNo": "116214445684",
                        "productName": "茶树菇 美味菌菇 东北山珍 500g",
                        "productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
                        "unitPrice": 1000,
                        "quantity": 1,
                        "totalPrice": 1000
                    }
                ],
                "orderStatusName": "未付款（初始状态）"
            }
        ],
        "pageNum": 1,
        "pageSize": 1,
        "size": 1,
        "startRow": 0,
        "endRow": 0,
        "pages": 1,
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1
    }
}

后台：订单发货

请求地址/admin/order/delivered
请求方式POST

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/admin/order/delivered?orderNo=118213761282

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}

前后台通用

订单完结

请求地址/order/finish
请求方式POST

参数

参数参数含义示例备注
orderNo订单号101442166222

请求示例

/order/finish?orderNo=118213761282

返回示例

{
    "status": 10000,
    "msg": "SUCCESS",
    "data": null
}
摘星喵Pro
关注
专栏目录
电商 api 接口文档
2301_79478575的博客
08-22 179
欢迎使用ShowDoc！获取用户地址信息 简要描述： 地址信息接口 请求URL： http://xx.com/api/address 请求方式： GET 参数：无 返回示例
某电商项目接口文档
10-26
请勿下载，已不能使用！！！请勿下载，已不能使用！！！请勿下载，已不能使用！！！
电商网站开发文档
10-24
数据库设计及功能分析
电商项目的接口文档（自己用）
bianxia123456的博客
07-05 3633
1. 电商管理后台 API 接口文档 1.1. API V1 接口说明 接口基准地址：http://127.0.0.1:8888/api/private/v1/ 服务端已开启 CORS 跨域支持 API V1 认证统一使用 Token 认证 需要授权的 API ，必须在请求头中使用 Authorization 字段提供 token 令牌 使用 HTTP Status Code 标识状态 数据返回格式统一使用 JSON 1.1.1. 支持的请求方法 GET（SELECT）：从服务器取出资源（一项或多项）
电商管理后台 API 接口文档.md
07-18
电商管理后台 API 接口文档
node+express+mongodb开发电商接口文档项目（一）
VTM_k的博客
09-18 452
目标： 完成电商常用的接口文档的开发（简化版的），效果大致如下，可实际与数据库交互 涉及到的点： node express脚手架 apidoc文档生成 mongodb数据库的使用 前期的准备工作，可以看我的以下文章 项目的搭建 接口文件的生成 mongodb的安装使用 项目搭建好后，mongodb安装成功后，正式开始进行开发 前面写的接口文件并没有与数据库进行交互 一、在项目中连接数据库 （前提：数据库已开启，具体见***mongodb的安装使用***） 安装mongoose模块，封装数据库操作 cnpm
慕慕生鲜项目源码，本地版
05-25
【标题】"慕慕生鲜项目源码，本地版"揭示了这是一个与生鲜电商相关的软件项目，主要用于本地开发和运行。这个项目的源代码是公开的，可能是为了教学、学习或者协作目的。 【描述】"本地项目"表明这是一套在个人...
Java生鲜电商项目源码
05-31
【Java生鲜电商项目源码】是一个基于Java技术栈的电子商务平台，主要针对生鲜商品的在线销售。该项目采用了经典的SSM（Spring、SpringMVC、MyBatis）框架，这是一个广泛应用于企业级应用开发的组合，提供了强大的...
电商平台项目实例设计文档功能清单RP原型DB定义书.zip
03-28
电商平台平台集成接口开发任务清单.xlsx 电商平台数据库定义书V1.3.xlsx 电商平台移动端APP端产品原型及说明.rp 电商平台移动端PC端原型.rp 电商平台移动端PC端页面逻辑图.pdf 电商平台移动端（APP）业务逻辑图.pdf ...
生鲜电商全套页面
06-01
在当前的数字化时代，生鲜电商已经成为线上购物领域的重要一...理解和掌握这些技术对于从事电商网站开发的人员来说至关重要。通过这个项目，开发者不仅可以提升自己的技术水平，也能更好地理解电商系统的整体运作流程。
电子商务系统开发文档
04-13
电子商务系统开发文档 电子商务系统开发文档 电子商务系统开发文档
电商管理后台 API 接口文档
01-27
电商管理后台 API 接口文档
100-电商项目开发文档.rar
05-11
浅谈javaweb三大框架和MVC设计模式。首先我们需要知道MVC模式并不是javaweb项目中独有的，MVC是一种软件工程中的一种软件架构模式，把软件系统分为三个基本部分：模型（Model）、视图（View）和控制器（Controller），即为MVC。它是一种软件设计的典范，最早为Trygve Reenskaug提出，为施乐帕罗奥多研究中心（Xerox PARC）的Smalltalk语言发明的一种软件设计模式。
商城后台接口（App）说明文档
01-11
这是商城App后台接口说明文档，很全，根据文档可以自己设计数据库，以有比较清晰的项目功能模块划分。。。
慕慕生鲜项目源码，上线版本
05-25
慕慕生鲜项目源码，上线版本
Vue+Django REST framework 打造生鲜电商项目.docx
09-26
Vue 和 Django REST framework 是当前非常流行的前端和后端技术栈，本文档旨在指导读者使用 Vue 和 Django REST framework 联合开发一个完整的生鲜电商项目。 1. 项目概述 本项目的目标是使用 Vue 作为前端框架，...
HTTP常用的动词
10-22 332
GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源） PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。 DELETE（DELETE）：从服务器删除资源。 HEAD：获取资源的元数据。 OPTIONS：获取信息，关于资源的哪些属性是...
电商API接口文档|1688API接口的接入获取获得1688商品详情it按关键字搜索商品 按图搜索1688商品（拍立淘）
最新发布
电商数据Girl的博客
11-06 255
前面讲到的关于接口的请求方式、类型、原理、安全机制等，产品经理能够简单了解一些就可以满足日常工作中的需要。接口文档是产品经理日常工作中经常会使用到的，特别是做开放平台或B端的产品经理，需要经常的看和写接口文档。那如何看接口文档呢？首先，看接口文档的场景一般是自身业务模块需要获取外部的数据，但又不想自己重新开发，寻找外部已经实现的有开放能力的供应商（包含企业内部的）。比如淘宝开放平台、微信开放平台等等，需要获取淘宝订单或者使用微信支付，不需要自己开发对应的工具，可以调用对方的开放接口。
电商项目文档
天不拘兮地不羁
09-12 4928
电商项目 1.包含主流电商业务逻辑的移动端项目 2.学习的主要目标是掌握移动端应用开发 项目准备 项目介绍 网站是中国主要的运动鞋、皮鞋网络零售网站，聚焦在垂直的鞋及其相关商品领域深耕。 凭借雄厚的资金实力和在电子商务业界的诚信积累，与Nike、Adidas、Converse、NewBalance等国际大牌深度合作。 保证了产品与专卖店同步更新，让您不出家门能最快...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

摘星喵Pro

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值