淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
express_pre_query_request	ExpressPreQueryRequest	必须			快递预查询服务请求参数
└ planned_shipping_date_and_time String 必须 xxxxx 期望揽收日期以及时间 sender_info ContactInfoRequest 必须 senderInfo └ name String 必须 xxxxx 名称 └ company_name String 必须 xxxxx 公司 └ phone String 必须 xxxxx 电话 └ email String 必须 xxxxx 邮件 └ country String 必须 xxxxx 国家 └ province String 可选 xxxxx 省份 └ city String 必须 xxxxx 城市 └ detail_address String 必须 xxxxx 详细地址（最大135个字符） └ zip_code String 必须 xxxxx 邮件 └ area_id Number 可选 3 地区id └ country_id Number 必须 3 国家id receiver_info ContactInfoRequest 必须 receiverInfo └ name String 必须 xxxxx 名称 └ company_name String 必须 xxxxx 公司名称 └ phone String 必须 xxxxx 电话 └ email String 必须 xxxxx 邮件 └ country String 必须 xxxxx 国家 └ province String 可选 xxxxx 省份 └ city String 必须 xxxxx 城市 └ detail_address String 必须 xxxxx 详细地址（最大135个字符） └ zip_code String 必须 xxxxx 邮件 └ area_id Number 可选 3 地区id └ country_id Number 必须 3 国家id └ scitem_info String 必须 xxxxx scItemInfo packages HandoverPackageInfo [] 必须 packages └ length String 必须 xxxxx 大包长(CM) └ width String 必须 xxxxx 大包宽(CM) └ height String 必须 xxxxx 大包高(CM) └ weight String 必须 xxxxx 大包重量（KG） └ seller_id Number 必须 22222 商家id └ receive_cp_code String 必须 TRAN_STORE_30690953 揽收cp资源code

名称	类型	示例值	描述
hsf_result	HsfResult	xxxxx	hsfResult
└ success Boolean false success └ error_code String xxxxx errorCode └ internal_error_code String xxxxx internalErrorCode └ error_msg String xxxxx errorMsg express_pre_query_response_list ExpressPreQueryResponse [] data └ product_code String EXPRESS 产品code └ product_name String 1-2 DAY 产品名称 └ local_cutoff_date_and_time String 2021-11-18 20:21:22 揽收地址当地截单时间 └ estimated_delivery_time String 2021-11-20 20:21:22 预计送达时间 └ pickup_earliest String 09:30:00 最早揽收时间 └ pickup_latest String 16:00:00 最晚揽收时间 └ total_transit_days Number 2 运输总天数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGlobalImPickupBigbagExpressPrequeryRequest req = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest();
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ExpressPreQueryRequest obj1 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ExpressPreQueryRequest();
obj1.setPlannedShippingDateAndTime("xxxxx");
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequest obj2 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequest();
obj2.setName("xxxxx");
obj2.setCompanyName("xxxxx");
obj2.setPhone("xxxxx");
obj2.setEmail("xxxxx");
obj2.setCountry("xxxxx");
obj2.setProvince("xxxxx");
obj2.setCity("xxxxx");
obj2.setDetailAddress("xxxxx");
obj2.setZipCode("xxxxx");
obj2.setAreaId(3L);
obj2.setCountryId(3L);
obj1.setSenderInfo(obj2);
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequest obj3 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequest();
obj3.setName("xxxxx");
obj3.setCompanyName("xxxxx");
obj3.setPhone("xxxxx");
obj3.setEmail("xxxxx");
obj3.setCountry("xxxxx");
obj3.setProvince("xxxxx");
obj3.setCity("xxxxx");
obj3.setDetailAddress("xxxxx");
obj3.setZipCode("xxxxx");
obj3.setAreaId(3L);
obj3.setCountryId(3L);
obj1.setReceiverInfo(obj3);
obj1.setScitemInfo("xxxxx");
List<CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfo> list5 = new ArrayList<CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfo>();
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfo obj6 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfo();
list5.add(obj6);
obj6.setLength("xxxxx");
obj6.setWidth("xxxxx");
obj6.setHeight("xxxxx");
obj6.setWeight("xxxxx");
obj1.setPackages(list5);
obj1.setSellerId(22222L);
obj1.setReceiveCpCode("TRAN_STORE_30690953");
req.setExpressPreQueryRequest(obj1);
CainiaoGlobalImPickupBigbagExpressPrequeryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGlobalImPickupBigbagExpressPrequeryRequest req = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest();
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ExpressPreQueryRequestDomain obj1 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ExpressPreQueryRequestDomain();
obj1.PlannedShippingDateAndTime = "xxxxx";
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequestDomain obj2 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequestDomain();
obj2.Name = "xxxxx";
obj2.CompanyName = "xxxxx";
obj2.Phone = "xxxxx";
obj2.Email = "xxxxx";
obj2.Country = "xxxxx";
obj2.Province = "xxxxx";
obj2.City = "xxxxx";
obj2.DetailAddress = "xxxxx";
obj2.ZipCode = "xxxxx";
obj2.AreaId = 3L;
obj2.CountryId = 3L;
obj1.SenderInfo= obj2;
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequestDomain obj3 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.ContactInfoRequestDomain();
obj3.Name = "xxxxx";
obj3.CompanyName = "xxxxx";
obj3.Phone = "xxxxx";
obj3.Email = "xxxxx";
obj3.Country = "xxxxx";
obj3.Province = "xxxxx";
obj3.City = "xxxxx";
obj3.DetailAddress = "xxxxx";
obj3.ZipCode = "xxxxx";
obj3.AreaId = 3L;
obj3.CountryId = 3L;
obj1.ReceiverInfo= obj3;
obj1.ScitemInfo = "xxxxx";
List<CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfoDomain> list5 = new List<CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfoDomain>();
CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfoDomain obj6 = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest.HandoverPackageInfoDomain();
list5.Add(obj6);
obj6.Length = "xxxxx";
obj6.Width = "xxxxx";
obj6.Height = "xxxxx";
obj6.Weight = "xxxxx";
obj1.Packages= list5;
obj1.SellerId = 22222L;
obj1.ReceiveCpCode = "TRAN_STORE_30690953";
req.ExpressPreQueryRequest_ = obj1;
CainiaoGlobalImPickupBigbagExpressPrequeryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGlobalImPickupBigbagExpressPrequeryRequest;
$express_pre_query_request = new ExpressPreQueryRequest;
$express_pre_query_request->planned_shipping_date_and_time="xxxxx";
$sender_info = new ContactInfoRequest;
$sender_info->name="xxxxx";
$sender_info->company_name="xxxxx";
$sender_info->phone="xxxxx";
$sender_info->email="xxxxx";
$sender_info->country="xxxxx";
$sender_info->province="xxxxx";
$sender_info->city="xxxxx";
$sender_info->detail_address="xxxxx";
$sender_info->zip_code="xxxxx";
$sender_info->area_id="3";
$sender_info->country_id="3";
$express_pre_query_request->sender_info = $sender_info;
$receiver_info = new ContactInfoRequest;
$receiver_info->name="xxxxx";
$receiver_info->company_name="xxxxx";
$receiver_info->phone="xxxxx";
$receiver_info->email="xxxxx";
$receiver_info->country="xxxxx";
$receiver_info->province="xxxxx";
$receiver_info->city="xxxxx";
$receiver_info->detail_address="xxxxx";
$receiver_info->zip_code="xxxxx";
$receiver_info->area_id="3";
$receiver_info->country_id="3";
$express_pre_query_request->receiver_info = $receiver_info;
$express_pre_query_request->scitem_info="xxxxx";
$packages = new HandoverPackageInfo;
$packages->length="xxxxx";
$packages->width="xxxxx";
$packages->height="xxxxx";
$packages->weight="xxxxx";
$express_pre_query_request->packages = $packages;
$express_pre_query_request->seller_id="22222";
$express_pre_query_request->receive_cp_code="TRAN_STORE_30690953";
$req->setExpressPreQueryRequest(json_encode($express_pre_query_request));
$resp = $c->execute($req);

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.global.im.pickup.bigbag.express.prequery' \
-d 'partner_id=apidoc' \
-d 'sign=7992D0776343E56361E2F6B78B5E8FD7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-23+19%3A03%3A48' \
-d 'v=2.0' \
-d 'express_pre_query_request=null'

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

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

req.express_pre_query_request=""
try:
	resp= req.getResponse()
	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.global.im.pickup.bigbag.express.prequery");
add_param(pRequest,"express_pre_query_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.global.im.pickup.bigbag.express.prequery', {
	'express_pre_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_global_im_pickup_bigbag_express_prequery_response>
    <hsf_result>
        <success>false</success>
        <error_code>xxxxx</error_code>
        <internal_error_code>xxxxx</internal_error_code>
        <error_msg>xxxxx</error_msg>
        <express_pre_query_response_list>
            <express_pre_query_response>
                <product_code>EXPRESS</product_code>
                <product_name>1-2 DAY</product_name>
                <local_cutoff_date_and_time>2021-11-18 20:21:22</local_cutoff_date_and_time>
                <estimated_delivery_time>2021-11-20 20:21:22</estimated_delivery_time>
                <pickup_earliest>09:30:00</pickup_earliest>
                <pickup_latest>16:00:00</pickup_latest>
                <total_transit_days>2</total_transit_days>
            </express_pre_query_response>
        </express_pre_query_response_list>
    </hsf_result>
</cainiao_global_im_pickup_bigbag_express_prequery_response>

{
    "cainiao_global_im_pickup_bigbag_express_prequery_response":{
        "hsf_result":{
            "success":false,
            "error_code":"xxxxx",
            "internal_error_code":"xxxxx",
            "error_msg":"xxxxx",
            "express_pre_query_response_list":{
                "express_pre_query_response":[
                    {
                        "product_code":"EXPRESS",
                        "product_name":"1-2 DAY",
                        "local_cutoff_date_and_time":"2021-11-18 20:21:22",
                        "estimated_delivery_time":"2021-11-20 20:21:22",
                        "pickup_earliest":"09:30:00",
                        "pickup_latest":"16:00:00",
                        "total_transit_days":2
                    }
                ]
            }
        }
    }
}

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.global.im.pickup.bigbag.express.prequery (首公里揽收-快递预查询服务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ