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


6.订单结果查询接口

<h3>功能描述</h3> <ul> <li>该接口用于:因Internet环境下,网络不是绝对可靠,用户系统下订单到顺丰快递管家后,不一定可以收到顺丰快递管家返回的数据,此接口用于在未收到返回数据时,查询下订单接口客户订单当前的处理情况。</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/order/v1/getResult</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;">companyId</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配客户sendAppId</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">orderId</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">客户订单号</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">searchType</td> <td style="text-align: center;">String(1)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">查询类型:1,正向单查询,传入的orderid为正向定单号,2,退货单查询,传入的orderid为退货原始订单号</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;">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;">2</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;">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> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">orderid</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">客户订单号</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">mailno</td> <td style="text-align: center;">String(4000)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">顺丰运单号</td> <td style="text-align: left;">一个订单只能有一个母单号,如果是子母单的情况,以半角逗号分隔,主单号在第一个位置,如“SF755123456789,SF001123456789,SF002123456789”</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">origincode</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;">可用于顺丰电子运单标签打印。</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">destcode</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;">可用于顺丰电子运单标签打印。</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">filter_result</td> <td style="text-align: center;">String(2)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">筛单结果</td> <td style="text-align: left;">2:可收派</td> </tr> <tr> <td style="text-align: center;">9</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">高峰管控提示信息</td> <td style="text-align: left;">【数字】:【高峰管控提示信息】(如 4:温馨提示 ,1:春运延时)</td> </tr> <tr> <td style="text-align: center;">10</td> <td style="text-align: center;">sourceTransferCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">原寄地中转场</td> </tr> <tr> <td style="text-align: center;">11</td> <td style="text-align: center;">sourceCityCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">原寄地城市代码</td> </tr> <tr> <td style="text-align: center;">12</td> <td style="text-align: center;">sourceDeptCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">原寄地网点代码</td> </tr> <tr> <td style="text-align: center;">13</td> <td style="text-align: center;">sourceTeamCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">原寄地单元区域</td> </tr> <tr> <td style="text-align: center;">14</td> <td style="text-align: center;">destCityCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地城市代码</td> <td style="text-align: left;">eg:755</td> </tr> <tr> <td style="text-align: center;">15</td> <td style="text-align: center;">destDeptCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地网点代码</td> <td style="text-align: left;">eg:755AQ</td> </tr> <tr> <td style="text-align: center;">16</td> <td style="text-align: center;">destDeptCodeMapping</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地网点代码映射码</td> </tr> <tr> <td style="text-align: center;">17</td> <td style="text-align: center;">destTeamCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地单元区域</td> <td style="text-align: left;">eg:001</td> </tr> <tr> <td style="text-align: center;">18</td> <td style="text-align: center;">destTeamCodeMapping</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地单元区域映射码</td> </tr> <tr> <td style="text-align: center;">19</td> <td style="text-align: center;">destTransferCode</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地中转场</td> </tr> <tr> <td style="text-align: center;">20</td> <td style="text-align: center;">destRouteLabel</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;">21</td> <td style="text-align: center;">proName</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">产品名称</td> <td style="text-align: left;">对应RLS:pro_name</td> </tr> <tr> <td style="text-align: center;">22</td> <td style="text-align: center;">cargoTypeCode</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">快件内容</td> <td style="text-align: left;">如:C816、SP601</td> </tr> <tr> <td style="text-align: center;">23</td> <td style="text-align: center;">limitTypeCode</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">时效代码</td> <td style="text-align: left;">如:T4</td> </tr> <tr> <td style="text-align: center;">24</td> <td style="text-align: center;">expressTypeCode</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">产品类型</td> <td style="text-align: left;">如:B1</td> </tr> <tr> <td style="text-align: center;">25</td> <td style="text-align: center;">codingMapping</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">入港映射码</td> <td style="text-align: left;">eg:S10</td> </tr> <tr> <td style="text-align: center;">26</td> <td style="text-align: center;">codingMappingOut</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">出港映射码</td> </tr> <tr> <td style="text-align: center;">27</td> <td style="text-align: center;">xbFlag</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">XB标志</td> <td style="text-align: left;">0:不需要打印XB;1:需要打印XB</td> </tr> <tr> <td style="text-align: center;">28</td> <td style="text-align: center;">printFlag</td> <td style="text-align: center;">String(60)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">打印标志</td> <td style="text-align: left;">返回值总共有9位,每一位只有0和1两种,0表示按丰密运单默认的规则,1表示显示,顺序如下,如111110000表示打印寄方姓名、寄方电话、寄方公司名、寄方地址和重量,收方姓名、收方电话、收方公司名和收方地址按丰密运单默认规则。1:寄方姓名;2:寄方电话;3:寄方公司名;4:寄方地址;5:重量;6:收方姓名;7:收方电话;8:收方公司名;9:收方地址</td> </tr> <tr> <td style="text-align: center;">29</td> <td style="text-align: center;">twoDimensionCode</td> <td style="text-align: center;">String(600)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">二维码</td> <td style="text-align: left;">根据规则生成字符串信息,格式为MMM={'k1':'(目的地中转场代码)','k2':'(目的地原始网点代码)','k3':'(目的地单元区域)','k4':'(附件通过三维码(express_type_code、 limit_type_code、 cargo_type_code)映射时效类型)','k5':'(运单号)','k6':'(AB标识)'}</td> </tr> <tr> <td style="text-align: center;">30</td> <td style="text-align: center;">proCode</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">时效类型</td> <td style="text-align: left;">值为二维码中的K4</td> </tr> <tr> <td style="text-align: center;">31</td> <td style="text-align: center;">printIcon</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">打印图标</td> <td style="text-align: left;">根据托寄物判断需要打印的图标(重货,蟹类,生鲜,易碎,Z标)。返回值有8位,每一位只有0和1两种,0表示按运单默认的规则,1表示显示。后面两位默认0备用。顺序如下:重货,蟹类,生鲜,易碎,医药类,Z标,0,0。如:00000000表示不需要打印重货,蟹类,生鲜,易碎,医药,Z标,备用,备用</td> </tr> <tr> <td style="text-align: center;">32</td> <td style="text-align: center;">abFlag</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">AB标</td> </tr> <tr> <td style="text-align: center;">33</td> <td style="text-align: center;">errMsg</td> <td style="text-align: center;">String(1000)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">查询出现异常时返回信息</td> <td style="text-align: left;">返回代码:0-系统异常;1-未找到运单</td> </tr> <tr> <td style="text-align: center;">34</td> <td style="text-align: center;">destPortCode</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地口岸代码</td> </tr> <tr> <td style="text-align: center;">35</td> <td style="text-align: center;">destCountry</td> <td style="text-align: center;">String(50)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的国别</td> <td style="text-align: left;">国别代码如:JP</td> </tr> <tr> <td style="text-align: center;">36</td> <td style="text-align: center;">destPostCode</td> <td style="text-align: center;">String(100</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地邮编</td> </tr> <tr> <td style="text-align: center;">37</td> <td style="text-align: center;">goodsValueTotal</td> <td style="text-align: center;">String(30)</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;">38</td> <td style="text-align: center;">currencySymbol</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">币种</td> </tr> <tr> <td style="text-align: center;">39</td> <td style="text-align: center;">goodsNumber</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">件数</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;:&amp;quot;201905140011898&amp;quot;, &amp;quot;orderId&amp;quot;:&amp;quot;13fee33778934ed0a7c0165c794ab73f&amp;quot;, &amp;quot;searchType&amp;quot;:1 }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;msg&amp;quot;: null, &amp;quot;result&amp;quot;: { &amp;quot;proCode&amp;quot;: &amp;quot;T4&amp;quot;, &amp;quot;codingMapping&amp;quot;: null, &amp;quot;errMsg&amp;quot;: null, &amp;quot;remark&amp;quot;: null, &amp;quot;destRouteLabel&amp;quot;: &amp;quot;010&amp;quot;, &amp;quot;limitTypeCode&amp;quot;: &amp;quot;T4&amp;quot;, &amp;quot;sourceCityCode&amp;quot;: null, &amp;quot;destPortCode&amp;quot;: null, &amp;quot;destCityCode&amp;quot;: &amp;quot;010&amp;quot;, &amp;quot;destTeamCode&amp;quot;: null, &amp;quot;filter_result&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;destcode&amp;quot;: &amp;quot;010&amp;quot;, &amp;quot;goodsNumber&amp;quot;: null, &amp;quot;codingMappingOut&amp;quot;: null, &amp;quot;printIcon&amp;quot;: null, &amp;quot;sourceTeamCode&amp;quot;: null, &amp;quot;proName&amp;quot;: null, &amp;quot;destDeptCodeMapping&amp;quot;: null, &amp;quot;twoDimensionCode&amp;quot;: &amp;quot;MMM={'k1':'010','k2':'010','k3':'','k4':'T4','k5':'SF1344284442276','k6':'','k7':''}&amp;quot;, &amp;quot;abFlag&amp;quot;: null, &amp;quot;orderid&amp;quot;: &amp;quot;13fee33778934ed0a7c0165c794ab73f&amp;quot;, &amp;quot;printFlag&amp;quot;: null, &amp;quot;currencySymbol&amp;quot;: null, &amp;quot;origincode&amp;quot;: null, &amp;quot;sourceDeptCode&amp;quot;: null, &amp;quot;goodsValueTotal&amp;quot;: null, &amp;quot;cargoTypeCode&amp;quot;: &amp;quot;C201&amp;quot;, &amp;quot;mailno&amp;quot;: &amp;quot;SF1344284442276&amp;quot;, &amp;quot;destCountry&amp;quot;: null, &amp;quot;destDeptCode&amp;quot;: &amp;quot;010&amp;quot;, &amp;quot;sourceTransferCode&amp;quot;: null, &amp;quot;destTransferCode&amp;quot;: null, &amp;quot;destTeamCodeMapping&amp;quot;: null, &amp;quot;expressTypeCode&amp;quot;: &amp;quot;B1&amp;quot;, &amp;quot;xbFlag&amp;quot;: null, &amp;quot;destPostCode&amp;quot;: null } }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;订单结果查询订单异常,未返回数据&amp;quot;, &amp;quot;result&amp;quot;: null }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML