路由查询

路由查询接口

客户可通过此接口查询顺丰运单路由，顺丰会在响应Json报文返回当时点要求的全部路由节点信息。

此路由查询接口支持三类查询方式:

1 )根据顺丰运单号查询：查询请求中提供接入编码与运单号，验证接入编码下绑定的月结卡号与请求运单号的归属关系，系统只返回具有正确归属关系的运单路由信息。

2) 根据客户订单号查询：查询请求中提供接入编码与订单号，验证接入编码与所有请求订单号的归属关系，对于归属关系正确的订单号，找到对应的运单号，然后返回订单对应运单号的路由信息。适用于通过下单的客户订单。

3) 根据运单号+运单对应的收寄人任一方电话号码后4位(参数checkPhoneNo中传入)查询,系统校验信息匹配将返回对应运单路由信息。若一次性查多个路由，checkPhoneNo传入多个电话号码后4位，用英文逗号隔开，作为一个字符串

1.请求参数:

POST https://kf.fw199.com/gateway/sfexpress/routes/search

1.1 参数request_data 的说明

2. 请求示例代码(Java)

 /**
     * 路由查询
     * @throws Exception
     */
    @Test
    public void searchRouters() throws Exception {

        String result ="";

        // dealType：2表示取消
        String jsonData  = "{" +
                "\"language\": \"0\"," +
                "\"trackingType\": \"2\"," +
                "\"trackingNumber\": [\"QIAO-20200605-003\"]," +
                "\"methodType\": \"1\"" +
                "}";


        CloseableHttpClient httpclient = HttpClients.createDefault();
        HttpPost httpPost = new HttpPost( Config.SFExpressSearchRoutersUrl );

        //业务参数
        Map<String, String> data = new HashMap<String, String>();
        data.put("appid",  Config.AppId);
        data.put("request_data", jsonData);
        data.put("client_code",  Config.SFClientCode);
        data.put("check_word",  Config.SFCheckWord);
        Long timestamp = System.currentTimeMillis() / 1000;
        data.put("timestamp", timestamp.toString());

        // 参数签名
        data.put("sign", Utils.Sign(data,Config.AppSecret));
        List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
        for (Map.Entry<String, String> entry : data.entrySet()) {
            params.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
        }
        //发起POST请求
        try {
            httpPost.setEntity(new UrlEncodedFormEntity(params, "UTF-8"));
            HttpResponse httpResponse = httpclient.execute(httpPost);
            if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
                result =  EntityUtils.toString(httpResponse.getEntity());
            } else {
                result =  ("doPost Error Response: " + httpResponse.getStatusLine().toString());
            }
        } catch (Exception e) {
            e.printStackTrace();

        }

        System.out.println(result);

    }

3. 返回结果如下：

{
    "code": 0,
    "message": "ok",
    "data": {
        "apiErrorMsg": "",
        "apiResponseID": "00017A8A1F850F3FEDB3F554A3D05D3F",
        "apiResultCode": "A1000",
        "apiResultData": "{\"success\":true,\"errorCode\":\"S0000\",\"errorMsg\":null,\"msgData\":{\"routeResps\":[{\"mailNo\":null,\"routes\":[],\"orderId\":\"QIAO-20200605-003\"}]}}"
    },
    "trace_id": "gU1K3Z1AyX6gEbBE99oH"
}

说明： code为0表示成功，非0为失败，message会包含失败原因。

4. 元素<响应> apiResultData

4.1 返回参数msgData说明：

4.2 元素<响应> QuerySFRouteResponse/msgData/routeResps

4.3 元素<响应> QuerySFRouteResponse/msgData/routeResps/routes

注意事项:

同一批次顺丰运单路由信息必须为同一语言。

目前支持中文简体,中文繁体和英文，返回语言与下单一致，若需返回中文繁体或英文，下单需为对应语言。

可在文档中心查看路由节点信息操作码。

4)定制路由查询须与顺丰商务人员沟通，客户可基于顺丰所有路由节点（列表可从顺丰商务人员处获取）定制所需的路由节点及其具体描述与操作码。

4.4 路由信息操作码