淘宝开放平台

请求地址：

环境	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	CreateOrderRequestTopDTO	必须			create logistics order's param
sender_address AddressTopDTO 必须 sender address └ first_name String 必须 Jack first name of sender └ last_name String 必须 Bryant last name of sender └ country String 必须 Brazil sender's country └ zip_code String 必须 04013060 OR 04013-060 zip code of ship from place └ address String 必须 Vila Mariana, R. Azevedo Macedo sender's district and street └ federal_tax_id String 可选 123 federal tax id(cnpj) └ city String 必须 Sao Paulo sender's city └ address_number String 必须 113 sender's street number └ cellphone String 可选 1234567890 cell phone of sender └ state String 必须 Sao Paulo or SP sender's State └ email String 可选 testmail@gmail.com email of sender parcel ParcelTopDTO 必须 parcel info └ quantity Number 可选 1 number of the parcel and there's only one parcel └ parcel_type_code String 必须 BAG Type: ENVELOPE, BOX, BAG, TUBE, PALLET └ length String 必须 10 Length of the parcel in the shipment order. Default unit: centimeters └ width String 必须 5 Width of the parcel in the shipment order. Default unit: centimeters └ weight String 必须 2 Actual gross weight of the parcel instead of the weight of the product, nor the added weight of the invoice volumes. Default unit: kilograms └ height String 必须 1 Height of the parcel in the shipment order. Default unit: centimeters └ delivery_method_id Number 必须 1 Delivery option id selected by a sender └ trade_order_id Number 必须 3014820453131992 It's sales order id and a 16-digit number. There will be mapping between trade order and shipment order receipt_address AddressTopDTO 必须 receiver address └ first_name String 必须 Jack first name of receiver └ last_name String 必须 Bryant last name of receiver └ country String 必须 Brazil receiver's country └ zip_code String 必须 04013060 OR 04013-060 zip code of ship to place └ address String 必须 Vila Mariana, R. Azevedo Macedo receiver's district and street └ federal_tax_id String 可选 098.084.769-96 CPF of the buyer. Senders can find it on sales order └ city String 必须 Sao Paulo receiver's city └ address_number String 必须 113 receiver's street number └ cellphone String 可选 1234567890 cell phone of receiver └ state String 必须 Sao Paulo or SP receiver's State └ email String 可选 testmail@gmail.com email of receiver └ additional String 可选 Floor 5 shipping additional └ logistics_channel_id String 必须 2 Logistics provider Id of the shipping order such as 1-Cainiao, 2-Pegaki, 3-Frenet, 4-Delivery Hub, etc. └ provider_shipping_costs String 必须 15 Input delivery_cost in logistics method query API. If no value returned, then input 1 invoice InvoiceTopDTO 可选 invoice info └ invoice_series String 必须 186 3-digit number └ invoice_key String 必须 32210808351293000910550010018677261100007413 44-digit number └ invoice_number String 必须 772611000 9-digit number └ invoice_total_value String 必须 100 value of invoice └ invoice_date String 必须 2021-12-26T15:58:11 date of inovice issued products ProductTopDTO [] 必须 products info └ quantity Number 必须 2 Quantity of a sku in the order. It's used to calculate the total number of products in a parcel └ price String 可选 1 price └ 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 必须 2 Total weight of a SKU in its original packaging. Default unit: kilograms └ height String 必须 2 Actual dimension of a sku in its original packaging. Default unit: centimeters └ sku_id String 可选 abc AE sku_id to identify a unit of sku └ query_id String 可选 12345 Find it in responses of shipping method query API

名称	类型	示例值	描述
data	AELogisticsOrderDTO		response info
└ logistics_order_id String BP10000000015003 Shipment order id created. AE will save relationship with logistics provider's shipment order_id
is_success	Boolean	success	interface status
error_result_message	String	error	error message
error_result_code	String	error_001	error code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliexpressLocalLogisticsOrderCreateRequest req = new AliexpressLocalLogisticsOrderCreateRequest();
AliexpressLocalLogisticsOrderCreateRequest.CreateOrderRequestTopDTO obj1 = new AliexpressLocalLogisticsOrderCreateRequest.CreateOrderRequestTopDTO();
AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTO obj2 = new AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTO();
obj2.setFirstName("Jack");
obj2.setLastName("Bryant");
obj2.setCountry("Brazil");
obj2.setZipCode("04013060 OR 04013-060");
obj2.setAddress("Vila Mariana, R. Azevedo Macedo");
obj2.setFederalTaxId("123");
obj2.setCity("Sao Paulo");
obj2.setAddressNumber("113");
obj2.setCellphone("1234567890");
obj2.setState("Sao Paulo or SP");
obj2.setEmail("testmail@gmail.com");
obj1.setSenderAddress(obj2);
AliexpressLocalLogisticsOrderCreateRequest.ParcelTopDTO obj3 = new AliexpressLocalLogisticsOrderCreateRequest.ParcelTopDTO();
obj3.setQuantity(1L);
obj3.setParcelTypeCode("BAG");
obj3.setLength("10");
obj3.setWidth("5");
obj3.setWeight("2");
obj3.setHeight("1");
obj1.setParcel(obj3);
obj1.setDeliveryMethodId(1L);
obj1.setTradeOrderId(3014820453131992L);
AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTO obj4 = new AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTO();
obj4.setFirstName("Jack");
obj4.setLastName("Bryant");
obj4.setCountry("Brazil");
obj4.setZipCode("04013060 OR 04013-060");
obj4.setAddress("Vila Mariana, R. Azevedo Macedo");
obj4.setFederalTaxId("098.084.769-96");
obj4.setCity("Sao Paulo");
obj4.setAddressNumber("113");
obj4.setCellphone("1234567890");
obj4.setState("Sao Paulo or SP");
obj4.setEmail("testmail@gmail.com");
obj4.setAdditional("Floor 5");
obj1.setReceiptAddress(obj4);
obj1.setLogisticsChannelId("2");
obj1.setProviderShippingCosts("15");
AliexpressLocalLogisticsOrderCreateRequest.InvoiceTopDTO obj5 = new AliexpressLocalLogisticsOrderCreateRequest.InvoiceTopDTO();
obj5.setInvoiceSeries("186");
obj5.setInvoiceKey("32210808351293000910550010018677261100007413");
obj5.setInvoiceNumber("772611000");
obj5.setInvoiceTotalValue("100");
obj5.setInvoiceDate("2021-12-26T15:58:11");
obj1.setInvoice(obj5);
List<AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTO> list7 = new ArrayList<AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTO>();
AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTO obj8 = new AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTO();
list7.add(obj8);
obj8.setQuantity(2L);
obj8.setPrice("1");
obj8.setLength("10");
obj8.setWidth("10");
obj8.setWeight("2");
obj8.setHeight("2");
obj8.setSkuId("abc");
obj1.setProducts(list7);
obj1.setQueryId("12345");
req.setParam1(obj1);
AliexpressLocalLogisticsOrderCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliexpressLocalLogisticsOrderCreateRequest req = new AliexpressLocalLogisticsOrderCreateRequest();
AliexpressLocalLogisticsOrderCreateRequest.CreateOrderRequestTopDTODomain obj1 = new AliexpressLocalLogisticsOrderCreateRequest.CreateOrderRequestTopDTODomain();
AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTODomain obj2 = new AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTODomain();
obj2.FirstName = "Jack";
obj2.LastName = "Bryant";
obj2.Country = "Brazil";
obj2.ZipCode = "04013060 OR 04013-060";
obj2.Address = "Vila Mariana, R. Azevedo Macedo";
obj2.FederalTaxId = "123";
obj2.City = "Sao Paulo";
obj2.AddressNumber = "113";
obj2.Cellphone = "1234567890";
obj2.State = "Sao Paulo or SP";
obj2.Email = "testmail@gmail.com";
obj1.SenderAddress= obj2;
AliexpressLocalLogisticsOrderCreateRequest.ParcelTopDTODomain obj3 = new AliexpressLocalLogisticsOrderCreateRequest.ParcelTopDTODomain();
obj3.Quantity = 1L;
obj3.ParcelTypeCode = "BAG";
obj3.Length = "10";
obj3.Width = "5";
obj3.Weight = "2";
obj3.Height = "1";
obj1.Parcel= obj3;
obj1.DeliveryMethodId = 1L;
obj1.TradeOrderId = 3014820453131992L;
AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTODomain obj4 = new AliexpressLocalLogisticsOrderCreateRequest.AddressTopDTODomain();
obj4.FirstName = "Jack";
obj4.LastName = "Bryant";
obj4.Country = "Brazil";
obj4.ZipCode = "04013060 OR 04013-060";
obj4.Address = "Vila Mariana, R. Azevedo Macedo";
obj4.FederalTaxId = "098.084.769-96";
obj4.City = "Sao Paulo";
obj4.AddressNumber = "113";
obj4.Cellphone = "1234567890";
obj4.State = "Sao Paulo or SP";
obj4.Email = "testmail@gmail.com";
obj4.Additional = "Floor 5";
obj1.ReceiptAddress= obj4;
obj1.LogisticsChannelId = "2";
obj1.ProviderShippingCosts = "15";
AliexpressLocalLogisticsOrderCreateRequest.InvoiceTopDTODomain obj5 = new AliexpressLocalLogisticsOrderCreateRequest.InvoiceTopDTODomain();
obj5.InvoiceSeries = "186";
obj5.InvoiceKey = "32210808351293000910550010018677261100007413";
obj5.InvoiceNumber = "772611000";
obj5.InvoiceTotalValue = "100";
obj5.InvoiceDate = "2021-12-26T15:58:11";
obj1.Invoice= obj5;
List<AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTODomain> list7 = new List<AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTODomain>();
AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTODomain obj8 = new AliexpressLocalLogisticsOrderCreateRequest.ProductTopDTODomain();
list7.Add(obj8);
obj8.Quantity = 2L;
obj8.Price = "1";
obj8.Length = "10";
obj8.Width = "10";
obj8.Weight = "2";
obj8.Height = "2";
obj8.SkuId = "abc";
obj1.Products= list7;
obj1.QueryId = "12345";
req.Param1_ = obj1;
AliexpressLocalLogisticsOrderCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliexpressLocalLogisticsOrderCreateRequest;
$param1 = new CreateOrderRequestTopDTO;
$sender_address = new AddressTopDTO;
$sender_address->first_name="Jack";
$sender_address->last_name="Bryant";
$sender_address->country="Brazil";
$sender_address->zip_code="04013060 OR 04013-060";
$sender_address->address="Vila Mariana, R. Azevedo Macedo";
$sender_address->federal_tax_id="123";
$sender_address->city="Sao Paulo";
$sender_address->address_number="113";
$sender_address->cellphone="1234567890";
$sender_address->state="Sao Paulo or SP";
$sender_address->email="testmail@gmail.com";
$param1->sender_address = $sender_address;
$parcel = new ParcelTopDTO;
$parcel->quantity="1";
$parcel->parcel_type_code="BAG";
$parcel->length="10";
$parcel->width="5";
$parcel->weight="2";
$parcel->height="1";
$param1->parcel = $parcel;
$param1->delivery_method_id="1";
$param1->trade_order_id="3014820453131992";
$receipt_address = new AddressTopDTO;
$receipt_address->first_name="Jack";
$receipt_address->last_name="Bryant";
$receipt_address->country="Brazil";
$receipt_address->zip_code="04013060 OR 04013-060";
$receipt_address->address="Vila Mariana, R. Azevedo Macedo";
$receipt_address->federal_tax_id="098.084.769-96";
$receipt_address->city="Sao Paulo";
$receipt_address->address_number="113";
$receipt_address->cellphone="1234567890";
$receipt_address->state="Sao Paulo or SP";
$receipt_address->email="testmail@gmail.com";
$receipt_address->additional="Floor 5";
$param1->receipt_address = $receipt_address;
$param1->logistics_channel_id="2";
$param1->provider_shipping_costs="15";
$invoice = new InvoiceTopDTO;
$invoice->invoice_series="186";
$invoice->invoice_key="32210808351293000910550010018677261100007413";
$invoice->invoice_number="772611000";
$invoice->invoice_total_value="100";
$invoice->invoice_date="2021-12-26T15:58:11";
$param1->invoice = $invoice;
$products = new ProductTopDTO;
$products->quantity="2";
$products->price="1";
$products->length="10";
$products->width="10";
$products->weight="2";
$products->height="2";
$products->sku_id="abc";
$param1->products = $products;
$param1->query_id="12345";
$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.order.create' \
-d 'partner_id=apidoc' \
-d 'session=16ae9da6-ec27-461d-8aaa-cbcdffdbae45' \
-d 'sign=8C463527ED5989FFA2287FB68A3623A7' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+02%3A21%3A53' \
-d 'v=2.0' \
-d 'param1=null'

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

req=top.api.AliexpressLocalLogisticsOrderCreateRequest(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.order.create");
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.order.create', {
	'param1':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliexpress_local_logistics_order_create_response>
    <data>
        <logistics_order_id>BP10000000015003</logistics_order_id>
    </data>
    <is_success>success</is_success>
    <error_result_message>error</error_result_message>
    <error_result_code>error_001</error_result_code>
</aliexpress_local_logistics_order_create_response>

{
    "aliexpress_local_logistics_order_create_response":{
        "data":{
            "logistics_order_id":"BP10000000015003"
        },
        "is_success":success,
        "error_result_message":"error",
        "error_result_code":"error_001"
    }
}

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.order.create (create logistics order)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ