小荔枝开放平台

小荔枝开放平台


3、取消订单

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>取消订单</li> </ul> <h5>请求URL</h5> <ul> <li><code>/api/order/cancelOrder</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </li> <li>application/json</li> <li>需要传递 Bearer Token</li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">logisticsType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Number</td> <td>物流类型(京东:20001,顺丰:20002)</td> </tr> <tr> <td style="text-align: left;">waybillNumber</td> <td style="text-align: left;">可选</td> <td style="text-align: left;">string</td> <td>运单号(顺丰、京东等官方单号) (waybillNumber和originId二选一)</td> </tr> <tr> <td style="text-align: left;">originId</td> <td style="text-align: left;">可选</td> <td style="text-align: left;">string</td> <td>第三方单号 (waybillNumber和originId二选一)</td> </tr> <tr> <td style="text-align: left;">cancelTypeEnum</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Number</td> <td>取消原因(可传固定值:1)</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code> { &amp;quot;waybillNumber&amp;quot;: &amp;quot;SF12398123124112&amp;quot;, &amp;quot;cancelTypeEnum&amp;quot;: 1, &amp;quot;logisticsType&amp;quot;: 20002 }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">result</td> <td style="text-align: left;">object</td> <td>响应数据(可以不用关注)</td> </tr> <tr> <td style="text-align: left;">isSuccess</td> <td style="text-align: left;">boolean</td> <td>是否成功</td> </tr> <tr> <td style="text-align: left;">operationDesc</td> <td style="text-align: left;">string</td> <td>描述</td> </tr> <tr> <td style="text-align: left;">resultCode</td> <td style="text-align: left;">Number</td> <td>请求状态 0正常 ,其他异常</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ &amp;quot;result&amp;quot;: null, &amp;quot;isSuccess&amp;quot;: true, &amp;quot;operationDesc&amp;quot;: null, &amp;quot;resultCode&amp;quot;: 0 }</code></pre> <h5>备注</h5> <ul> <li>无</li> </ul>

页面列表

ITEM_HTML