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


取消接口

<h3>功能描述</h3> <ul> <li>该接口用于:向丰巢取消下单;</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;"><a href="https://butler-dev.sit.sf-express.com/public/order/fengchao/cancelOrder">https://butler-dev.sit.sf-express.com/public/order/fengchao/cancelOrder</a></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> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">公司id</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">cancelEmp</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;">3</td> <td style="text-align: center;">cancelReason</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;">4</td> <td style="text-align: center;">cancelTime</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">取消时间 格式为:yyyy-MM-dd HH:mm:SS;例:2017-02-22 15:04:22</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">sendId</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;">6</td> <td style="text-align: center;">cancelSource</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;">7</td> <td style="text-align: center;">hasGoods</td> <td style="text-align: center;">Boolean</td> <td style="text-align: center;">是</td> <td style="text-align: center;">是否有物</td> </tr> </tbody> </table> <h3>响应</h3> <ul> <li><strong>主体</strong></li> </ul> <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> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">Boolean</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;">msg</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;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">Array</td> <td style="text-align: center;">否</td> <td style="text-align: center;">数据</td> </tr> </tbody> </table> <ul> <li><strong>result</strong></li> </ul> <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> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">status</td> <td style="text-align: center;">boolean</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;">resultMsg</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;">3</td> <td style="text-align: center;">resultCode</td> <td style="text-align: center;">String</td> <td style="text-align: center;">否</td> <td style="text-align: center;">0:成功1:客户每天取消次数不能多于一次2:投递入柜时间已超过限定时间,不允许客户取消</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">cancelCode</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;">5</td> <td style="text-align: center;">pointCode</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;">6</td> <td style="text-align: center;">addressDetail</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;">7</td> <td style="text-align: center;">provinceName</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;">8</td> <td style="text-align: center;">cityName</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;">9</td> <td style="text-align: center;">countryName</td> <td style="text-align: center;">String</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>{     "cancelEmp":"test",     "cancelReason":"test",     "cancelTime":"2022-09-07 20:08:09",     "sendId":"2022090700000329",     "companyId":"201905140011898",     "hasGoods":false }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{     "result":null,     "succ":"ok",     "msg":"取消成功" }</code></pre> </li> <li>失败报文 <pre><code>{     "result":null,     "succ":"fail",     "msg":"未获取到客户信息,请检查客户公司ID是否存在" }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML