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


2.订单服务状态推送接口

<h3>功能描述</h3> <ul> <li>该接口用于:微派系统当检测到订单服务状态发生变化时,主动将新的服务状态推送给客户。</li> <li>客户需提供一个符合以下规范的HTTP/HTTPS URL,以接收顺丰快递管家通用接口推送的信息: 1.订单服务状态信息为JSON格式,通过HTTP/HTTPS POST方式推送给客户; 2.在客户处理完订单服务状态信息后,向顺丰快递管家通用接口返回响应JSON信息,响应JSON报文结果只能为OK/ERR,如为ERR,顺丰快递管家通用接口将重新推送该路由信息,失败3次后不再推送;</li> </ul> <pre><code>注:1.此接口建议客户方系统做验签功能,规避被恶意攻击的风险; 2.测试环境如需测试该接口,请将测试环境下单后的订单号与运单号发给顺丰研发接口人,便于其生成相关测试数据;</code></pre> <h4>迭代说明(重要)</h4> <p>自2022年4月19日起,下单接口中的微派业务切换为异步调用,即下微派单返回的成功性质由“微派下单成功,变为微派请求提交成功”。客户系统需对接本推送接口,根据快递管家推送的服务状态status是否为 -1 来判断该条订单是否下单失败。微派服务请求失败的订单,快递管家系统会自动取消该单。已经对接的客户暂不需要变更。</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;">客户方提供</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: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">mailNo</td> <td style="text-align: center;">String(32)</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;">merchantOrderNo</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">客户订单号</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">orderNo</td> <td style="text-align: center;">String(32)</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;">status</td> <td style="text-align: center;">Int</td> <td style="text-align: center;">是</td> <td style="text-align: left;">微派订单服务状态,参考路由状态码映射表中系统状态值</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">isEverException</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">是否出现异常</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">exceptionType</td> <td style="text-align: center;">String(150)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">异常类型</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">exceptionDscr</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">异常描述</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">exceptionCode</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">异常编码</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;">status</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-成功,ERR-失败;失败会重推两次,共推送三次,全部返回ERR则不再推送。</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;mailNo&amp;quot;: &amp;quot;SF1324430766346&amp;quot;, &amp;quot;merchantOrderNo&amp;quot;: &amp;quot;c783b14aff804a5e9cb1eaa2587d51d1&amp;quot;, &amp;quot;orderNo&amp;quot;: &amp;quot;WP210709000002&amp;quot;, &amp;quot;status&amp;quot;: 4 }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{ &amp;quot;status&amp;quot;:&amp;quot;OK&amp;quot; }</code></pre> </li> <li>失败报文 <pre><code>{ &amp;quot;status&amp;quot;:&amp;quot;ERR&amp;quot; }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML