淘宝开放平台

请求地址：

环境	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 address_and_service_list ReachableAddressAndServiceDto [] 必须收发地址和服务列表 receive_address ReceiveAddress 必须收货地址 └ town_name String 可选蒋村街道镇/街道 └ address_detail String 必须 xxxxx 详细地址 └ city_name String 可选杭州市市 └ area_name String 可选西湖区区 └ province_name String 必须浙江省省 └ service_code_list String [] 可选 { "SVC-COD": { "value": 100.5 } } 服务列表,每一项必须为json的string格式,快运必填,快递为空则默认为'标准快递' └ object_id String 必须 abc 每条收发地址的key,用户自定义,每次请求多个地址不能重复 send_address AddressDto 可选发货地址 └ town_name String 可选蒋村街道镇/街道 └ address_detail String 可选 yyyyy 详细地址 └ city_name String 可选杭州市市 └ area_name String 可选西湖区区 └ province_name String 可选浙江省省 └ oaid String 可选 abc 淘宝开放地址ID └ order_id Number 可选 123456 订单id └ caid String 可选 def C2M&1688开放地址ID └ send_branch_code String 可选 20111 发件揽收网点
client_info	ClientInfoDto	必须		调用方对象
└ description String 可选 xxx打单助手调用时自定义描述信息

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

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

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

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

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoReachableBatchjudgeRequest;
$req->setAddressType("1");
$data = new RoutingReachableBatchRequestDto;
$data->cp_code="STO";
$address_and_service_list = new ReachableAddressAndServiceDto;
$receive_address = new ReceiveAddress;
$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;
$address_and_service_list->service_code_list="{ \"SVC-COD\": { \"value\": 100.5 } }";
$address_and_service_list->object_id="abc";
$send_address = new AddressDto;
$send_address->town_name="蒋村街道";
$send_address->address_detail="yyyyy";
$send_address->city_name="杭州市";
$send_address->area_name="西湖区";
$send_address->province_name="浙江省";
$address_and_service_list->send_address = $send_address;
$address_and_service_list->oaid="abc";
$address_and_service_list->order_id="123456";
$address_and_service_list->caid="def";
$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, $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.reachable.batchjudge' \
-d 'partner_id=apidoc' \
-d 'session=54c5de45-c02d-4aa2-962c-c8b860b75cce' \
-d 'sign=879A50E1D86A5E64D865CB1E02949414' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+22%3A31%3A54' \
-d 'v=2.0' \
-d 'address_type=1' \
-d 'client_info=null' \
-d 'data=null'

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

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

req.address_type=1
req.data=""
req.client_info=""
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.reachable.batchjudge");
add_param(pRequest,"address_type","1");
add_param(pRequest,"data","数据结构JSON示例");
add_param(pRequest,"client_info","数据结构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.reachable.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_batchjudge_response>
    <result>
        <one_error_info>
            <error_message></error_message>
            <error_code></error_code>
        </one_error_info>
        <success>true</success>
        <module>
            <result_list>
                <reachable_service_waybill_response_dto>
                    <error_info>
                        <error_message></error_message>
                        <error_code></error_code>
                    </error_info>
                    <success>true</success>
                    <module>
                        <interrupt_reason>物流服务不支持派送</interrupt_reason>
                        <interrupt_apply_waybill_code>true</interrupt_apply_waybill_code>
                    </module>
                    <object_id>0</object_id>
                </reachable_service_waybill_response_dto>
            </result_list>
        </module>
    </result>
</cainiao_reachable_batchjudge_response>

{
    "cainiao_reachable_batchjudge_response":{
        "result":{
            "one_error_info":{
                "error_message":"",
                "error_code":""
            },
            "success":true,
            "module":{
                "result_list":{
                    "reachable_service_waybill_response_dto":[
                        {
                            "error_info":{
                                "error_message":"",
                                "error_code":""
                            },
                            "success":true,
                            "module":{
                                "interrupt_reason":"物流服务不支持派送",
                                "interrupt_apply_waybill_code":true
                            },
                            "object_id":"0"
                        }
                    ]
                }
            }
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
cpCode为空	入参缺失，缺少cpCode	请传入cpCode
objectId为空	参数错误，缺失objectId	请在入参中传入objectId
isv.invalid-argument	参数非法	请检查参数
isp.top-mapping-parse-error	top层面字段映射错误，说明是订单加密入参格式不正确	请检查oaid参数
请求列表为空	参数address_and_service_list为空	请检查address_and_service_list
服务code非法	service_code_list不合法	service_code_list需要是json格式
收货地址 - 省为空	收货地址省为空	请检查省字段，必填
请求列表长度超限制	address_and_service_list不超过10个	address_and_service_list不超过10个
收货地址 - 详细地址为空	address_detail详细地址不能为空	请检查address_detail字段，不能为空
objectId重复	objectId不能重复	请检查objectId字段，保证不重复
被限流,请稍后重试	被限流，请控速	排查为什么超出流量，如果是正常流量，联系菜鸟做调整。

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

物流API

cainiao.reachable.batchjudge (是否派送可达判定批量查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ