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


订单状态推送

<p>&lt;br/&gt;</p> <p>&gt; 订单状态推送</p> <p>请求接口:客户提供</p> <p>请求方法:POST</p> <p>请求类型:JSON</p> <p>请求参数:</p> <p>【配送状态更改】</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">是否必填</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sf_order_id</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">顺丰订单ID</td> </tr> <tr> <td style="text-align: left;">shop_order_id</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">商家订单ID</td> </tr> <tr> <td style="text-align: left;">url_index</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">回调url前缀。rider_status</td> </tr> <tr> <td style="text-align: left;">operator_name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员姓名</td> </tr> <tr> <td style="text-align: left;">operator_phone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员电话</td> </tr> <tr> <td style="text-align: left;">rider_lng</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员位置经度</td> </tr> <tr> <td style="text-align: left;">rider_lat</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员位置纬度</td> </tr> <tr> <td style="text-align: left;">order_status</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td style="text-align: left;">订单状态。10-配送员接单/改派;12:配送员到店;15:配送员配送中</td> </tr> <tr> <td style="text-align: left;">status_desc</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">状态描述</td> </tr> <tr> <td style="text-align: left;">push_time</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td style="text-align: left;">状态变更时间</td> </tr> </tbody> </table> <p>【订单完成】</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th>是否必填</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sf_order_id</td> <td style="text-align: left;">String</td> <td>是</td> <td style="text-align: left;">顺丰订单ID</td> </tr> <tr> <td style="text-align: left;">shop_order_id</td> <td style="text-align: left;">String</td> <td>是</td> <td style="text-align: left;">商家订单ID</td> </tr> <tr> <td style="text-align: left;">url_index</td> <td style="text-align: left;">String</td> <td>是</td> <td style="text-align: left;">回调url前缀。order_complete</td> </tr> <tr> <td style="text-align: left;">operator_name</td> <td style="text-align: left;">String</td> <td>是</td> <td style="text-align: left;">操作人</td> </tr> <tr> <td style="text-align: left;">rider_lng</td> <td style="text-align: left;">String</td> <td>否</td> <td style="text-align: left;">配送员位置经度</td> </tr> <tr> <td style="text-align: left;">rider_lat</td> <td style="text-align: left;">String</td> <td>否</td> <td style="text-align: left;">配送员位置纬度</td> </tr> <tr> <td style="text-align: left;">order_status</td> <td style="text-align: left;">Integer</td> <td>是</td> <td style="text-align: left;">订单状态。17配送员点击完成</td> </tr> <tr> <td style="text-align: left;">status_desc</td> <td style="text-align: left;">String</td> <td>是</td> <td style="text-align: left;">状态描述</td> </tr> <tr> <td style="text-align: left;">pickup_pic</td> <td style="text-align: left;">List&lt;String&gt;</td> <td>否</td> <td style="text-align: left;">妥投照片url。图片40天后过期</td> </tr> <tr> <td style="text-align: left;">push_time</td> <td style="text-align: left;">Integer</td> <td>是</td> <td style="text-align: left;">完成时间</td> </tr> <tr> <td style="text-align: left;">receipt_type</td> <td style="text-align: left;">Integer</td> <td>是</td> <td style="text-align: left;">签收类型。1:正常签收, 2:商家退回签收</td> </tr> </tbody> </table> <p>【顺丰原因取消】</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">是否必填</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sf_order_id</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">顺丰订单ID</td> </tr> <tr> <td style="text-align: left;">shop_order_id</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">商家订单ID</td> </tr> <tr> <td style="text-align: left;">url_index</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">回调url前缀。sf_cancel</td> </tr> <tr> <td style="text-align: left;">operator_name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">操作人</td> </tr> <tr> <td style="text-align: left;">operator_phone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">操作人手机号</td> </tr> <tr> <td style="text-align: left;">order_status</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td style="text-align: left;">订单状态。2:订单取消</td> </tr> <tr> <td style="text-align: left;">status_desc</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">状态描述</td> </tr> <tr> <td style="text-align: left;">cancel_reason</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">取消原因</td> </tr> <tr> <td style="text-align: left;">cancel_code</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">取消码</td> </tr> <tr> <td style="text-align: left;">rider_lng</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员位置经度</td> </tr> <tr> <td style="text-align: left;">rider_lat</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td style="text-align: left;">配送员位置纬度</td> </tr> <tr> <td style="text-align: left;">push_time</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td style="text-align: left;">取消时间</td> </tr> </tbody> </table> <p>请求示例:</p> <pre><code class="language-json">-</code></pre> <p>响应参数:</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是否成功,返回OK或ERR。非必填,若传入且非OK,将继续重试推送2次</td> </tr> </tbody> </table> <p>响应示例:</p> <pre><code class="language-json">{ &amp;quot;status&amp;quot;: &amp;quot;OK&amp;quot; }</code></pre> <p>取消码对应关系:</p> <table> <thead> <tr> <th>cancel_code</th> <th>对应的取消原因</th> </tr> </thead> <tbody> <tr> <td>100</td> <td>误操作,抢错订单</td> </tr> <tr> <td>101</td> <td>订单距离太远</td> </tr> <tr> <td>102</td> <td>餐箱已满,无法配送</td> </tr> <tr> <td>103</td> <td>物品过大无法配送</td> </tr> <tr> <td>104</td> <td>联系不上寄件人</td> </tr> <tr> <td>105</td> <td>寄方无法提供待配送物品(缺货/出餐慢/已配送等)</td> </tr> <tr> <td>106</td> <td>寄方要求取消(暂时不需要寄件了/重复发单/信息有误)</td> </tr> <tr> <td>107</td> <td>配送车辆故障</td> </tr> <tr> <td>108</td> <td>其他,请注明原因</td> </tr> <tr> <td>303</td> <td>骑士要求取消</td> </tr> <tr> <td>310</td> <td>超出配送范围</td> </tr> <tr> <td>500</td> <td>15分钟无人接单</td> </tr> <tr> <td>501</td> <td>不兜底订单自动取消</td> </tr> <tr> <td>502</td> <td>超期望送达8小时未完成</td> </tr> </tbody> </table>

页面列表

ITEM_HTML