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


15.预计派件时间查询接口

<h3>功能描述</h3> <ul> <li>该接口用于:根据运单号查询预计派件时间</li> </ul> <p><code>注:该接口只能在订单揽收后生效;</code></p> <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/getEstimatedDeliveryTime</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;">waybillNo</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;">3</td> <td style="text-align: center;">checkType</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">1</td> <td style="text-align: left;">校验类型:1-电话号码校验;2-月结卡号校验;</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">checkNos</td> <td style="text-align: center;">String(150)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">校验值:当校验类型为1时传电话号码,当校验类型为2时传月结卡号。</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> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">searchNo</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;">5</td> <td style="text-align: center;">promiseTm</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;">格式:YYYY-MM-DD HH24:mm:SS</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;waybillNo&amp;quot;:&amp;quot;SF1030325208242&amp;quot;, &amp;quot;checkType&amp;quot;:1, &amp;quot;checkNos&amp;quot;:&amp;quot;18210350000&amp;quot; }</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;promiseTm&amp;quot;: &amp;quot;2021-01-01 16:54:00&amp;quot;, &amp;quot;searchNo&amp;quot;: &amp;quot;SF1030325208242&amp;quot; } }</code></pre></li> <li>失败报文-范例 <pre><code>{ &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;check failed&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML