后台接口设计-收货地址模块

上级目录:收货地址模块

具体返回字段意思参见shipping收货地址表

返回状态码

1. 方法范例

  • 请求路径: /cart/list.do
  • 请求方法:GET
  • 请求参数:

  • 响应成功
  • 响应失败

2. 添加地址

  • 请求路径: /shipping/add.do
  • 请求方法:POST
  • 请求参数:
    请求体或者直接参数,需要前端自己适配全国省市区地址

receiverName,收件人
receiverPhone,收件人电话
receiverMobile,收件人手机
receiverProvince,收件人省份
receiverCity,收件人城市
receiverDistrict,收件人县或区
receiverAddress,收件人详细地址
receiverZip,收件人邮编

  • 响应成功
{
    "status": 0,
    "data": {
        "ShppingId": 36 //返回新建地址的ID
    }
}
  • 响应失败
{
    "status": 1,
    "msg": "新建地址失败"
}

3. 删除地址

  • 请求路径: /shipping/del.do
  • 请求方法:DELETE
  • 请求参数:

shippingId,地址编号

  • 响应成功
{
    "status": 0,
    "msg": "删除成功"
}
  • 响应失败
{
    "status": 1,
    "msg": "删除地址失败"
}

3. 更新状态更新地址

必须全部参数一起传过来

  • 请求路径: /shipping/update.do
  • 请求方法:PUT
  • 请求参数:

id,收货地址ID
receiverName,收件人
receiverPhone,收件人电话
receiverMobile,收件人手机
receiverProvince,收件人省份
receiverCity,收件人城市
receiverDistrict,收件人县或区
receiverAddress,收件人详细地址
receiverZip,收件人邮编

  • 响应成功
{
    "status": 0,
    "msg": "修改成功"
}
  • 响应失败
{
    "status": 1,
    "msg": "更新地址失败"
}

4. 查看具体地址

  • 请求路径: /shipping/select.do
  • 请求方法:GET
  • 请求参数:

shippingId

  • 响应成功
{
    "status": 0,
    "msg": "查询地址成功",
    "data": {
        "id": 38,
        "userId": 1,
        "receiverName": "李登印",
        "receiverPhone": "18354131190",
        "receiverMobile": "83582409",
        "receiverProvince": "山东",
        "receiverCity": "济南",
        "receiverDistrict": "章丘区",
        "receiverAddress": "高管寨",
        "receiverZip": "250209",
        "createTime": "2020-05-08T00:23:50.000+0000",
        "updateTime": "2020-05-08T00:23:50.000+0000"
    }
}
  • 响应失败
在这里插入代码片{
    "status": 1,
    "msg": "请登录之后查询"
}
{
    "status": 1,
    "msg": "查询地址失败"
}

5. 查看地址列表

  • 请求路径: /shipping/list.do
  • 请求方法:GET
  • 请求参数:

pageNum, 默认1,当前页码
pageSize,,默认10,每页大小

  • 响应成功
{
    "status": 0,
    "data": {
        "total": 3,//分页总行数
        "list": [

            {
                "id": 37,//地址编号
                "userId": 1,//用户编号
                "receiverName": "李登印",//收件人姓名
                "receiverPhone": "18354131190",//收件人电话
                "receiverMobile": "83582409",//收件人手机
                "receiverProvince": "山东",//收件人省份
                "receiverCity": "济南",//收件人城市
                "receiverDistrict": "章丘区",//收件人区或县
                "receiverAddress": "高管寨1",//收件人镇或者街道
                "receiverZip": "250209",//收件人邮编
                "createTime": "2020-05-08T00:25:16.000+0000",
                "updateTime": "2020-05-08T00:25:35.000+0000"
            },
            {
                "id": 38,
                "userId": 1,
                "receiverName": "李登印",
                "receiverPhone": "18354131190",
                "receiverMobile": "83582409",
                "receiverProvince": "山东",
                "receiverCity": "济南",
                "receiverDistrict": "章丘区",
                "receiverAddress": "高管寨",
                "receiverZip": "250209",
                "createTime": "2020-05-08T00:23:50.000+0000",
                "updateTime": "2020-05-08T00:23:50.000+0000"
            }
        ],
        "pageNum": 1,//当前页
        "pageSize": 10,//每页大小
        "size": 2,//当前页大小
        "startRow": 1,//开始行
        "endRow": 2,//结束行
        "pages": 1,//总页数
        "prePage": 0,//上一页
        "nextPage": 0,//下一页
        "isFirstPage": true,//是否是第一页
        "isLastPage": true,//是否是最后一页
        "hasPreviousPage": false,//是否有前置页
        "hasNextPage": false,//是否有后置页
        "navigatePages": 8,//不用管
        "navigatepageNums": [//不用管
            1
        ],
        "navigateFirstPage": 1,//不用管
        "navigateLastPage": 1//不用管
    }
}
  • 响应失败
{
    "status": 1,
    "msg": "请登录之后查询"
}
原创文章 243 获赞 156 访问量 2万+

猜你喜欢

转载自blog.csdn.net/weixin_43404791/article/details/105979426