13.订单筛选接口
<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;">/public/order/v1/getFilter</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;">客户订单号</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">filterType</td>
<td style="text-align: center;">Number(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">筛单类别：1-自动筛单（系统根据地址库进行判断，并返回结果，系统无法检索到可派送的将返回不可派送）</td>
</tr>
<tr>
<td style="text-align: center;">4</td>
<td style="text-align: center;">dAddress</td>
<td style="text-align: center;">String(150)</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;">dTel</td>
<td style="text-align: center;">String(23)</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;">dCountry</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;">7</td>
<td style="text-align: center;">dProvince</td>
<td style="text-align: center;">String(30)</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;">dCity</td>
<td style="text-align: center;">String(100)</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;">dCounty</td>
<td style="text-align: center;">String(30)</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;">jAddress</td>
<td style="text-align: center;">String(150)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件方详细地址，包括省市区。示例：“广东省深圳市福田区新洲十一街万基商务大厦10楼”。</td>
</tr>
<tr>
<td style="text-align: center;">11</td>
<td style="text-align: center;">jTel</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件方电话</td>
</tr>
<tr>
<td style="text-align: center;">12</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;">CN</td>
<td style="text-align: left;">寄件人所在国家代码</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">province</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件方所在省份，必须是标准的省名称称谓。如：广东省，如果是直辖市，请直接传北京、上海等。</td>
</tr>
<tr>
<td style="text-align: center;">14</td>
<td style="text-align: center;">city</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件方所属城市名称，必须是标准的城市称谓。如：深圳市。</td>
</tr>
<tr>
<td style="text-align: center;">15</td>
<td style="text-align: center;">county</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件人所在县/区，必须是标准的县/区称谓。示例：“福田区”。</td>
</tr>
<tr>
<td style="text-align: center;">16</td>
<td style="text-align: center;">jCustId</td>
<td style="text-align: center;">String(30)</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(/)</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;">filterResult</td>
<td style="text-align: center;">Number(2)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">筛单结果</td>
<td style="text-align: left;">1-人工确认；2-可收派；3-不可以收派；4-地址无法确认。filterType=1时，不存在1值。</td>
</tr>
<tr>
<td style="text-align: center;">6</td>
<td style="text-align: center;">originCode</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;">如果可收派，此项不能为空。</td>
</tr>
<tr>
<td style="text-align: center;">7</td>
<td style="text-align: center;">destCode</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;">如果可收派，此项不能为空。</td>
</tr>
<tr>
<td style="text-align: center;">8</td>
<td style="text-align: center;">remark</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;">1-收方超范围；2-派方超范围；3-其它原因。filterResult=3时为必填</td>
</tr>
</tbody>
</table>
<h3>报文范例</h3>
<ul>
<li>
<p><strong>请求报文</strong></p>
<pre><code>{
&quot;companyId&quot;:&quot;201905140011898&quot;,
&quot;orderId&quot;:&quot;60bb3722de66491291eaf3438e8e65a0&quot;,
&quot;filterType&quot;:1,
&quot;dAddress&quot;:&quot;广东省深圳市福田区新洲十一街万基商务大厦&quot;,
&quot;dProvince&quot;:&quot;广东省&quot;,
&quot;dCity&quot;:&quot;深圳市&quot;,
&quot;dCounty&quot;:&quot;福田区&quot;,
&quot;jAddress&quot;:&quot;广东省深圳市福田区新洲十一街万基商务大厦10楼&quot;
&quot;province&quot;:&quot;广东省&quot;,
&quot;city&quot;:&quot;深圳市&quot;,
&quot;county&quot;:&quot;福田区&quot;
}</code></pre>
</li>
<li><strong>响应报文</strong>
<ul>
<li>成功报文
<pre><code>{
&quot;succ&quot;: &quot;ok&quot;,
&quot;msg&quot;: null,
&quot;result&quot;:{
&quot;orderId&quot;: &quot;60bb3722de66491291eaf3438e8e65a0&quot;,
&quot;destCode&quot;: &quot;755&quot;,
&quot;filterResult&quot;: &quot;2&quot;,
&quot;originCode&quot;: &quot;755&quot;,
&quot;remark&quot;: null
}
}</code></pre></li>
<li>失败报文-范例
<pre><code>{
&quot;result&quot;: null,
&quot;succ&quot;: &quot;fail&quot;,
&quot;msg&quot;: &quot;订单不存在&quot;
}</code></pre></li>
</ul></li>
</ul>