文档中心 > API类目 > 电子面单API

cainiao.waybill.address.reachable.query (地址可达查询)

地址可达查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
reachable_recommend_request_dto ReachableRecommendRequestDTO 可选 入参
  • └ cp_code
  • String
  • 可选
  • YUNDA
  • 指定快递公司
  • address
  • AddressDTO
  • 可选
  • 地址
  • └ town_name
  • String
  • 可选
  • 蒋村街道
  • 镇/街道
  • └ address_detail
  • String
  • 可选
  • 中节能西溪首座B座
  • 详细地址
  • └ city_name
  • String
  • 可选
  • 杭州市
  • └ area_name
  • String
  • 可选
  • 西湖区
  • └ province_name
  • String
  • 可选
  • 浙江省
client_info_dto ClientInfoDTO 可选 调用方对象
  • └ description
  • String
  • 可选
  • xxx客户管家
  • 调用时自定义描述信息

响应参数

名称 类型 示例值 描述
result BaseResultDTO 结果
  • └ success
  • Boolean
  • true
  • 请求是否成功
  • module
  • ReachableRecommendResponseDTO
  • 地址可达结果
  • └ reachable
  • Boolean
  • true
  • 地址是否可达
  • └ interrupt_reason
  • String
  • 疫情
  • 不可达原因
  • └ interrupt_end_time
  • String
  • 大于一个月
  • 不可达结束时间
  • reachable_cps
  • CpInfoDTO []
  • 可达CP列表
  • └ cp_code
  • String
  • YUNDA
  • cp编码
  • └ cp_name
  • String
  • 韵达
  • cp名称
  • └ interrupt_type
  • String
  • 疫情
  • 拦截类型
  • error_info_list
  • ErrorInfo []
  • 异常信息
  • └ error_message
  • String
  • 服务器异常
  • 错误信息
  • └ error_code
  • String
  • SYSTEM_ERROR
  • 错误码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillAddressReachableQueryRequest req = new CainiaoWaybillAddressReachableQueryRequest();
CainiaoWaybillAddressReachableQueryRequest.ReachableRecommendRequestDTO obj1 = new CainiaoWaybillAddressReachableQueryRequest.ReachableRecommendRequestDTO();
obj1.setCpCode("YUNDA");
CainiaoWaybillAddressReachableQueryRequest.AddressDTO obj2 = new CainiaoWaybillAddressReachableQueryRequest.AddressDTO();
obj2.setTownName("蒋村街道");
obj2.setAddressDetail("中节能西溪首座B座");
obj2.setCityName("杭州市");
obj2.setAreaName("西湖区");
obj2.setProvinceName("浙江省");
obj1.setAddress(obj2);
req.setReachableRecommendRequestDto(obj1);
CainiaoWaybillAddressReachableQueryRequest.ClientInfoDTO obj3 = new CainiaoWaybillAddressReachableQueryRequest.ClientInfoDTO();
obj3.setDescription("xxx客户管家");
req.setClientInfoDto(obj3);
CainiaoWaybillAddressReachableQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_waybill_address_reachable_query_response>
    <result>
        <success>true</success>
        <module>
            <reachable>true</reachable>
            <interrupt_reason>疫情</interrupt_reason>
            <interrupt_end_time>大于一个月</interrupt_end_time>
            <reachable_cps>
                <cp_info_d_t_o>
                    <cp_code>YUNDA</cp_code>
                    <cp_name>韵达</cp_name>
                </cp_info_d_t_o>
            </reachable_cps>
            <interrupt_type>疫情</interrupt_type>
        </module>
        <error_info_list>
            <error_info>
                <error_message>服务器异常</error_message>
                <error_code>SYSTEM_ERROR</error_code>
            </error_info>
        </error_info_list>
    </result>
</cainiao_waybill_address_reachable_query_response>

异常示例

  • 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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部