通知接口
<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;">由客户提供</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;">totalAmount</td>
<td style="text-align: center;">Integer</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">寄件应付金额。包括：运费+保价费 N 单位为分</td>
</tr>
<tr>
<td style="text-align: center;">2</td>
<td style="text-align: center;">discountAmount</td>
<td style="text-align: center;">Integer</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">优惠金额 N 单位为分</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">paymentAmount</td>
<td style="text-align: center;">Integer</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">实付金额 N 单位为分</td>
</tr>
<tr>
<td style="text-align: center;">4</td>
<td style="text-align: center;">freight</td>
<td style="text-align: center;">Integer</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;">expressNo</td>
<td style="text-align: center;">String</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;">boxType</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">柜机格口类型 N 柜机格口类型(1大、2中、3小)</td>
</tr>
<tr>
<td style="text-align: center;">7</td>
<td style="text-align: center;">clientPostTime</td>
<td style="text-align: center;">String</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;">outerOrderId</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">外部ID，第三方ID</td>
</tr>
<tr>
<td style="text-align: center;">9</td>
<td style="text-align: center;">sendId</td>
<td style="text-align: center;">String</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;">orderId</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">丰巢 订单号</td>
</tr>
<tr>
<td style="text-align: center;">11</td>
<td style="text-align: center;">sendNoticeType</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">类型 Y 101：投递入柜，102：收件，103：运输途中，104：签收，105：取消，106：取返件，901：转单，902：变更运单号</td>
</tr>
<tr>
<td style="text-align: center;">12</td>
<td style="text-align: center;">sendNoticeTypeName</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">类型说明</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">pointCode</td>
<td style="text-align: center;">String</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;">provinceName</td>
<td style="text-align: center;">String</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;">cityName</td>
<td style="text-align: center;">String</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;">countryName</td>
<td style="text-align: center;">String</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;">addressDetail</td>
<td style="text-align: center;">String</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;">getTime</td>
<td style="text-align: center;">String</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;">mobile</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">收件人手机号</td>
</tr>
<tr>
<td style="text-align: center;">20</td>
<td style="text-align: center;">cancelCode</td>
<td style="text-align: center;">String</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;">cancelReason</td>
<td style="text-align: center;">String</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;">cancelTime</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">取消寄件时间</td>
</tr>
<tr>
<td style="text-align: center;">23</td>
<td style="text-align: center;">cancelType</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">取消类型 取消类型（1：用户取消，2：收派员取消，3：客服取消，4：寄件码失效，5：转单后终止，6：服务站管理员取消，7：系统取消，8：投递入柜用户取消(格口中有物品，9：投递入柜用户取消(格口中无物品）</td>
</tr>
<tr>
<td style="text-align: center;">24</td>
<td style="text-align: center;">validCancelCode</td>
<td style="text-align: center;">Boolean</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">是否校验取件码 N true 校验取件码 false 不校验取件码</td>
</tr>
<tr>
<td style="text-align: center;">25</td>
<td style="text-align: center;">getReturnTime</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">取返件时间</td>
</tr>
<tr>
<td style="text-align: center;">26</td>
<td style="text-align: center;">getReturnType</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">取返件方式 取返件方式（1：客户取返件，2：超级管理员取件，3：远程开格口取件）</td>
</tr>
</tbody>
</table>
<h3>报文范例</h3>
<ul>
<li><strong>请求报文</strong>
<pre><code>入柜通知：
{
"addressDetail":"FC75528336-李冬秀2套丰巢柜",
"boxType":"3",
"cityName":"深圳市",
"clientPostTime":"2022-09-08 14:35:04",
"countryName":"南山区",
"discountAmount":0,
"expressNo":"SF1690014010971",
"freight":0,
"orderId":"2022090800000031",
"outerOrderId":"202209081405",
"paymentAmount":100,
"pointCode":"FC75528336",
"provinceName":"广东省",
"sendId":"2022090800000031",
"sendNoticeType":"101",
"sendNoticeTypeName":"投递入柜",
"totalAmount":100
}
收件通知：
{
"expressNo":"SF1690014011170",
"getTime":"2022-09-08 14:41:35",
"mobile":"13418623323",
"orderId":"2022090800000032",
"outerOrderId":"202209081406",
"sendId":"2022090800000032",
"sendNoticeType":"102",
"sendNoticeTypeName":"收件"
}
取消通知：
{
"addressDetail":"永新汇2号11栋e栈快递柜20eeeeeeee",
"cancelCode":"67262926",
"cancelReason":"疑似违禁品",
"cancelTime":"2022-09-08 14:41:39",
"cancelType":"2",
"cityName":"深圳市",
"countryName":"南山区",
"expressNo":"SF1690014011170",
"orderId":"2022090800000032",
"outerOrderId":"202209081406",
"pointCode":"FC7558750",
"provinceName":"广东省",
"sendId":"2022090800000032",
"sendNoticeType":"105",
"sendNoticeTypeName":"取消",
"validCancelCode":true
}
取返件通知：
{
"getReturnTime":"Tue Sep 13 18:24:17 CST 2022",
"getReturnType":"1",
"orderId":"2022091300000036",
"outerOrderId":"202209131704",
"sendId":"2022091300000036",
"sendNoticeType":"106",
"sendNoticeTypeName":"取返件"
}</code></pre></li>
</ul>