文档中心 > API类目 > 物流API

cainiao.data.logistics.cp.delivery.aging.predict (CP配送物流时效预测)

时效和服务预期是商家发货时比较关注的信息，也是选择快递公司的一个重要参考（除去长期合作合同因素）。所以，在商家发货时给商家提供线路时效预估能帮助商家选择更好的快递公司，且对消费者来说也能整体提升体验。日常时效是数值字符串大促时效是数值区间字符串方式1: 输入：发货省、市、区、详细地址，收货省、市、区、街道、详细地址，快递公司ID 输出：预估时效（小时数）

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
send_city_name	String	必须	杭州市	发货城市
send_county_name	String	必须	西湖区	发货区
send_addr	String	必须	西溪首座B1-2	自己输入的详细发货地址
send_prov_name	String	必须	浙江省	发货省
rec_city_name	String	必须	杭州市	收货城市
rec_addr	String	必须	翡翠城12幢301	自己输入的详细收货地址
rec_county_name	String	必须	西湖区	收货区
rec_prov_name	String	必须	浙江省	收货省
rec_town_name	String	必须	五常街道	第四级，一般是收货街道
cp_id	String	必须	101	物流公司id

响应参数

名称	类型	示例值	描述
data	DeliveryTimingDto	100	返回数据值
└ delivery_period String 12小时到达或者 12-28小时到达，这样的字符串，只会是1种，分日常和大促预估时效，这部分ISV直接展示，不要做改动，ISP会变文案和时效展示

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoDataLogisticsCpDeliveryAgingPredictRequest req = new CainiaoDataLogisticsCpDeliveryAgingPredictRequest();
req.setSendCityName("杭州市");
req.setSendCountyName("西湖区");
req.setSendAddr("西溪首座B1-2");
req.setSendProvName("浙江省");
req.setRecCityName("杭州市");
req.setRecAddr("翡翠城12幢301");
req.setRecCountyName("西湖区");
req.setRecProvName("浙江省");
req.setRecTownName("五常街道");
req.setCpId("101");
CainiaoDataLogisticsCpDeliveryAgingPredictResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoDataLogisticsCpDeliveryAgingPredictRequest req = new CainiaoDataLogisticsCpDeliveryAgingPredictRequest();
req.SendCityName = "杭州市";
req.SendCountyName = "西湖区";
req.SendAddr = "西溪首座B1-2";
req.SendProvName = "浙江省";
req.RecCityName = "杭州市";
req.RecAddr = "翡翠城12幢301";
req.RecCountyName = "西湖区";
req.RecProvName = "浙江省";
req.RecTownName = "五常街道";
req.CpId = "101";
CainiaoDataLogisticsCpDeliveryAgingPredictResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoDataLogisticsCpDeliveryAgingPredictRequest;
$req->setSendCityName("杭州市");
$req->setSendCountyName("西湖区");
$req->setSendAddr("西溪首座B1-2");
$req->setSendProvName("浙江省");
$req->setRecCityName("杭州市");
$req->setRecAddr("翡翠城12幢301");
$req->setRecCountyName("西湖区");
$req->setRecProvName("浙江省");
$req->setRecTownName("五常街道");
$req->setCpId("101");
$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.data.logistics.cp.delivery.aging.predict' \
-d 'partner_id=apidoc' \
-d 'session=bc675f29-0278-4270-a892-6da2266abe3c' \
-d 'sign=6DC6143F9F03146776392FED6C8DC1D5' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-09-27+12%3A17%3A59' \
-d 'v=2.0' \
-d 'cp_id=101' \
-d 'rec_addr=%E7%BF%A1%E7%BF%A0%E5%9F%8E12%E5%B9%A2301' \
-d 'rec_city_name=%E6%9D%AD%E5%B7%9E%E5%B8%82' \
-d 'rec_county_name=%E8%A5%BF%E6%B9%96%E5%8C%BA' \
-d 'rec_prov_name=%E6%B5%99%E6%B1%9F%E7%9C%81' \
-d 'rec_town_name=%E4%BA%94%E5%B8%B8%E8%A1%97%E9%81%93' \
-d 'send_addr=%E8%A5%BF%E6%BA%AA%E9%A6%96%E5%BA%A7B1-2' \
-d 'send_city_name=%E6%9D%AD%E5%B7%9E%E5%B8%82' \
-d 'send_county_name=%E8%A5%BF%E6%B9%96%E5%8C%BA' \
-d 'send_prov_name=%E6%B5%99%E6%B1%9F%E7%9C%81'

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

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

req.send_city_name="杭州市"
req.send_county_name="西湖区"
req.send_addr="西溪首座B1-2"
req.send_prov_name="浙江省"
req.rec_city_name="杭州市"
req.rec_addr="翡翠城12幢301"
req.rec_county_name="西湖区"
req.rec_prov_name="浙江省"
req.rec_town_name="五常街道"
req.cp_id="101"
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.data.logistics.cp.delivery.aging.predict");
add_param(pRequest,"send_city_name","杭州市");
add_param(pRequest,"send_county_name","西湖区");
add_param(pRequest,"send_addr","西溪首座B1-2");
add_param(pRequest,"send_prov_name","浙江省");
add_param(pRequest,"rec_city_name","杭州市");
add_param(pRequest,"rec_addr","翡翠城12幢301");
add_param(pRequest,"rec_county_name","西湖区");
add_param(pRequest,"rec_prov_name","浙江省");
add_param(pRequest,"rec_town_name","五常街道");
add_param(pRequest,"cp_id","101");
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.data.logistics.cp.delivery.aging.predict', {
	'send_city_name':'杭州市',
	'send_county_name':'西湖区',
	'send_addr':'西溪首座B1-2',
	'send_prov_name':'浙江省',
	'rec_city_name':'杭州市',
	'rec_addr':'翡翠城12幢301',
	'rec_county_name':'西湖区',
	'rec_prov_name':'浙江省',
	'rec_town_name':'五常街道',
	'cp_id':'101'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_data_logistics_cp_delivery_aging_predict_response>
    <data>
        <delivery_period>12小时到达 或者 12-28小时到达，这样的字符串，只会是1种，分日常和大促</delivery_period>
    </data>
</cainiao_data_logistics_cp_delivery_aging_predict_response>

{
    "cainiao_data_logistics_cp_delivery_aging_predict_response":{
        "data":{
            "delivery_period":"12小时到达 或者 12-28小时到达，这样的字符串，只会是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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

物流API