淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
address_type	Number	可选	1	1:快递 2:快运
data	RoutingReachableBatchRequestDTO	必须		收发信息
└ cp_code String 必须 STO 快递公司code └ seller_id Number 必须 3124144 商家id address_and_service_list ReachableAddressAndServiceDTO [] 必须收发地址和服务列表 receive_address AddressDTO 必须收货地址 └ town_name String 可选蒋村街道镇/街道 └ address_detail String 必须 xxxxx 详细地址 └ city_name String 可选杭州市市 └ area_name String 可选西湖区区 └ province_name String 必须浙江省省 send_address AddressDTO 可选发件地址 └ town_name String 可选蒋村街道镇/街道 └ address_detail String 可选 xxxx 详细地址 └ city_name String 可选杭州市市 └ area_name String 可选西湖区区 └ province_name String 可选浙江省省 └ caid String 可选 def C2M&1688开放地址ID └ service_code_list String [] 可选 { "SVC-COD": { "value": 100.5 } } 服务列表,每一项必须为json的string格式,快运必填,快递为空则默认为'标准快递' └ oaid String 可选 1icV3zmQNcSqvKO3QmP7dIIPOkgPUMua4Uv5OZthsic1gSFBm9w50kyIABW024J8g7y245miad 淘宝开放地址ID └ object_id String 可选 abc 每条收发地址的key,用户自定义,每次请求多个地址不能重复 └ order_id Number 可选 123456 订单id └ send_branch_code String 可选 20111 发件揽收网点
client_info	ClientInfoDTO	必须		调用方对象
└ description String 可选 xxx打单助手调用是自定义描述信息

名称	类型	示例值	描述
result	BaseResultDto		结果
└ success Boolean true 请求是否成功 module ReachableServiceWaybillForTopResponseDto 返回信息 result_list ReachableServiceWaybillResponseDto [] 结果列表 error_info ErrorInfo 单个结果是否异常 └ error_message String 系统异常错误信息 └ error_code String SYSTEM_ERROR 错误码 └ success Boolean true 单个结果是否成功 module ReachableDto 可达信息 └ interrupt_reason String 物流服务不支持派送阻断原因 └ interrupt_apply_waybill_code Boolean true 是否阻断 true:阻断 false:可达 └ object_id String abc 与入参地址列表中单项objectId对应 one_error_info ErrorInfo 请求错误信息 └ error_message String 被限流，请稍后再试错误信息 └ error_code String FLOW_CONTROL 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoReachableInnerBatchjudgeRequest req = new CainiaoReachableInnerBatchjudgeRequest();
req.setAddressType(1L);
CainiaoReachableInnerBatchjudgeRequest.RoutingReachableBatchRequestDTO obj1 = new CainiaoReachableInnerBatchjudgeRequest.RoutingReachableBatchRequestDTO();
obj1.setCpCode("STO");
obj1.setSellerId(3124144L);
List<CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTO> list3 = new ArrayList<CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTO>();
CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTO obj4 = new CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTO();
list3.add(obj4);
CainiaoReachableInnerBatchjudgeRequest.AddressDTO obj6 = new CainiaoReachableInnerBatchjudgeRequest.AddressDTO();
obj6.setTownName("蒋村街道");
obj6.setAddressDetail("xxxxx");
obj6.setCityName("杭州市");
obj6.setAreaName("西湖区");
obj6.setProvinceName("浙江省");
list5.setReceiveAddress(obj6);
CainiaoReachableInnerBatchjudgeRequest.AddressDTO obj8 = new CainiaoReachableInnerBatchjudgeRequest.AddressDTO();
obj8.setTownName("蒋村街道");
obj8.setAddressDetail("xxxx");
obj8.setCityName("杭州市");
obj8.setAreaName("西湖区");
obj8.setProvinceName("浙江省");
list7.setSendAddress(obj8);
obj4.setCaid("def");
obj4.setServiceCodeList("{ \"SVC-COD\": { \"value\": 100.5 } }");
obj4.setOaid("1icV3zmQNcSqvKO3QmP7dIIPOkgPUMua4Uv5OZthsic1gSFBm9w50kyIABW024J8g7y245miad");
obj4.setObjectId("abc");
obj4.setOrderId(123456L);
obj1.setAddressAndServiceList(list3);
obj1.setSendBranchCode("20111");
req.setData(obj1);
CainiaoReachableInnerBatchjudgeRequest.ClientInfoDTO obj9 = new CainiaoReachableInnerBatchjudgeRequest.ClientInfoDTO();
obj9.setDescription("xxx打单助手");
req.setClientInfo(obj9);
CainiaoReachableInnerBatchjudgeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoReachableInnerBatchjudgeRequest req = new CainiaoReachableInnerBatchjudgeRequest();
req.AddressType = 1L;
CainiaoReachableInnerBatchjudgeRequest.RoutingReachableBatchRequestDTODomain obj1 = new CainiaoReachableInnerBatchjudgeRequest.RoutingReachableBatchRequestDTODomain();
obj1.CpCode = "STO";
obj1.SellerId = 3124144L;
List<CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTODomain> list3 = new List<CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTODomain>();
CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTODomain obj4 = new CainiaoReachableInnerBatchjudgeRequest.ReachableAddressAndServiceDTODomain();
list3.Add(obj4);
CainiaoReachableInnerBatchjudgeRequest.AddressDTODomain obj5 = new CainiaoReachableInnerBatchjudgeRequest.AddressDTODomain();
obj5.TownName = "蒋村街道";
obj5.AddressDetail = "xxxxx";
obj5.CityName = "杭州市";
obj5.AreaName = "西湖区";
obj5.ProvinceName = "浙江省";
obj4.ReceiveAddress= obj5;
CainiaoReachableInnerBatchjudgeRequest.AddressDTODomain obj6 = new CainiaoReachableInnerBatchjudgeRequest.AddressDTODomain();
obj6.TownName = "蒋村街道";
obj6.AddressDetail = "xxxx";
obj6.CityName = "杭州市";
obj6.AreaName = "西湖区";
obj6.ProvinceName = "浙江省";
obj4.SendAddress= obj6;
obj4.Caid = "def";
obj4.ServiceCodeList = "{ \"SVC-COD\": { \"value\": 100.5 } }";
obj4.Oaid = "1icV3zmQNcSqvKO3QmP7dIIPOkgPUMua4Uv5OZthsic1gSFBm9w50kyIABW024J8g7y245miad";
obj4.ObjectId = "abc";
obj4.OrderId = 123456L;
obj1.AddressAndServiceList= list3;
obj1.SendBranchCode = "20111";
req.Data_ = obj1;
CainiaoReachableInnerBatchjudgeRequest.ClientInfoDTODomain obj7 = new CainiaoReachableInnerBatchjudgeRequest.ClientInfoDTODomain();
obj7.Description = "xxx打单助手";
req.ClientInfo_ = obj7;
CainiaoReachableInnerBatchjudgeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoReachableInnerBatchjudgeRequest;
$req->setAddressType("1");
$data = new RoutingReachableBatchRequestDTO;
$data->cp_code="STO";
$data->seller_id="3124144";
$address_and_service_list = new ReachableAddressAndServiceDTO;
$receive_address = new AddressDTO;
$receive_address->town_name="蒋村街道";
$receive_address->address_detail="xxxxx";
$receive_address->city_name="杭州市";
$receive_address->area_name="西湖区";
$receive_address->province_name="浙江省";
$address_and_service_list->receive_address = $receive_address;
$send_address = new AddressDTO;
$send_address->town_name="蒋村街道";
$send_address->address_detail="xxxx";
$send_address->city_name="杭州市";
$send_address->area_name="西湖区";
$send_address->province_name="浙江省";
$address_and_service_list->send_address = $send_address;
$address_and_service_list->caid="def";
$address_and_service_list->service_code_list="{ \"SVC-COD\": { \"value\": 100.5 } }";
$address_and_service_list->oaid="1icV3zmQNcSqvKO3QmP7dIIPOkgPUMua4Uv5OZthsic1gSFBm9w50kyIABW024J8g7y245miad";
$address_and_service_list->object_id="abc";
$address_and_service_list->order_id="123456";
$data->address_and_service_list = $address_and_service_list;
$data->send_branch_code="20111";
$req->setData(json_encode($data));
$client_info = new ClientInfoDTO;
$client_info->description="xxx打单助手";
$req->setClientInfo(json_encode($client_info));
$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.reachable.inner.batchjudge' \
-d 'partner_id=apidoc' \
-d 'sign=9B2E5267A021F99EC8ACDB79FCB853A6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+14%3A44%3A48' \
-d 'v=2.0' \
-d 'address_type=1' \
-d 'client_info=null' \
-d 'data=null'

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

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

req.address_type=1
req.data="数据结构示例JSON格式"
req.client_info="数据结构示例JSON格式"
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.reachable.inner.batchjudge");
add_param(pRequest,"address_type","1");
add_param(pRequest,"data","数据结构JSON示例");
add_param(pRequest,"client_info","数据结构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.reachable.inner.batchjudge', {
	'address_type':'1',
	'data':'数据结构JSON示例',
	'client_info':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_reachable_inner_batchjudge_response>
    <result>
        <success>true</success>
        <module>
            <result_list>
                <reachable_service_waybill_response_dto>
                    <error_info>
                        <error_message>系统异常</error_message>
                        <error_code>SYSTEM_ERROR</error_code>
                    </error_info>
                    <success>true</success>
                    <module>
                        <interrupt_reason>物流服务不支持派送</interrupt_reason>
                        <interrupt_apply_waybill_code>true</interrupt_apply_waybill_code>
                    </module>
                    <object_id>abc</object_id>
                </reachable_service_waybill_response_dto>
            </result_list>
        </module>
        <one_error_info>
            <error_message>被限流，请稍后再试</error_message>
            <error_code>FLOW_CONTROL</error_code>
        </one_error_info>
    </result>
</cainiao_reachable_inner_batchjudge_response>

{
    "cainiao_reachable_inner_batchjudge_response":{
        "result":{
            "success":true,
            "module":{
                "result_list":{
                    "reachable_service_waybill_response_dto":[
                        {
                            "error_info":{
                                "error_message":"系统异常",
                                "error_code":"SYSTEM_ERROR"
                            },
                            "success":true,
                            "module":{
                                "interrupt_reason":"物流服务不支持派送",
                                "interrupt_apply_waybill_code":true
                            },
                            "object_id":"abc"
                        }
                    ]
                }
            },
            "one_error_info":{
                "error_message":"被限流，请稍后再试",
                "error_code":"FLOW_CONTROL"
            }
        }
    }
}

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.reachable.inner.batchjudge (电子面单取号不可达判断接口(内部应用使用))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ