顺丰校园管家


取消订单

<h3>功能描述</h3> <ul> <li>该接口用于在校园管家新建订单中取消跑腿单。 <h3>接入前须知</h3></li> <li>请联系 王歆悦 进行校园验签key及默认操作人配置</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/schoolPub/cancelOrder</td> </tr> </tbody> </table> <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;">必填</th> <th style="text-align: center;">默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">schoolAppId</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">由校园系统方提供,用来单独验证</td> </tr> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">waybillNoList</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">校园运单号集合,校园单号集合与三方单号集合二选其一,暂只支持一条</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">externalOrderNoList</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">三方单号集合,校园单号集合与三方单号集合二选其一,暂只支持一条</td> </tr> </tbody> </table> <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;">必填</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;">List&lt;PubSchoolOrderRes&gt; (/)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据,可能为空</td> </tr> </tbody> </table> <h4>响应result&lt;List&gt;</h4> <h5>PubCreateOrderRes</h5> <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;">waybillNo</td> <td style="text-align: center;">String(50)</td> <td style="text-align: center;">条件</td> <td style="text-align: center;">校园运单号,入参为校园单则返回</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">externalOrderNo</td> <td style="text-align: center;">String(50)</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;">state</td> <td style="text-align: center;">String (50)</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;schoolAppId&amp;quot;: &amp;quot;a&amp;quot;,     &amp;quot;waybillNoList&amp;quot;: [&amp;quot;XY978174845599457280&amp;quot;] }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;result&amp;quot;: [{ &amp;quot;waybillNo&amp;quot;: &amp;quot;XY112233456677&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;已取消&amp;quot; }, { &amp;quot;waybillNo&amp;quot;: &amp;quot;XY11223998877&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;取消失败&amp;quot; } ], &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;msg&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <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;所选订单不存在&amp;quot; }</code></pre></li> <li>失败报文-范例2 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;未校验到下单人数据&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML