飞猪 - 开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
fields	String	必须	tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt		需返回的字段列表.可选值:Shipping 物流数据结构中的以下字段: tid,order_code,seller_nick,buyer_nick,delivery_start, delivery_end,out_sid,item_title,receiver_name, created,modified,status,type,freight_payer,seller_confirm,company_name,sub_tids,is_spilt；多个字段之间用","分隔。如tid,seller_nick,buyer_nick,delivery_start。
tid	Number	可选	112312323		交易ID.如果加入tid参数的话,不用传其他的参数,若传入tid：非拆单场景，仅会返回一条物流订单信息；拆单场景，会返回多条物流订单信息
buyer_nick	String	可选	jayzhou		买家昵称
status	String	可选	CREATED		物流状态.查看数据结构 Shipping 中的status字段.
seller_confirm	String	可选	yes		卖家是否发货.可选值:yes(是),no(否).如:yes
receiver_name	String	可选	王刚		收货人姓名
start_created	Date	可选	2000-01-01 00:00:00		创建时间开始
end_created	Date	可选	2000-01-02 00:00:00		创建时间结束
freight_payer	String	可选	buyer		谁承担运费.可选值:buyer(买家),seller(卖家).如:buyer
type	String	可选	post		物流方式.可选值:post(平邮),express(快递),ems(EMS).如:post
page_no	Number	可选	1	默认值：1	页码.该字段没传或值<1 ,则默认page_no为1
page_size	Number	可选	40	默认值：40	每页条数.该字段没传或值<1 ,则默认page_size为40

名称	类型	示例值	描述
total_results	Number	100	搜索到的物流订单列表总数
shippings	Shipping []		获取的物流订单详情列表返回的Shipping包含的具体信息为入参fields请求的字段信息
└ tid Number 125555221 交易ID └ order_code String LP12345678 物流订单编号 └ out_sid String 1455858255 运单号.具体一个物流公司的运单号码. └ created Date 2000-01-01 00:00:00 运单创建时间 └ company_name String sto 物流公司名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsOrdersGetVoRequest req = new LogisticsOrdersGetVoRequest();
req.setFields("tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt");
req.setTid(112312323L);
req.setBuyerNick("jayzhou");
req.setStatus("CREATED");
req.setSellerConfirm("yes");
req.setReceiverName("王刚");
req.setStartCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setEndCreated(StringUtils.parseDateTime("2000-01-02 00:00:00"));
req.setFreightPayer("buyer");
req.setType("post");
req.setPageNo(1L);
req.setPageSize(40L);
LogisticsOrdersGetVoResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsOrdersGetVoRequest req = new LogisticsOrdersGetVoRequest();
req.Fields = "tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt";
req.Tid = 112312323L;
req.BuyerNick = "jayzhou";
req.Status = "CREATED";
req.SellerConfirm = "yes";
req.ReceiverName = "王刚";
req.StartCreated = DateTime.Parse("2000-01-01 00:00:00");
req.EndCreated = DateTime.Parse("2000-01-02 00:00:00");
req.FreightPayer = "buyer";
req.Type = "post";
req.PageNo = 1L;
req.PageSize = 40L;
LogisticsOrdersGetVoResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsOrdersGetVoRequest;
$req->setFields("tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt");
$req->setTid("112312323");
$req->setBuyerNick("jayzhou");
$req->setStatus("CREATED");
$req->setSellerConfirm("yes");
$req->setReceiverName("王刚");
$req->setStartCreated("2000-01-01 00:00:00");
$req->setEndCreated("2000-01-02 00:00:00");
$req->setFreightPayer("buyer");
$req->setType("post");
$req->setPageNo("1");
$req->setPageSize("40");
$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=taobao.logistics.orders.get.vo' \
-d 'partner_id=apidoc' \
-d 'session=08f2e3a4-cb5c-422d-ac29-26b730a1a890' \
-d 'sign=9798E1F8E75DA074CD5FC1C5BF9E2BB6' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-09-27+12%3A15%3A28' \
-d 'v=2.0' \
-d 'buyer_nick=jayzhou' \
-d 'end_created=2000-01-02+00%3A00%3A00' \
-d 'fields=tid%2Cseller_nick%2Cbuyer_nick%2Cdelivery_start%2Csub_tids%2Cis_spilt' \
-d 'freight_payer=buyer' \
-d 'page_no=1' \
-d 'page_size=40' \
-d 'receiver_name=%E7%8E%8B%E5%88%9A' \
-d 'seller_confirm=yes' \
-d 'start_created=2000-01-01+00%3A00%3A00' \
-d 'status=CREATED' \
-d 'tid=112312323' \
-d 'type=post'

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

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

req.fields="tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt"
req.tid=112312323
req.buyer_nick="jayzhou"
req.status="CREATED"
req.seller_confirm="yes"
req.receiver_name="王刚"
req.start_created="2000-01-01 00:00:00"
req.end_created="2000-01-02 00:00:00"
req.freight_payer="buyer"
req.type="post"
req.page_no=1
req.page_size=40
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,"taobao.logistics.orders.get.vo");
add_param(pRequest,"fields","tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt");
add_param(pRequest,"tid","112312323");
add_param(pRequest,"buyer_nick","jayzhou");
add_param(pRequest,"status","CREATED");
add_param(pRequest,"seller_confirm","yes");
add_param(pRequest,"receiver_name","王刚");
add_param(pRequest,"start_created","2000-01-01 00:00:00");
add_param(pRequest,"end_created","2000-01-02 00:00:00");
add_param(pRequest,"freight_payer","buyer");
add_param(pRequest,"type","post");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","40");
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('taobao.logistics.orders.get.vo', {
	'fields':'tid,seller_nick,buyer_nick,delivery_start,sub_tids,is_spilt',
	'tid':'112312323',
	'buyer_nick':'jayzhou',
	'status':'CREATED',
	'seller_confirm':'yes',
	'receiver_name':'王刚',
	'start_created':'2000-01-01 00:00:00',
	'end_created':'2000-01-02 00:00:00',
	'freight_payer':'buyer',
	'type':'post',
	'page_no':'1',
	'page_size':'40'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_orders_get_vo_response>
    <total_results>100</total_results>
    <shippings>
        <shipping>
            <tid>125555221</tid>
            <order_code>LP12345678</order_code>
            <out_sid>1455858255</out_sid>
            <created>2000-01-01 00:00:00</created>
            <company_name>sto</company_name>
        </shipping>
    </shippings>
</logistics_orders_get_vo_response>

{
    "logistics_orders_get_vo_response":{
        "total_results":100,
        "shippings":{
            "shipping":[
                {
                    "tid":125555221,
                    "order_code":"LP12345678",
                    "out_sid":"1455858255",
                    "created":"2000-01-01 00:00:00",
                    "company_name":"sto"
                }
            ]
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:trade_id:P07	参数：trade_id:P07无效，格式不对、非法值、越界等	1. 在调用订单获取数据的时候，需要提前判断交易是否已经发货，对于没有发货的订单不要去取物流信息。2. 通过增量API接口同步订单的时候，不要同步3个月以外的订单，以防止取不到交易的情况。

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

开放平台

物流API

taobao.logistics.orders.get.vo (获取天猫国际海外仓物流单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ