淘宝开放平台

请求地址：

环境	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	ClearanceOrderRequest	可选			入参封装类型
└ biz_order_id Number 可选 1526156636621536891 交易主订单号

名称	类型	示例值	描述
response_message	String	订单已经收获	结果描述
response_code	String	CANT_GET	结果码
succeeded	Boolean	true	是否正常
obj	ClearanceDataDO		清关数据封装
biz_order_d_o ClearanceLogisticsOrderDO 订单数据封装 order_line_list ClearanceOrderLineDo [] 子订单列表封装 tax_d_o ClearanceTaxDO 税费封装 └ excise_duty_fee Number 0 消费税，主&子 └ order_line_total_tax_fee Number 4 税费，子订单 └ hscode String 3304990039 海关税收编码 └ post_fee Number 0 邮费，主&子 └ custom_duty_fee Number 0 关税，主&子 └ tariff_vat_fee Number 4 给海关的税费中的增值税，主&子 └ tariff_excise_fee Number 0 给海关的税费中的消费税，主&子 └ vat_fee Number 4 增值税，主&子 └ customs_coupon_fee Number 0 优惠，主&子 └ tariff_fee Number 4 包税包不仅，给海关的税费，主&子 └ customs_sub_total_fee Number 46 完税价，子订单 └ tariff_custom_fee Number 0 包税包不仅，给海关的税费中的关税，主&子 └ customs_insurance_fee Number 0 保费，主&子 └ actual_value Number 46 货款 unit_d_o ClearanceTaxDO 计量单位封装 └ first_quantity String 1 第一数量，最多4位小数 └ second_quantity String 1 第二数量，最多4位小数 └ first_unit String 035 第一单位，单位编码 └ second_unit String 011 第二单位，单位编码 └ sc_item_id Number 622400619032 货品id └ declaration String { "品牌": "1", "用途": "1", "品名": "1", "包装规格": "1" } 税费封装，示例："declaration": { "品牌": "1", "用途": "1", "品名": "1", "包装规格": "1" } └ sell_property String 颜色分类:桔色;尺寸:12x12cm 销售属性 └ sale_unit String 007 销售单位 └ item_id Number 677998441818 淘系商品id tax_d_o ClearanceTaxDO 税费封装 └ excise_duty_fee Number 0 消费税，主&子 └ hscode String 6204420000 海关税收编码 └ post_fee Number 0 邮费，主&子 └ custom_duty_fee Number 0 关税，主&子 └ tariff_vat_fee Number 4 包税包不仅，给海关的税费中的关税，主&子 └ tariff_excise_fee Number 0 包税包不仅，给海关的税费中的消费税，主&子 └ order_total_tax_fee Number 4 总税费，主订单 └ customs_total_fee Number 46 完税价，主订单 └ vat_fee Number 4 增值税，主&子 └ customs_coupon_fee Number 0 优惠，主&子 └ tariff_fee Number 4 包税包不仅，给海关的税费，主&子 └ tariff_custom_fee Number 0 包税包不仅，给海关的税费中的关税，主&子 └ customs_insurance_fee Number 0 保费，主&子 └ post_fee Number 0 邮费 └ buyer_id Number 2215058870252 买家id └ tf Number 50 买家实付款 └ biz_order_id Number 3435454982682875400 订单id └ clearance_order_no String 清关订单编号清关订单编号 price_unit PriceUnit 订单价格明细 └ order_discount_price Number 0 订单优惠金额 └ subsidy Number 0 平台补贴金额 └ pay_price Number 0 消费者实付金额 └ item_total_price Number 0 订单商品总价 pay_order_d_o ClearancePayOrderDO 支付单封装 └ alipay_buyer_id String 208812345 支付宝买家ID └ pay_order_id Number 202112313000 支付单号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallHkClearanceOrderGetRequest req = new TmallHkClearanceOrderGetRequest();
TmallHkClearanceOrderGetRequest.ClearanceOrderRequest obj1 = new TmallHkClearanceOrderGetRequest.ClearanceOrderRequest();
obj1.setBizOrderId(1526156636621536891L);
req.setClearanceOrderRequest(obj1);
TmallHkClearanceOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallHkClearanceOrderGetRequest req = new TmallHkClearanceOrderGetRequest();
TmallHkClearanceOrderGetRequest.ClearanceOrderRequestDomain obj1 = new TmallHkClearanceOrderGetRequest.ClearanceOrderRequestDomain();
obj1.BizOrderId = 1526156636621536891L;
req.ClearanceOrderRequest_ = obj1;
TmallHkClearanceOrderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallHkClearanceOrderGetRequest;
$clearance_order_request = new ClearanceOrderRequest;
$clearance_order_request->biz_order_id="1526156636621536891";
$req->setClearanceOrderRequest(json_encode($clearance_order_request));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=tmall.hk.clearance.order.get' \
-d 'partner_id=apidoc' \
-d 'session=e72d740f-3e75-4999-9f21-8050eec2bad3' \
-d 'sign=EA68EFD497FB219E4FC77769D3C9F75D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-24+11%3A05%3A07' \
-d 'v=2.0' \
-d 'clearance_order_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TmallHkClearanceOrderGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.clearance_order_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"tmall.hk.clearance.order.get");
add_param(pRequest,"clearance_order_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('tmall.hk.clearance.order.get', {
	'clearance_order_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_hk_clearance_order_get_response>
    <response_message>订单已经收获</response_message>
    <response_code>CANT_GET</response_code>
    <succeeded>true</succeeded>
    <obj>
        <biz_order_d_o>
            <order_line_list>
                <clearance_order_line_do>
                    <tax_d_o>
                        <excise_duty_fee>0</excise_duty_fee>
                        <order_line_total_tax_fee>4</order_line_total_tax_fee>
                        <hscode>3304990039</hscode>
                        <post_fee>0</post_fee>
                        <custom_duty_fee>0</custom_duty_fee>
                        <tariff_vat_fee>4</tariff_vat_fee>
                        <tariff_excise_fee>0</tariff_excise_fee>
                        <vat_fee>4</vat_fee>
                        <customs_coupon_fee>0</customs_coupon_fee>
                        <tariff_fee>4</tariff_fee>
                        <customs_sub_total_fee>46</customs_sub_total_fee>
                        <tariff_custom_fee>0</tariff_custom_fee>
                        <customs_insurance_fee>0</customs_insurance_fee>
                    </tax_d_o>
                    <actual_value>46</actual_value>
                    <unit_d_o>
                        <first_quantity>1</first_quantity>
                        <second_quantity>1</second_quantity>
                        <first_unit>035</first_unit>
                        <second_unit>011</second_unit>
                    </unit_d_o>
                    <sc_item_id>622400619032</sc_item_id>
                    <declaration>{ 	&quot;品牌&quot;: &quot;1&quot;, 	&quot;用途&quot;: &quot;1&quot;, 	&quot;品名&quot;: &quot;1&quot;, 	&quot;包装规格&quot;: &quot;1&quot; }</declaration>
                    <sell_property>颜色分类:桔色;尺寸:12x12cm</sell_property>
                    <sale_unit>007</sale_unit>
                    <item_id>677998441818</item_id>
                </clearance_order_line_do>
            </order_line_list>
            <tax_d_o>
                <excise_duty_fee>0</excise_duty_fee>
                <hscode>6204420000</hscode>
                <post_fee>0</post_fee>
                <custom_duty_fee>0</custom_duty_fee>
                <tariff_vat_fee>4</tariff_vat_fee>
                <tariff_excise_fee>0</tariff_excise_fee>
                <order_total_tax_fee>4</order_total_tax_fee>
                <customs_total_fee>46</customs_total_fee>
                <vat_fee>4</vat_fee>
                <customs_coupon_fee>0</customs_coupon_fee>
                <tariff_fee>4</tariff_fee>
                <tariff_custom_fee>0</tariff_custom_fee>
                <customs_insurance_fee>0</customs_insurance_fee>
            </tax_d_o>
            <post_fee>0</post_fee>
            <buyer_id>2215058870252</buyer_id>
            <tf>50</tf>
            <biz_order_id>3435454982682875400</biz_order_id>
            <clearance_order_no>清关订单编号</clearance_order_no>
            <price_unit>
                <order_discount_price>0</order_discount_price>
                <subsidy>0</subsidy>
                <pay_price>0</pay_price>
                <item_total_price>0</item_total_price>
            </price_unit>
        </biz_order_d_o>
        <pay_order_d_o>
            <alipay_buyer_id>208812345</alipay_buyer_id>
            <pay_order_id>202112313000</pay_order_id>
        </pay_order_d_o>
    </obj>
</tmall_hk_clearance_order_get_response>

{
    "tmall_hk_clearance_order_get_response":{
        "response_message":"订单已经收获",
        "response_code":"CANT_GET",
        "succeeded":true,
        "obj":{
            "biz_order_d_o":{
                "order_line_list":{
                    "clearance_order_line_do":[
                        {
                            "tax_d_o":{
                                "excise_duty_fee":0,
                                "order_line_total_tax_fee":4,
                                "hscode":"3304990039",
                                "post_fee":0,
                                "custom_duty_fee":0,
                                "tariff_vat_fee":4,
                                "tariff_excise_fee":0,
                                "vat_fee":4,
                                "customs_coupon_fee":0,
                                "tariff_fee":4,
                                "customs_sub_total_fee":46,
                                "tariff_custom_fee":0,
                                "customs_insurance_fee":0
                            },
                            "actual_value":46,
                            "unit_d_o":{
                                "first_quantity":"1",
                                "second_quantity":"1",
                                "first_unit":"035",
                                "second_unit":"011"
                            },
                            "sc_item_id":622400619032,
                            "declaration":"{ \t\"品牌\": \"1\", \t\"用途\": \"1\", \t\"品名\": \"1\", \t\"包装规格\": \"1\" }",
                            "sell_property":"颜色分类:桔色;尺寸:12x12cm",
                            "sale_unit":"007",
                            "item_id":677998441818
                        }
                    ]
                },
                "tax_d_o":{
                    "excise_duty_fee":0,
                    "hscode":"6204420000",
                    "post_fee":0,
                    "custom_duty_fee":0,
                    "tariff_vat_fee":4,
                    "tariff_excise_fee":0,
                    "order_total_tax_fee":4,
                    "customs_total_fee":46,
                    "vat_fee":4,
                    "customs_coupon_fee":0,
                    "tariff_fee":4,
                    "tariff_custom_fee":0,
                    "customs_insurance_fee":0
                },
                "post_fee":0,
                "buyer_id":2215058870252,
                "tf":50,
                "biz_order_id":3435454982682875400,
                "clearance_order_no":"清关订单编号",
                "price_unit":{
                    "order_discount_price":0,
                    "subsidy":0,
                    "pay_price":0,
                    "item_total_price":0
                }
            },
            "pay_order_d_o":{
                "alipay_buyer_id":"208812345",
                "pay_order_id":202112313000
            }
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

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

天猫国际API

tmall.hk.clearance.order.get (天猫国际订单清关信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ