ECJiaWiki:Api:address/list

来自ECJiaWiki
跳转至: 导航搜索

应用场景

 获取用户收货地址列表

接口名称

 address/list

Header请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
设备唯一ID device-udid String a46d663d675d4858ea7d0a21c2de06e9 设备的唯一编号 1.3.0
设备客户端类型 device-client String android,iphone,h5,weapp 设备类型的描述 1.3.0
产品编号 device-code String 6015 产品编号 1.3.0
API版本 api-version String 1.6 API接口版本号 1.3.0

举例如下

{
    "device-udid" : "a46d663d675d4858ea7d0a21c2de06e9",
    "device-client" : "weapp",
    "device-code " : "6015",
    "api-version" : "1.6",
}

Body请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
token请求凭证 token String 79218f8e710fc755a222de45f43c3fd969b87972 调用接口凭证 1.3.0

举例如下

"token" : "d122e3c72332c5af12a71d77c9f1462f5901d276"

返回参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
成功状态 status status字典 返回接口请求成功状态 1.3.0
└ 是否成功 succeed Int 是否成功(1、代表成功,2、代表错误) 1.3.0
返回信息 data Array 返回信息 1.3.0
└ 是否在范围内 local Int 1范围内,0不在范围内。 1.5.0
└ 收货地址id id Int 收货地址id 1.3.0
└ 收货人名字 consignee String 收货人名字 1.3.0
└ 收货人详细地址 address String 收货人详细地址 1.3.0
└ 收货人详细地址2 address_info String 收货人详细地址(如门牌号,楼层等信息) 1.3.0
└ 国家信息 country_name String 国家信息 1.3.0
└ 省市信息 province_name String 省市信息 1.3.0
└ 城市信息 city_name String 城市信息 1.3.0
└ 区县信息 district_name String 区县信息 1.3.0
└ 街道名 street_name String 街道名 1.3.0
└ 收货人联系电话(固话) tel String 收货人联系电话(固话) 1.3.0
└ 收货人联系电话(手机) mobile String 收货人联系电话(手机) 1.3.0
└ 收货地址坐标信息 location location字典 收货地址坐标信息 1.3.0
   └ 经度 longitude String 经度 1.3.0
   └ 纬度 latitude String 纬度 1.3.0
└ 默认收货地址 set_default Int 默认收货地址(1、代表是默认收货地址,2、不默认收货地址) 1.3.0
device信息 device device字典 device信息 1.5.0
└ udid udid String udid 1.5.0
└ client client String client 1.5.0
└ code code String code 1.5.0

成功举例如下

{
    "data": [
        {
            "local" : 1,
            "id" : 297,
            "consignee" : "陈先生",
            "address"   : "伸大厦",
            "address_info" : "3楼301室",
            "country_name" : "中国",
            "province_name" : "上海",
            "city_name" : "上海",
            "district_name" : "",
            "street_name" : "",
            "tel" : "88009933",
            "mobile" : "13512345678",
            "location" : {
                "longitude" : "121.415862",
                "latitude" : "31.235242"
            },
            "default_address": 1
        }
    ],
    "status": {
        "succeed": 1
    }
}

失败举例如下

{
      "status" : {
            "succeed" : 0,
            "error_code" : 100,
            "error_desc" : "Invalid session"
      }
}


注:错误编码