淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
biz_type	String	可选	ISVMerchant	提供给合作伙伴使用的商家域业务类型
mobile	String	可选	13022556633	下单操作人的手机号，用作联系，可以不填写
package_info_list	GuoGuoPackageInfo	必须		批量下单时包裹信息列表，最多传30个
receiver BusinessCustomer 可选收件人信息 └ full_address_detail String 可选浙江省杭州市西湖区文一西路西溪首座小邮局收件人详细地址 └ mobile String 可选 13799998888 收件人电话 └ area_id String 可选 330100 收件人地址库编码，可不填 encrypted_customer_info EncryptedCustomerInfo 可选淘宝加密字段（如果无法取到明文的收件人信息，可以本字段代替，否则勿使用本字段。若本字段下属2个字段都不为空，则取解密后的地址为收件人地址。否则此字段无效，依然取上面的full_address_detail等信息为收件人信息。若下属2个字段都不为空但有误，会下单失败） └ taobao_order_id String 可选 123456 淘宝加密后的收件人信息ID └ aid String 可选 adu7d82eb 淘宝订单ID └ name String 可选张三收件人姓名 sender BusinessCustomer 可选寄件人信息 └ full_address_detail String 必须浙江省杭州市西湖区文一西路西溪首座小邮局寄件人详细地址 └ mobile String 必须 13799998888 寄件人电话 └ area_id String 可选 330100 寄件人地址库编码，可不填 └ name String 必须张三寄件人姓名 └ item_id String 可选 3000000083 服务商品 └ weight String 可选 1000 包裹重量。单位：克

名称	类型	示例值	描述
result	TdOpenServiceResult		服务返回结果
data PackageServiceExpressResponse 服务表达响应结果 └ can_express Boolean true 是否能够提供裹裹寄件服务 └ express_service_desc String 17点前下单，当天20点前揽收服务表达文案 └ unexpress_reason String 具体的运力关停原因不能提供服务的原因 └ expression_map String 运力可服务时间表达 └ success Boolean false 是否需要重试 └ retry Boolean 2000 错误码 └ status_message String 参数无效错误原因 └ status_code String true 接口调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessServiceDisplayRouterRequest req = new CainiaoPickupBusinessServiceDisplayRouterRequest();
req.setBizType("ISVMerchant");
req.setMobile("13022556633");
CainiaoPickupBusinessServiceDisplayRouterRequest.GuoGuoPackageInfo obj1 = new CainiaoPickupBusinessServiceDisplayRouterRequest.GuoGuoPackageInfo();
CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomer obj2 = new CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomer();
obj2.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
obj2.setMobile("13799998888");
obj2.setAreaId("330100");
CainiaoPickupBusinessServiceDisplayRouterRequest.EncryptedCustomerInfo obj3 = new CainiaoPickupBusinessServiceDisplayRouterRequest.EncryptedCustomerInfo();
obj3.setTaobaoOrderId("123456");
obj3.setAid("adu7d82eb");
obj2.setEncryptedCustomerInfo(obj3);
obj2.setName("张三");
obj1.setReceiver(obj2);
CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomer obj4 = new CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomer();
obj4.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
obj4.setMobile("13799998888");
obj4.setAreaId("330100");
obj4.setName("张三");
obj1.setSender(obj4);
obj1.setItemId("3000000083");
obj1.setWeight("1000");
req.setPackageInfoList(obj1);
CainiaoPickupBusinessServiceDisplayRouterResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessServiceDisplayRouterRequest req = new CainiaoPickupBusinessServiceDisplayRouterRequest();
req.BizType = "ISVMerchant";
req.Mobile = "13022556633";
CainiaoPickupBusinessServiceDisplayRouterRequest.GuoGuoPackageInfoDomain obj1 = new CainiaoPickupBusinessServiceDisplayRouterRequest.GuoGuoPackageInfoDomain();
CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomerDomain obj2 = new CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomerDomain();
obj2.FullAddressDetail = "浙江省杭州市西湖区文一西路西溪首座小邮局";
obj2.Mobile = "13799998888";
obj2.AreaId = "330100";
CainiaoPickupBusinessServiceDisplayRouterRequest.EncryptedCustomerInfoDomain obj3 = new CainiaoPickupBusinessServiceDisplayRouterRequest.EncryptedCustomerInfoDomain();
obj3.TaobaoOrderId = "123456";
obj3.Aid = "adu7d82eb";
obj2.EncryptedCustomerInfo= obj3;
obj2.Name = "张三";
obj1.Receiver= obj2;
CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomerDomain obj4 = new CainiaoPickupBusinessServiceDisplayRouterRequest.BusinessCustomerDomain();
obj4.FullAddressDetail = "浙江省杭州市西湖区文一西路西溪首座小邮局";
obj4.Mobile = "13799998888";
obj4.AreaId = "330100";
obj4.Name = "张三";
obj1.Sender= obj4;
obj1.ItemId = "3000000083";
obj1.Weight = "1000";
req.PackageInfoList_ = obj1;
CainiaoPickupBusinessServiceDisplayRouterResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessServiceDisplayRouterRequest;
$req->setBizType("ISVMerchant");
$req->setMobile("13022556633");
$package_info_list = new GuoGuoPackageInfo;
$receiver = new BusinessCustomer;
$receiver->full_address_detail="浙江省杭州市西湖区文一西路西溪首座小邮局";
$receiver->mobile="13799998888";
$receiver->area_id="330100";
$encrypted_customer_info = new EncryptedCustomerInfo;
$encrypted_customer_info->taobao_order_id="123456";
$encrypted_customer_info->aid="adu7d82eb";
$receiver->encrypted_customer_info = $encrypted_customer_info;
$receiver->name="张三";
$package_info_list->receiver = $receiver;
$sender = new BusinessCustomer;
$sender->full_address_detail="浙江省杭州市西湖区文一西路西溪首座小邮局";
$sender->mobile="13799998888";
$sender->area_id="330100";
$sender->name="张三";
$package_info_list->sender = $sender;
$package_info_list->item_id="3000000083";
$package_info_list->weight="1000";
$req->setPackageInfoList(json_encode($package_info_list));
$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=cainiao.pickup.business.service.display.router' \
-d 'partner_id=apidoc' \
-d 'session=a3badb4b-f12a-44e4-80ed-69e25b070d24' \
-d 'sign=45A3CC8DABA4EAB097CA1421DAC921E6' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+18%3A14%3A46' \
-d 'v=2.0' \
-d 'biz_type=ISVMerchant' \
-d 'mobile=13022556633' \
-d 'package_info_list=%E5%8C%85%E8%A3%B9'

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

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

req.biz_type="ISVMerchant"
req.mobile="13022556633"
req.package_info_list="包裹"
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,"cainiao.pickup.business.service.display.router");
add_param(pRequest,"biz_type","ISVMerchant");
add_param(pRequest,"mobile","13022556633");
add_param(pRequest,"package_info_list","数据结构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('cainiao.pickup.business.service.display.router', {
	'biz_type':'ISVMerchant',
	'mobile':'13022556633',
	'package_info_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_service_display_router_response>
    <result>
        <data>
            <can_express>true</can_express>
            <express_service_desc>17点前下单，当天20点前揽收</express_service_desc>
            <unexpress_reason>具体的运力关停原因</unexpress_reason>
        </data>
        <success>false</success>
        <retry>2000</retry>
        <status_message>参数无效</status_message>
        <status_code>true</status_code>
    </result>
</cainiao_pickup_business_service_display_router_response>

{
    "cainiao_pickup_business_service_display_router_response":{
        "result":{
            "data":{
                "can_express":true,
                "express_service_desc":"17点前下单，当天20点前揽收",
                "unexpress_reason":"具体的运力关停原因"
            },
            "success":false,
            "retry":2000,
            "status_message":"参数无效",
            "status_code":"true"
        }
    }
}

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

cainiao.pickup.business.service.display.router (菜鸟裹裹商家寄件服务表达(含路由信息))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ