9.通缉拦截接口
<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/v1/toWantedIntercept</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>
<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;">快递管家的订单拦截时，orderId字段必填；非快递管家订单拦截，orderId 不可传值</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">waybillNo</td>
<td style="text-align: center;">String(4000)</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;">serviceCode</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">1-转寄；2-退回；3-优派；4-再派；5-改自取（已作废，使用21-25）；6-改派送（上门派送）；7-更改派送时间；8-修改收件人信息；9-更改付款方式（到付才能发起改寄付）；10-修改代收货款；12-作废；21-改自取-中转场；22-改自取-网点；23-改自取-丰巢柜；24-改自取-顺丰优选；25-改自取-便利店；</td>
</tr>
<tr>
<td style="text-align: center;">5</td>
<td style="text-align: center;">role</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">发起方：1-寄方；2-收方；3-第三方；</td>
</tr>
<tr>
<td style="text-align: center;">6</td>
<td style="text-align: center;">payMode</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">付款方式：1-寄付；2-到付；3-转第三方月结；4-寄付月结；</td>
</tr>
<tr>
<td style="text-align: center;">7</td>
<td style="text-align: center;">monthlyCardNo</td>
<td style="text-align: center;">String(10)</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;">productType</td>
<td style="text-align: center;">String(4)</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;">codAmount</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">代收货款金额</td>
</tr>
<tr>
<td style="text-align: center;">10</td>
<td style="text-align: center;">deliverDate</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">派送日期，如“2018-05-02”</td>
</tr>
<tr>
<td style="text-align: center;">11</td>
<td style="text-align: center;">deliverTimeMin</td>
<td style="text-align: center;">String(5)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">派送最早时间，如“09:00”</td>
</tr>
<tr>
<td style="text-align: center;">12</td>
<td style="text-align: center;">deliverTimeMax</td>
<td style="text-align: center;">String(5)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">派送最晚时间，如“12:00”</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">selfPickPoint</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">自取点。1-合作点；2-快递柜；3-网点；4中转场；</td>
</tr>
</tbody>
</table>
<h3>元素<请求></h3>
<pre><code>新目的地：转寄、退回、改自取业务必须携带，其余不携带； 如携带，省、市、区、详细地址必填</code></pre>
<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;">14</td>
<td style="text-align: center;">country</td>
<td style="text-align: center;">String(50)</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;">15</td>
<td style="text-align: center;">countryCode</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">CN</td>
<td style="text-align: left;">国家编码</td>
</tr>
<tr>
<td style="text-align: center;">16</td>
<td style="text-align: center;">province</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">省，如广东省</td>
</tr>
<tr>
<td style="text-align: center;">17</td>
<td style="text-align: center;">city</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">市，如深圳市</td>
</tr>
<tr>
<td style="text-align: center;">18</td>
<td style="text-align: center;">county</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">区，如南山区</td>
</tr>
<tr>
<td style="text-align: center;">19</td>
<td style="text-align: center;">address</td>
<td style="text-align: center;">String(200)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">详细地址，不包含省市区，如粤海街道高新区1C栋二楼</td>
</tr>
<tr>
<td style="text-align: center;">20</td>
<td style="text-align: center;">company</td>
<td style="text-align: center;">String(33)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">公司</td>
</tr>
<tr>
<td style="text-align: center;">21</td>
<td style="text-align: center;">contact</td>
<td style="text-align: center;">String(33)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">联系人姓名，如陈新学</td>
</tr>
<tr>
<td style="text-align: center;">22</td>
<td style="text-align: center;">phone</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">电话，如18372266052</td>
</tr>
<tr>
<td style="text-align: center;">23</td>
<td style="text-align: center;">areaCode</td>
<td style="text-align: center;">String(60)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">网点代码，如755WQ</td>
</tr>
<tr>
<td style="text-align: center;">24</td>
<td style="text-align: center;">locationCode</td>
<td style="text-align: center;">String(60)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">城市代码</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>
<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 (100)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">返回数据</td>
<td style="text-align: left;">通常为null</td>
</tr>
</tbody>
</table>
<h3>报文范例</h3>
<ul>
<li>
<p><strong>请求报文</strong></p>
<pre><code>{
&quot;companyId&quot;:&quot;201905140011898&quot;,
&quot;orderId&quot;:&quot;c2f755d3f71d43d9b684858f491633e3&quot;,
&quot;waybillNo&quot;:&quot;SF1011853818145&quot;,
&quot;serviceCode&quot;:7,
&quot;role&quot;:1,
&quot;payMode&quot;:4,
&quot;deliverDate&quot;:&quot;2020-04-30&quot;,
&quot;deliverTimeMax&quot;:&quot;12:00&quot;,
&quot;deliverTimeMin&quot;:&quot;09:00&quot;,
&quot;monthlyCardNo&quot;:&quot;7551234567&quot;,
&quot;contact&quot;:&quot;牟星&quot;,
&quot;phone&quot;:&quot;15922226666&quot;,
&quot;province&quot;:&quot;广东省&quot;,
&quot;city&quot;:&quot;深圳市&quot;,
&quot;county&quot;:&quot;南山区&quot;,
&quot;address&quot;:&quot;粤海街道高新区1C栋二楼&quot;
}</code></pre>
</li>
<li><strong>响应报文</strong>
<ul>
<li>成功报文
<pre><code>{
&quot;succ&quot;:&quot;ok&quot;,
&quot;result&quot;:null,
&quot;msg&quot;:&quot;&quot;
}</code></pre></li>
<li>失败报文-范例
<pre><code>{
&quot;succ&quot;:&quot;fail&quot;,
&quot;result&quot;:null,
&quot;msg&quot;:&quot;20012:运单号：SF1011853960319的母运单:[SF1011853960319] 已经发起过转寄/退回操作&quot;
}</code></pre></li>
</ul></li>
</ul>