飞猪 - 开放平台

请求地址：

环境	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	默认值：ISVMerchant	业务类型
sender_address	String	必须	浙江省杭州市西湖区文一西路西溪首座小邮局		寄件地址

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

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessServiceDisplayRequest req = new CainiaoPickupBusinessServiceDisplayRequest();
req.setBizType("ISVMerchant");
req.setSenderAddress("浙江省杭州市西湖区文一西路西溪首座小邮局");
CainiaoPickupBusinessServiceDisplayResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessServiceDisplayRequest req = new CainiaoPickupBusinessServiceDisplayRequest();
req.BizType = "ISVMerchant";
req.SenderAddress = "浙江省杭州市西湖区文一西路西溪首座小邮局";
CainiaoPickupBusinessServiceDisplayResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessServiceDisplayRequest;
$req->setBizType("ISVMerchant");
$req->setSenderAddress("浙江省杭州市西湖区文一西路西溪首座小邮局");
$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' \
-d 'partner_id=apidoc' \
-d 'session=ad943777-7ccc-4e4d-ab2f-8715932ffafb' \
-d 'sign=BCEB0B6DF561751EDF2CAE99B0BE9812' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-09-27+12%3A09%3A49' \
-d 'v=2.0' \
-d 'biz_type=ISVMerchant' \
-d 'sender_address=%E6%B5%99%E6%B1%9F%E7%9C%81%E6%9D%AD%E5%B7%9E%E5%B8%82%E8%A5%BF%E6%B9%96%E5%8C%BA%E6%96%87%E4%B8%80%E8%A5%BF%E8%B7%AF%E8%A5%BF%E6%BA%AA%E9%A6%96%E5%BA%A7%E5%B0%8F%E9%82%AE%E5%B1%80'

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

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

req.biz_type="ISVMerchant"
req.sender_address="浙江省杭州市西湖区文一西路西溪首座小邮局"
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");
add_param(pRequest,"biz_type","ISVMerchant");
add_param(pRequest,"sender_address","浙江省杭州市西湖区文一西路西溪首座小邮局");
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', {
	'biz_type':'ISVMerchant',
	'sender_address':'浙江省杭州市西湖区文一西路西溪首座小邮局'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_service_display_response>
    <result>
        <data>
            <can_express>true</can_express>
            <express_service_desc>17点前下单，当天20点前揽收</express_service_desc>
            <unexpress_reason>具体的运力关停原因</unexpress_reason>
            <expression_map>23:00前下单当日揽收；23:00后下单次日揽收</expression_map>
        </data>
        <retry>false</retry>
        <status_code>2000</status_code>
        <status_message>参数无效</status_message>
        <success>true</success>
    </result>
</cainiao_pickup_business_service_display_response>

{
    "cainiao_pickup_business_service_display_response":{
        "result":{
            "data":{
                "can_express":true,
                "express_service_desc":"17点前下单，当天20点前揽收",
                "unexpress_reason":"具体的运力关停原因",
                "expression_map":"23:00前下单当日揽收；23:00后下单次日揽收"
            },
            "retry":false,
            "status_code":"2000",
            "status_message":"参数无效",
            "success":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 (菜鸟裹裹商家寄件服务表达)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ