文档中心 > API类目 > ICBU－物流

alibaba.onetouch.logistics.express.address.city.list (四级地址库-市)

四级地址库-市

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
param_query	AddressQueryDto	必须			请求参数
└ province_id Number 必须 310000 省ID

响应参数

名称	类型	示例值	描述
result	Result	Object	接口返回model
└ error_message String invalidate request 返回结果描述 values RegionEntity [] List<RegionEntity> 列表对象 └ area_id Number 310000 节点ID └ pinyin String shang hai 节点名称拼音 └ parent_id Number 1 上级节点ID └ name String 上海中文名称 └ level Number 2 层级 └ parent_name String China 上级节点名称 └ success Boolean true 是否成功 └ error_code Number 402 返回结果编码

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaOnetouchLogisticsExpressAddressCityListRequest req = new AlibabaOnetouchLogisticsExpressAddressCityListRequest();
AlibabaOnetouchLogisticsExpressAddressCityListRequest.AddressQueryDto obj1 = new AlibabaOnetouchLogisticsExpressAddressCityListRequest.AddressQueryDto();
obj1.setProvinceId(310000L);
req.setParamQuery(obj1);
AlibabaOnetouchLogisticsExpressAddressCityListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_onetouch_logistics_express_address_city_list_response>
    <result>
        <error_message>invalidate request</error_message>
        <values>
            <region_entity>
                <area_id>310000</area_id>
                <pinyin>shang hai</pinyin>
                <parent_id>1</parent_id>
                <name>上海</name>
                <level>2</level>
                <parent_name>China</parent_name>
            </region_entity>
        </values>
        <success>true</success>
        <error_code>402</error_code>
    </result>
</alibaba_onetouch_logistics_express_address_city_list_response>

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

ICBU－物流

alibaba.onetouch.logistics.express.address.city.list (四级地址库-市)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ