【顺丰快递管家】通用接口文档


7.查询路由接口

<h3>功能描述</h3> <ul> <li>该接口用于: 1.客户系统向顺丰快递管家请求国际件订单路由;</li> </ul> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">下订单</td> <td style="text-align: center;">不支持</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/internationalOrder/v1/route</td> </tr> </tbody> </table> <h3><strong>元素&lt;请求Body&gt;</strong></h3> <table> <thead> <tr> <th><strong>#</strong></th> <th><strong>属性名</strong></th> <th><strong>类型(约束)</strong></th> <th><strong>必填</strong></th> <th><strong>描述</strong></th> </tr> </thead> <tbody> <tr> <td>1</td> <td>companyId</td> <td>String(50)</td> <td>Y</td> <td>分配客户sendAppId</td> </tr> <tr> <td>2</td> <td>version</td> <td>String(10)</td> <td>否</td> <td>版本号(默认为空即可)</td> </tr> <tr> <td>3</td> <td>requestId</td> <td>String(64)</td> <td>否</td> <td>请求id(可使用UUID,确保请求唯一性字段,只要确保每个请求的requestId唯一即可)</td> </tr> <tr> <td>4</td> <td>sfWaybillNo</td> <td>String(32)</td> <td>是</td> <td>顺丰运单号</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String (200)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">信息</td> <td style="text-align: left;">提示信息</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String (10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码</td> <td style="text-align: left;">返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">String (/)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据</td> </tr> </tbody> </table> <h3><strong>元素&lt;响应&gt;result</strong></h3> <table> <thead> <tr> <th><strong>#</strong></th> <th><strong>属性名</strong></th> <th><strong>类型(约束)</strong></th> <th><strong>描述</strong></th> </tr> </thead> <tbody> <tr> <td>1</td> <td>sfWaybillNo</td> <td>String</td> <td>运单号</td> </tr> <tr> <td>2</td> <td>trackDetailItems</td> <td>List<TrackInfoDetail></td> <td>路由信息</td> </tr> <tr> <td>3</td> <td>trackSummary</td> <td>String</td> <td>错误提示</td> </tr> </tbody> </table> <h3><strong>元素&lt;响应&gt;TrackInfoDetail</strong></h3> <table> <thead> <tr> <th><strong>#</strong></th> <th><strong>属性名</strong></th> <th><strong>类型(约束)</strong></th> <th><strong>描述</strong></th> </tr> </thead> <tbody> <tr> <td>1</td> <td>opCode</td> <td>String</td> <td>操作码</td> </tr> <tr> <td>2</td> <td>opCodeTranslation</td> <td>String</td> <td>SF国际路由操作码描述</td> </tr> <tr> <td>3</td> <td>sfWaybillNo</td> <td>String</td> <td>顺丰运单号(母单号)</td> </tr> <tr> <td>4</td> <td>trackCountry</td> <td>String</td> <td>轨迹发生国家/地区</td> </tr> <tr> <td>5</td> <td>trackRegionFirst</td> <td>String</td> <td>轨迹发生一级区划(州/省)</td> </tr> <tr> <td>6</td> <td>trackRegionSecond</td> <td>String</td> <td>轨迹发生二级区划(城市)</td> </tr> <tr> <td>7</td> <td>localTm</td> <td>String</td> <td>轨迹发生时间(当地时间); 格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td>8</td> <td>gmt</td> <td>String</td> <td>轨迹发生地所在时区 格式:GMT+08:00或GMT-08:00或GMT+00:00</td> </tr> <tr> <td>9</td> <td>trackOutRemark</td> <td>String</td> <td>路由轨迹对外描述</td> </tr> </tbody> </table> <h3><strong>明文请求示例</strong></h3> <pre><code class="language-json">{ "companyId":"xxx", "sfWaybillNo": "SF1334457645024" }</code></pre> <h3><strong>明文响应示例</strong></h3> <pre><code class="language-json">{     "succ": "ok",     "result": [         {             "sfWaybillNo": "SF1040405361568",             "trackDetailItems": [                 {                     "gmt": "GMT+08:00",                     "localTm": "2021-11-19 14:33:17",                     "opCode": "50",                     "opCodeTranslation": "一票一件",                     "sfWaybillNo": "SF1040405361568",                     "trackCountry": "CN",                     "trackOutRemark": "顺丰速运已收取快件",                     "trackRegionFirst": "广东省",                     "trackRegionSecond": "深圳市"                 }             ],             "trackSummary": ""         }     ],     "msg": "" }</code></pre>

页面列表

ITEM_HTML