跳到主要内容

收货地址

添加地址​

创建新的收货地址。

  • URL：/app-api/member/address/create
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
userIdLong必传用户编号
provinceString-省
cityString-市
districtString-区
nameString-姓名
mobileString-电话
areaIdLong-地区编号
detailAddressString-地址详情
defaultStatusBoolean-是否默认地址，true 是，false 否

请求示例​

{
    "userId": 248,
    "province": "北京市",
    "city": "城市",
    "district": "区",
    "name": "收件人名称",
    "mobile": "手机号",
    "areaId": 1111,
    "detailAddress": "收件详细地址",
    "defaultStatus": true
}

响应示例​

{
    "code": 200,
    "data": 25,
    "msg": "成功"
}

响应说明​

参数类型说明
dataLong地址数据编号

更新地址​

修改已有的收货地址信息。

  • URL：/app-api/member/address/update
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
idLong必传数据编号
userIdLong-用户编号
provinceString-省
cityString-市
districtString-区
nameString-姓名
mobileString-电话
areaIdLong-地区编号
detailAddressString-地址详情
defaultStatusBoolean-是否默认地址，true 是，false 否
说明

需要修改什么字段，就传对应的的字段。

请求示例​

{
    "id": 25,
    "userId": 248,
    "province": "北京市",
    "city": "城市1",
    "district": "区1",
    "name": "收件人名称1",
    "mobile": "手机号1",
    "areaId": 1111,
    "detailAddress": "收件详细地址1",
    "defaultStatus": false
}

响应示例​

{
    "code": 200,
    "data": true,
    "msg": "成功"
}

响应说明​

参数类型说明
dataBooleantrue 成功，false 失败

删除地址​

删除指定的收货地址。

  • URL：/app-api/member/address/delete
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
idLong必传数据编号
userIdLong必传用户编号

请求示例​

{
    "id": 25,
    "userId": 248
}

响应示例​

{
    "code": 200,
    "data": true,
    "msg": "成功"
}

响应说明​

参数类型说明
dataBooleantrue 成功，false 失败

获取地址详情​

获取指定收货地址的详细信息。

  • URL：/app-api/member/address/get
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
idLong必传数据编号
userIdLong必传用户编号

请求示例​

{
    "id": 25,
    "userId": 248
}

响应示例​

{
    "code": 200,
    "data": {
        "userId": 248,
        "name": "收件人名称1",
        "mobile": "手机号1",
        "areaId": 110101,
        "detailAddress": "收件详细地址1",
        "defaultStatus": false,
        "province": "北京市",
        "city": "城市1",
        "district": "区1",
        "id": 25,
        "areaName": "北京 北京市 东城区"
    },
    "msg": "成功"
}

响应说明​

参数类型说明
idLong数据编号
userIdLong用户编号
provinceString省
cityString市
districtString区
nameString姓名
mobileString电话
areaIdLong地区编号
detailAddressString地址详情
defaultStatusBoolean是否默认地址
areaNameString地区全称

获取用户地址列表​

获取当前用户的所有收货地址列表。

  • URL：/app-api/member/address/list
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
userIdLong必传用户编号

请求示例​

{
    "userId": 248
}

响应示例​

{
    "code": 200,
    "data": [
        {
            "userId": 248,
            "name": "芋头",
            "mobile": "15601691234",
            "areaId": 110101,
            "detailAddress": "灌灌灌灌灌",
            "defaultStatus": false,
            "province": null,
            "city": null,
            "district": null,
            "id": 24,
            "areaName": "北京 北京市 东城区"
        },
        {
            "userId": 248,
            "name": "收件人名称1",
            "mobile": "手机号1",
            "areaId": 110101,
            "detailAddress": "收件详细地址1",
            "defaultStatus": false,
            "province": "北京市",
            "city": "城市1",
            "district": "区1",
            "id": 25,
            "areaName": "北京 北京市 东城区"
        }
    ],
    "msg": "成功"
}

响应说明​

参数类型说明
idLong数据编号
userIdLong用户编号
provinceString省
cityString市
districtString区
nameString姓名
mobileString电话
areaIdLong地区编号
detailAddressString地址详情
defaultStatusBoolean是否默认地址
areaNameString地区全称

获取默认地址​

获取用户的默认收货地址。

  • URL：/app-api/member/address/get-default
  • Method：POST
  • 需要登录：是
  • 需要鉴权：是

请求参数​

参数类型约束说明
userIdLong必传用户编号

请求示例​

{
    "userId": 248
}

响应示例​

存在默认地址时：

{
    "code": 200,
    "data": {
        "userId": 248,
        "name": "收件人名称1",
        "mobile": "手机号1",
        "areaId": 110101,
        "detailAddress": "收件详细地址1",
        "defaultStatus": false,
        "province": "北京市",
        "city": "城市1",
        "district": "区1",
        "id": 25,
        "areaName": "北京 北京市 东城区"
    },
    "msg": "成功"
}

没有默认地址时，data 返回 null：

{
    "code": 200,
    "data": null,
    "msg": "成功"
}

响应说明​

参数类型说明
dataObject地址对象，无默认地址时返回 null

获取三级联动数据​

  • URL：/app-api/system/area/tree
  • Method：GET
  • 需要鉴权：否

请求参数​

无请求参数。

请求示例​

GET /app-api/system/area/tree

响应示例​

{
    "code": 0,
    "data": [
        {
            "id": 110000,
            "name": "北京市",
            "children": [
                {
                    "id": 110100,
                    "name": "北京市",
                    "children": [
                        { "id": 110101, "name": "东城区" },
                        { "id": 110102, "name": "西城区" }
                    ]
                }
            ]
        }
    ],
    "msg": "成功"
}

响应说明​

参数类型说明
idLong区域编号
nameString区域名称
childrenArray子级区域列表，叶子节点无此字段