文档中心 > API类目 > 天猫国际API

tmall.hk.clearance.address.info.get (提供菜鸟清关场景使用的加密地址信息接口)

提供菜鸟清关场景使用的加密地址信息接口

公共参数

请求地址：

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
clearance_order_request	ClearanceAddressRequest	必须			请求体
└ biz_order_id Number 必须 902871651497727441 主订单号

响应参数

名称	类型	示例值	描述
response_msg	String	错误信息	错误信息
response_code	String	错误码	错误码
obj	String	{receiverMobilePhone, receiverTelephone,receiverAddress} 的RSA公钥加密后转Base64的串	返回对象， rsa公钥加密后的收件人信息，先转json再rsa加密后，转base64的字符串，解密后是json结构，包含{receiverMobilePhone, receiverTelephone,receiverAddress}三个字段
is_success	Boolean	true	调用是否成功

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallHkClearanceAddressInfoGetRequest req = new TmallHkClearanceAddressInfoGetRequest();
TmallHkClearanceAddressInfoGetRequest.ClearanceAddressRequest obj1 = new TmallHkClearanceAddressInfoGetRequest.ClearanceAddressRequest();
obj1.setBizOrderId(902871651497727441L);
req.setClearanceOrderRequest(obj1);
TmallHkClearanceAddressInfoGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<tmall_hk_clearance_address_info_get_response>
    <response_msg>错误信息</response_msg>
    <response_code>错误码</response_code>
    <obj>{receiverMobilePhone, receiverTelephone,receiverAddress} 的RSA公钥加密后转Base64的串</obj>
    <is_success>true</is_success>
</tmall_hk_clearance_address_info_get_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

我要提问

返回
顶部