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


8.订单确认/取消接口-取消接口

<h3>功能描述</h3> <ul> <li>该接口用于:客户在发货前取消订单。</li> </ul> <pre><code>注:1.订单取消之后,订单号也是不能重复利用的; 2.该接口只能在未揽收前生效;</code></pre> <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/v2/cancelOrder</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> </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;">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;">code</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">顺丰运单号</td> <td style="text-align: left;">备注。1-客户订单号与顺丰运单不匹配;2-操作成功;</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ "companyId":"201905140011248", "orderId":"b361285847084a1b8c60bb1df9288cfe" }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ "msg": "", "succ": "ok", "result": { "orderid": "2b071273c3a144bdafd411d83004611f", "code": "2" } }</code></pre></li> <li>失败报文-范例1 <pre><code>{ "msg":"系统发生数据错误或运行时异常", "result": null, "succ": "fail" }</code></pre></li> <li>失败报文-范例2 <pre><code>{ "msg":"已消单导致取消订单失败", "result": null, "succ": "fail" }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML