淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param1	QueryShippingMethodRequestTopDTO	可选			method query object
└ trade_order_id Number 必须 3014820453131992 It's sales order id and a 16-digit number To confirm logistics service provider in the order such as Cainiao, Pegaki, Frenet, Delivery Hub, etc. sender_address AddressTopDTO 必须 12345678 origin address └ first_name String 可选 Jack first name of sender └ last_name String 可选 Bryant last name of sender └ country String 可选 Brazil sender's country └ state String 可选 Sao Paulo or SP sender's state └ city String 可选 Sao Paulo sender's city └ address String 可选 Vila Mariana, R. Azevedo Macedo sender's district and street └ address_number String 可选 113 sender's street number └ zip_code String 必须 04013060 OR 04013-060 zip code of ship from place └ cellphone String 可选 1234567890 cell phone of sender └ federal_tax_id String 可选 null cnpj of the seller and it will be filled by the platform automatcially └ email String 可选 testmail@gmail.com email of sender extension ExtensionTopDTO 必须 true extension └ invoice_added Boolean 必须 true Whether a seller has added invoice to transaction order. If a seller doesn't provide invoice, Correios will be the only available shipment option. This is mainly to remind sellers of adding invoice before shipment receipt_address AddressTopDTO 必须 12345678 destination address └ first_name String 可选 Jack first name of receiver └ last_name String 可选 Bryant last name of receiver └ country String 可选 Brazil receiver's country └ state String 可选 Sao Paulo or SP receiver's state └ city String 可选 Sao Paulo receiver's city └ address String 可选 Vila Mariana, R. Azevedo Macedo receiver's district and street └ address_number String 可选 113 receiver's street number └ zip_code String 必须 04013060 OR 04013-060 zip code of ship to place └ cellphone String 可选 1234567890 cell phone of receiver └ federal_tax_id String 可选 098.084.769-96 CPF of the buyer. Senders can find it on sales order └ email String 可选 testmail@gmail.com email of receiver products ProductTopDTO [] 必须 product list └ quantity Number 必须 1 Quantity of a sku in the order. It's used to calculate the total number of products in a parcel └ length String 必须 10 Actual dimension of a sku in its original packaging. Default unit: centimeters └ width String 必须 10 Actual dimension of a sku in its original packaging. Default unit: centimeters └ weight String 必须 1 Total weight of a SKU in its original packaging. Default unit: kilograms └ sku_id String 可选 123 AE sku_id to identify a unit of sku └ height String 必须 10 Actual dimension of a sku in its original packaging. Default unit: centimeters └ price String 必须 12 Price of a sku. It's used to compose total product value of the parcel

名称	类型	示例值	描述
data	QueryShippingMethodResponseDTO		method data
parcel ParcelDTO parcel └ weight Number 10 Weight of the parcel in the shipment order Default unit: kilograms └ width String 10 Width of the parcel in the shipment order Default unit: centimeters └ height String 10 Height of the parcel in the shipment order Default unit: centimeters └ length String 10 Length of the parcel in the shipment order Default unit: centimeters └ product_total_price String 50 price of all SKUs in the parcel └ parcel_type String BOX Parcel type including ENVELOPE, BOX, BAG, TUBE, PALLET and you should input it when creating a shipment order delivery_options AELogisticsShippingMethodDTO [] delivery option list └ logistics_channel_id String 1 Logistics provider Id of the shipping order such as 1-Cainiao, 2-Pegaki, 3-Frenet, 4-Delivery Hub, etc. └ logistics_channel_name String Pegaki Logistics provider of the shipping order such as Cainiao, Pegaki, Frenet, Delivery Hub, etc. └ delivery_method_id String 1 shipping method id of Logistics service such as Loggi Express, Correios Sedex, etc. └ delivery_method_name String Pac Devlivery provider type such as express/standard, pac/sedex. └ delivery_provider_name String Correios Delivery provider name └ delivery_cost Number 12 estimated shipping cost based on dimension and weight of a parcel └ delivery_estimate_days Number 5 delivery time on working days └ query_id String 809129783610401 query id, if the value is not empty, please fill it in create order api
is_success	String	true	is success
error_result_message	String	error1	error message
error_result_code	String	1	error code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliexpressLocalLogisticsShippingMethodQueryRequest req = new AliexpressLocalLogisticsShippingMethodQueryRequest();
AliexpressLocalLogisticsShippingMethodQueryRequest.QueryShippingMethodRequestTopDTO obj1 = new AliexpressLocalLogisticsShippingMethodQueryRequest.QueryShippingMethodRequestTopDTO();
obj1.setTradeOrderId(3014820453131992L);
AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTO obj2 = new AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTO();
obj2.setFirstName("Jack");
obj2.setLastName("Bryant");
obj2.setCountry("Brazil");
obj2.setState("Sao Paulo or SP");
obj2.setCity("Sao Paulo");
obj2.setAddress("Vila Mariana, R. Azevedo Macedo");
obj2.setAddressNumber("113");
obj2.setZipCode("04013060 OR 04013-060");
obj2.setCellphone("1234567890");
obj2.setFederalTaxId("null");
obj2.setEmail("testmail@gmail.com");
obj1.setSenderAddress(obj2);
AliexpressLocalLogisticsShippingMethodQueryRequest.ExtensionTopDTO obj3 = new AliexpressLocalLogisticsShippingMethodQueryRequest.ExtensionTopDTO();
obj3.setInvoiceAdded(true);
obj1.setExtension(obj3);
AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTO obj4 = new AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTO();
obj4.setFirstName("Jack");
obj4.setLastName("Bryant");
obj4.setCountry("Brazil");
obj4.setState("Sao Paulo or SP");
obj4.setCity("Sao Paulo");
obj4.setAddress("Vila Mariana, R. Azevedo Macedo");
obj4.setAddressNumber("113");
obj4.setZipCode("04013060 OR 04013-060");
obj4.setCellphone("1234567890");
obj4.setFederalTaxId("098.084.769-96");
obj4.setEmail("testmail@gmail.com");
obj1.setReceiptAddress(obj4);
List<AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTO> list6 = new ArrayList<AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTO>();
AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTO obj7 = new AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTO();
list6.add(obj7);
obj7.setQuantity(1L);
obj7.setLength("10");
obj7.setWidth("10");
obj7.setWeight("1");
obj7.setSkuId("123");
obj7.setHeight("10");
obj7.setPrice("12");
obj1.setProducts(list6);
req.setParam1(obj1);
AliexpressLocalLogisticsShippingMethodQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliexpressLocalLogisticsShippingMethodQueryRequest req = new AliexpressLocalLogisticsShippingMethodQueryRequest();
AliexpressLocalLogisticsShippingMethodQueryRequest.QueryShippingMethodRequestTopDTODomain obj1 = new AliexpressLocalLogisticsShippingMethodQueryRequest.QueryShippingMethodRequestTopDTODomain();
obj1.TradeOrderId = 3014820453131992L;
AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTODomain obj2 = new AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTODomain();
obj2.FirstName = "Jack";
obj2.LastName = "Bryant";
obj2.Country = "Brazil";
obj2.State = "Sao Paulo or SP";
obj2.City = "Sao Paulo";
obj2.Address = "Vila Mariana, R. Azevedo Macedo";
obj2.AddressNumber = "113";
obj2.ZipCode = "04013060 OR 04013-060";
obj2.Cellphone = "1234567890";
obj2.FederalTaxId = "null";
obj2.Email = "testmail@gmail.com";
obj1.SenderAddress= obj2;
AliexpressLocalLogisticsShippingMethodQueryRequest.ExtensionTopDTODomain obj3 = new AliexpressLocalLogisticsShippingMethodQueryRequest.ExtensionTopDTODomain();
obj3.InvoiceAdded = true;
obj1.Extension= obj3;
AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTODomain obj4 = new AliexpressLocalLogisticsShippingMethodQueryRequest.AddressTopDTODomain();
obj4.FirstName = "Jack";
obj4.LastName = "Bryant";
obj4.Country = "Brazil";
obj4.State = "Sao Paulo or SP";
obj4.City = "Sao Paulo";
obj4.Address = "Vila Mariana, R. Azevedo Macedo";
obj4.AddressNumber = "113";
obj4.ZipCode = "04013060 OR 04013-060";
obj4.Cellphone = "1234567890";
obj4.FederalTaxId = "098.084.769-96";
obj4.Email = "testmail@gmail.com";
obj1.ReceiptAddress= obj4;
List<AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTODomain> list6 = new List<AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTODomain>();
AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTODomain obj7 = new AliexpressLocalLogisticsShippingMethodQueryRequest.ProductTopDTODomain();
list6.Add(obj7);
obj7.Quantity = 1L;
obj7.Length = "10";
obj7.Width = "10";
obj7.Weight = "1";
obj7.SkuId = "123";
obj7.Height = "10";
obj7.Price = "12";
obj1.Products= list6;
req.Param1_ = obj1;
AliexpressLocalLogisticsShippingMethodQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliexpressLocalLogisticsShippingMethodQueryRequest;
$param1 = new QueryShippingMethodRequestTopDTO;
$param1->trade_order_id="3014820453131992";
$sender_address = new AddressTopDTO;
$sender_address->first_name="Jack";
$sender_address->last_name="Bryant";
$sender_address->country="Brazil";
$sender_address->state="Sao Paulo or SP";
$sender_address->city="Sao Paulo";
$sender_address->address="Vila Mariana, R. Azevedo Macedo";
$sender_address->address_number="113";
$sender_address->zip_code="04013060 OR 04013-060";
$sender_address->cellphone="1234567890";
$sender_address->federal_tax_id="null";
$sender_address->email="testmail@gmail.com";
$param1->sender_address = $sender_address;
$extension = new ExtensionTopDTO;
$extension->invoice_added="true";
$param1->extension = $extension;
$receipt_address = new AddressTopDTO;
$receipt_address->first_name="Jack";
$receipt_address->last_name="Bryant";
$receipt_address->country="Brazil";
$receipt_address->state="Sao Paulo or SP";
$receipt_address->city="Sao Paulo";
$receipt_address->address="Vila Mariana, R. Azevedo Macedo";
$receipt_address->address_number="113";
$receipt_address->zip_code="04013060 OR 04013-060";
$receipt_address->cellphone="1234567890";
$receipt_address->federal_tax_id="098.084.769-96";
$receipt_address->email="testmail@gmail.com";
$param1->receipt_address = $receipt_address;
$products = new ProductTopDTO;
$products->quantity="1";
$products->length="10";
$products->width="10";
$products->weight="1";
$products->sku_id="123";
$products->height="10";
$products->price="12";
$param1->products = $products;
$req->setParam1(json_encode($param1));
$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=aliexpress.local.logistics.shipping.method.query' \
-d 'partner_id=apidoc' \
-d 'session=60b5938a-7323-4fb3-b171-e6dfa117b1dc' \
-d 'sign=79490B016A2EBBBE2A2F4DF55D4130F7' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+18%3A06%3A43' \
-d 'v=2.0' \
-d 'param1=null'

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

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

req.param1="数据结构示例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,"aliexpress.local.logistics.shipping.method.query");
add_param(pRequest,"param1","数据结构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('aliexpress.local.logistics.shipping.method.query', {
	'param1':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliexpress_local_logistics_shipping_method_query_response>
    <data>
        <parcel>
            <weight>10</weight>
            <width>10</width>
            <height>10</height>
            <length>10</length>
            <product_total_price>50</product_total_price>
            <parcel_type>BOX</parcel_type>
        </parcel>
        <delivery_options>
            <a_e_logistics_shipping_method_d_t_o>
                <logistics_channel_id>1</logistics_channel_id>
                <logistics_channel_name>Pegaki</logistics_channel_name>
                <delivery_method_id>1</delivery_method_id>
                <delivery_method_name>Pac</delivery_method_name>
                <delivery_provider_name>Correios</delivery_provider_name>
                <delivery_cost>12</delivery_cost>
                <delivery_estimate_days>5</delivery_estimate_days>
            </a_e_logistics_shipping_method_d_t_o>
        </delivery_options>
        <query_id>809129783610401</query_id>
    </data>
    <is_success>true</is_success>
    <error_result_message>error1</error_result_message>
    <error_result_code>1</error_result_code>
</aliexpress_local_logistics_shipping_method_query_response>

{
    "aliexpress_local_logistics_shipping_method_query_response":{
        "data":{
            "parcel":{
                "weight":10,
                "width":"10",
                "height":"10",
                "length":"10",
                "product_total_price":"50",
                "parcel_type":"BOX"
            },
            "delivery_options":{
                "a_e_logistics_shipping_method_d_t_o":[
                    {
                        "logistics_channel_id":"1",
                        "logistics_channel_name":"Pegaki",
                        "delivery_method_id":"1",
                        "delivery_method_name":"Pac",
                        "delivery_provider_name":"Correios",
                        "delivery_cost":12,
                        "delivery_estimate_days":5
                    }
                ]
            },
            "query_id":"809129783610401"
        },
        "is_success":"true",
        "error_result_message":"error1",
        "error_result_code":"1"
    }
}

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

aliexpress.local.logistics.shipping.method.query (query shipping method)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ