文档中心 商家相关 用户收货地址

用户收货地址

1.使用场景

用户授权后,允许商家调用该接口,获取用户常用的收货地址信息。

2.接口调用说明

请求URL

https://openapi.guanaitong.tech/seller/address/getPersonAddress

HTTP请求方式
POST
Content-Type
application/x-www-form-urlencoded
输入参数说明

(1)公共参数

发送请求是必须传入公共参数,详见公共参数

(2)私有参数

参数名称 是否必须 参数类型 长度限制 描述
open_id string [32] 用户的唯一标识(针对该appid)
请求示例
POST /seller/address/getPersonAddress HTTP/1.1
Host: openapi.guanaitong.tech
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

access_token=8e925fce9c39488d0a530ef3110eec56&appsecret=1c590e639e300f96c24f802e42912224&
timestamp=1546828238&version=1.0.0&open_id=a0b9b67768d4470a6d93b348573c955c
                    
返回参数说明
参数名称 描述
code 返回码。详见错误返回码
msg 如果错误,返回错误信息。
data 如果没有错误,返回该用户的常用收货地址列表
用户收货地址对象
名称 类型 最大长度 描述
open_id string 40 唯一标识,回传字段
area string 100 省市区,格式如:上海 上海市 徐汇区
address string 254 地址,格式如:宜山路XXX号XXX室
province string 100 省名称,如:上海
province_id string 100 省的ID
city string 100 市名称,如:上海市
city_id string 100 市的ID
district string 100 区名称,如:徐汇区
district_id string 100 区县的ID
正确返回示例
{
    "code":0,
    "data":[
        {
            "open_id":"a0b9b67768d4470a6d93b348573c955c",
            "area":"北京 北京市 西城区",
            "address":"东环路XXX号XXX室",
            "province":"北京",
            "province_id":"110000",
            "city":"北京市",
            "city_id":"110100"
            "district":"西城区",
            "district_id":"110102",
        },
        {
            "open_id":"a0b9b67768d4470a6d93b348573c955c",
            "area":"上海 上海市 黄浦区",
            "address":"呼玛路XXX号XXX室",
            "province":"上海",
            "province_id":"310000",
            "city":"上海市",
            "city_id":"310100"
            "district":"黄浦区",
            "district_id":"310101",
        }
    ],
    "msg":"OK"
}
错误返回示例(开通接口,未授权状态下)
{
    "code":1001330002,
    "data":null,
    "msg":"收货地址未授权"
}