24.取件码核销接口
<h3>功能描述</h3>
<ul>
<li>该接口用于：下单人需要验证实际寄件人身份时使用。仅在实际寄件人告知快递小哥取件码，系统将取件码传输至客户系统验证成功后，小哥才能揽收成功；</li>
</ul>
<pre><code>注：1.只有使用开通取件码功能的客户编码下单，才能进行取件码核销；
2.取件码由客户系统进行核销；
3.此接口为推送类接口；</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;">客户方提供</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;">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;">2</td>
<td style="text-align: center;">waybillNo</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;">pickCode</td>
<td style="text-align: center;">String(32)</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;">verifyTime</td>
<td style="text-align: center;">String(32)</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;">success</td>
<td style="text-align: center;">Boolean</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">核销结果：true-成功；false-失败；</td>
</tr>
<tr>
<td style="text-align: center;">2</td>
<td style="text-align: center;">retryFlag</td>
<td style="text-align: center;">Boolean</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">是否需要再次核销：true-需要；false-不需要；</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">errorCode</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">错误代码：10-取件码错误；11-当前状态不支持核销取件码；500-系统错误；</td>
</tr>
<tr>
<td style="text-align: center;">4</td>
<td style="text-align: center;">errorMsg</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>{
&quot;orderId&quot;:&quot;1611233544224&quot;,
&quot;waybillNo&quot;:&quot;SF1222222222222&quot;,
&quot;pickCode&quot;:&quot;699852&quot;,
&quot;verifyTime&quot;:&quot;2021-01-22 19:00:00&quot;
}</code></pre>
</li>
<li>
<p><strong>响应报文</strong></p>
<ol>
<li>
<p>成功报文</p>
<pre><code>{
&quot;success&quot;:true
}</code></pre>
</li>
<li>失败报文
<pre><code>{
&quot;success&quot;:false,
&quot;retryFlag&quot;:true,
&quot;errorCode&quot;:&quot;500&quot;,
&quot;errorMsg&quot;:&quot;系统错误&quot;
}</code></pre></li>
</ol>
</li>
</ul>