文档中心 > API类目 > 收货地址API

dsc.user.address.list.get (获取收货地址列表API)

获取收货地址列表API,获取收货地址相关信息。

公共参数

请求地址:
环境 HTTP请求地址 HTTPS请求地址
正式环境 http://www.xxx.com/api.php https://www.xxx.com/api.php
公共请求参数:
名称 类型 是否必须 描述
method String API接口名称
app_key String API接口AppKey

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 可选 非唯一性 会员
mobile Number 可选 非唯一性 手机号码
page Number 可选 1 默认 列表分页当前页
page_size Number 可选 15 默认 列表分页每页显示条数
format type 必须 json json或xml 接口类型

响应参数

名称 类型 示例值 描述
address_id Number 收货地址ID
user_id Number 会员ID
consignee String 收货人名称
email String 邮箱
country Number 国家
province Number 省份
city Number 市级
district Number 县级地区
street Number 乡镇街道
address String 收货地址
zipcode String 邮编
tel String 联系电话
mobile String 手机号码
sign_building String 地点标识:公司、家里
best_time String 建议配送时间
update_time Number 更新时间

请求示例

  • PHP
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.user.address.list.get&format=xml"
$Http = new Http();
$Http->doGet($url);

响应示例

  • XML
  • JSON
<dsc>
<info>
<list>
<item id="0">
<address_id>1</address_id>
<user_id>7</user_id>
<consignee>大商创</consignee>
<country>1</country>
<province>310000</province>
<city>659009504</city>
<district>310107</district>
<street>310107014</street>
<address>中山北路3553号伸大厦3层301室</address>
<mobile>18321*****4</mobile>
<sign_building>公司</sign_building>
</item>
<item id="1">
<address_id>2</address_id>
<user_id>7</user_id>
<consignee>大商创</consignee>
<country>1</country>
<province>310000</province>
<city>659009504</city>
<district>310107</district>
<street>310107014</street>
<address>中山北路3553号伸大厦3层301室</address>
<mobile>18321*****4</mobile>
<sign_building>公司</sign_building>
</item>
</list>
</info>
<filter>
<page>1</page>
<page_size>15</page_size>
<record_count>5</record_count>
<page_count>1</page_count>
</filter>
<page_count>1</page_count>
<record_count>5</record_count>
</dsc>
{
"info": {
"list": [{
"address_id": "1",
"user_id": "7",
"consignee": "大商创",
"country": "1",
"province": "310000",
"city": "659009504",
"district": "310107",
"street": "310107014",
"address": "中山北路3553号伸大厦3层301室",
"mobile": "18321*****4",
},
{
"address_id": "2",
"user_id": "7",
"consignee": "大商创",
"country": "1",
"province": "310000",
"city": "659009504",
"district": "310107",
"street": "310107014",
"address": "中山北路3553号伸大厦3层301室",
"mobile": "18321*****4",
}],
"filter": {
"page": 1,
"page_size": 15,
"record_count": 5,
"page_count": 1
},
"page_count": 1,
"record_count": 5
}
}

异常示例

  • XML
  • JSON
<dsc>
<result>success</result>
<error>0</error>
<msg>成功获取数据</msg>
</dsc>
{
"result": "success",
"error": 0,
"msg": "成功获取数据",
}

错误码解释

错误码 错误描述 解决方案
error 返回值

0:成功获取数据

1:数据为空值

返回
顶部