12.清单运费+订单详情推送接口
<h3>功能描述</h3>
<ul>
<li>该接口用于:快递员揽件后,将真实折前运费和订单详情推送给客户。</li>
<li>客户需提供一个符合以下规范的HTTP/HTTPS URL,以接收顺丰快递管家通用接口推送的信息:
1.清单运费信息为JSON格式,通过HTTP/HTTPS POST方式推送给客户;
2.在客户处理完运费信息后,向顺丰快递管家通用接口返回响应JSON信息,响应JSON报文结果只能为OK/ERR,如为ERR,顺丰快递管家通用接口将重新推送该运费信息,失败3次后不再推送;</li>
</ul>
<pre><code>注:1.此接口建议客户方系统做验签功能,规避被恶意攻击的风险;
2.建议使用订单号作为筛选条件进行订单信息的更新,因为运单号存在可能为子单号/签回单号的情况;
3.测试环境如需测试该接口,请将测试环境下单后的订单号与运单号发给顺丰研发接口人,便于其生成相关测试数据;
4.推送方式为增量推送,对于同一个顺丰运单的同一条信息,推送成功则不重复推送,推送失败则会再次推送,失败3次后不再推送;
5.以防推送接口有延迟,建议配合对应查询接口,对一段时间内没有收到推送消息的订单,主动查询清单运费信息;</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>
<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: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">1</td>
<td style="text-align: center;">orderNo</td>
<td style="text-align: center;">String(64)</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;">waybillNo</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">运单号:顺丰下单接口返回的15位运单号(母单号),如:SF10116351372291</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">meterageWeightQty</td>
<td style="text-align: center;">Double(17,3)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">计费重量:包裹计费重量(单位:kg)</td>
</tr>
<tr>
<td style="text-align: center;">4</td>
<td style="text-align: center;">productName</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">产品名称。如顺丰特惠、顺丰标快</td>
</tr>
<tr>
<td style="text-align: center;">5</td>
<td style="text-align: center;">quantity</td>
<td style="text-align: center;">Number(5)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">包裹数:托寄物包裹数量</td>
</tr>
<tr>
<td style="text-align: center;">6</td>
<td style="text-align: center;">receiveCompany</td>
<td style="text-align: center;">String(33)</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;">receiveContact</td>
<td style="text-align: center;">String(33)</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;">receiveAddress</td>
<td style="text-align: center;">String(200)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">收件地址</td>
</tr>
<tr>
<td style="text-align: center;">9</td>
<td style="text-align: center;">receiveMobile</td>
<td style="text-align: center;">String(11)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">收件人手机号</td>
</tr>
<tr>
<td style="text-align: center;">10</td>
<td style="text-align: center;">sendStartTime</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">预约时间。格式:yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td style="text-align: center;">11</td>
<td style="text-align: center;">depositumInfo</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">托寄物内容</td>
</tr>
<tr>
<td style="text-align: center;">12</td>
<td style="text-align: center;">payMethod</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">运费付款方式。0-寄付月结;1-寄付现结;2-收方付;3-第三方付;</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">sendCompany</td>
<td style="text-align: center;">String(33)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">寄件公司</td>
</tr>
<tr>
<td style="text-align: center;">14</td>
<td style="text-align: center;">sendContact</td>
<td style="text-align: center;">String(33)</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;">sendAddress</td>
<td style="text-align: center;">String(200)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">寄件地址</td>
</tr>
<tr>
<td style="text-align: center;">16</td>
<td style="text-align: center;">sendMobile</td>
<td style="text-align: center;">String(11)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">寄件人手机号</td>
</tr>
<tr>
<td style="text-align: center;">17</td>
<td style="text-align: center;">custId</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">月结卡号</td>
</tr>
<tr>
<td style="text-align: center;">18</td>
<td style="text-align: center;">orderStateDesc</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">订单状态</td>
</tr>
<tr>
<td style="text-align: center;">19</td>
<td style="text-align: center;">sendState</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">派送状态: 已收件/运输中/转寄中/正在派送/派送失败/派送成功</td>
</tr>
<tr>
<td style="text-align: center;">20</td>
<td style="text-align: center;">modifyTm</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">更新时间。格式:yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td style="text-align: center;">21</td>
<td style="text-align: center;">submitTm</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">下单时间。格式:yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td style="text-align: center;">22</td>
<td style="text-align: center;">isSelfGet</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">是否自取。0-否;1-是;</td>
</tr>
<tr>
<td style="text-align: center;">23</td>
<td style="text-align: center;">creatorUser</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">创建人</td>
</tr>
<tr>
<td style="text-align: center;">24</td>
<td style="text-align: center;">orgName</td>
<td style="text-align: center;">String(50)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">所属组织名称</td>
</tr>
<tr>
<td style="text-align: center;">25</td>
<td style="text-align: center;">channelIdentification</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">下单渠道。1-web端;2-小程序端;3-通用接口;4-单点登录;5-H5;</td>
</tr>
<tr>
<td style="text-align: center;">26</td>
<td style="text-align: center;">waybillChilds</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">子单号,多个英文逗号分隔,防止子单号较多导致存储异常,建议使用更大容量类型</td>
</tr>
<tr>
<td style="text-align: center;">27</td>
<td style="text-align: center;">volume</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">体积,托寄物总体积</td>
</tr>
<tr>
<td style="text-align: center;">28</td>
<td style="text-align: center;">extra</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">自定义字段1,需下单时定义否则不会推送</td>
</tr>
<tr>
<td style="text-align: center;">29</td>
<td style="text-align: center;">customField2</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">自定义字段2,需下单时定义否则不会推送</td>
</tr>
<tr>
<td style="text-align: center;">30</td>
<td style="text-align: center;">feeList</td>
<td style="text-align: center;">List<FeeInfo></td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">费用:List形式</td>
</tr>
</tbody>
</table>
<ul>
<li><strong>FeeInfo 字段说明</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: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">1</td>
<td style="text-align: center;">bizOwnerZoneCode</td>
<td style="text-align: center;">String(100)</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;">currencyCode</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">币别</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">feeAmt</td>
<td style="text-align: center;">Double(17,3)</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;">feeAmtInd</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">个性化费用(如一些折扣或加价费用)</td>
</tr>
<tr>
<td style="text-align: center;">5</td>
<td style="text-align: center;">feeIndType</td>
<td style="text-align: center;">Number(5)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">个性费用类型</td>
</tr>
<tr>
<td style="text-align: center;">6</td>
<td style="text-align: center;">gatherEmpCode</td>
<td style="text-align: center;">String(100)</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;">gatherZoneCode</td>
<td style="text-align: center;">String(30)</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;">paymentChangeTypeCode</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">付款变更类型</td>
</tr>
<tr>
<td style="text-align: center;">9</td>
<td style="text-align: center;">paymentTypeCode</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">付款类型:1-寄付;2-到付;3-第三方付;</td>
</tr>
<tr>
<td style="text-align: center;">10</td>
<td style="text-align: center;">serviceId</td>
<td style="text-align: center;">String(100)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">运单服务标记,可忽略</td>
</tr>
<tr>
<td style="text-align: center;">11</td>
<td style="text-align: center;">settlementTypeCode</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">结算类型:1-现结;2-月结;</td>
</tr>
<tr>
<td style="text-align: center;">12</td>
<td style="text-align: center;">versionNo</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">版本号:当红冲后版本号会增加</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">waybillId</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">运单关联标记,可忽略</td>
</tr>
<tr>
<td style="text-align: center;">14</td>
<td style="text-align: center;">waybillNo</td>
<td style="text-align: center;">String(30)</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;">feeTypeCode</td>
<td style="text-align: center;">String(30)</td>
<td style="text-align: center;">是</td>
<td style="text-align: left;">费用类型:1-主运费;2-其他费用;3-保费;4-代收货款服务费;5-代收货款</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>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">1</td>
<td style="text-align: center;">status</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-成功,ERR-失败;失败会重推两次,共推送三次,全部返回ERR则不再推送。</td>
</tr>
</tbody>
</table>
<h3>报文范例</h3>
<ul>
<li>
<p><strong>请求报文</strong></p>
<pre><code>{
&quot;orderNo&quot;: &quot;52840aa5ec1c4f52a20864baad9c70c5&quot;,
&quot;waybillNo&quot;: &quot;444166336658&quot;,
&quot;meterageWeightQty&quot;: 1,
&quot;productName&quot;: &quot;顺丰标快&quot;,
&quot;quantity&quot;: 1,
&quot;receiveCompany&quot;: &quot;顺丰科技&quot;,
&quot;receiveContact&quot;: &quot;测试单&quot;,
&quot;receiveAddress&quot;: &quot;深圳市广东省深圳市南山区深南大道9037号&quot;,
&quot;receiveMobile&quot;: &quot;15912345678&quot;,
&quot;sendStartTime&quot;: &quot;2021-12-30 10:00:00&quot;,
&quot;depositumInfo&quot;: &quot;鞋子&quot;,
&quot;payMethod&quot;: &quot;0&quot;,
&quot;sendCompany&quot;: &quot;顺丰速运&quot;,
&quot;sendContact&quot;: &quot;测试单&quot;,
&quot;sendAddress&quot;: &quot;广东省深圳市南山区粤海街道海阔天空雅居B栋16B&quot;,
&quot;sendMobile&quot;: &quot;15912345678&quot;,
&quot;custId&quot;: &quot;9999999999&quot;,
&quot;orderStateDesc&quot;: &quot;调度成功&quot;,
&quot;sendState&quot;: &quot;已收件&quot;,
&quot;modifyTm&quot;: &quot;2021-12-30 10:00:00&quot;,
&quot;submitTm&quot;: &quot;2021-12-30 10:00:00&quot;,
&quot;isSelfGet&quot;: &quot;0&quot;,
&quot;creatorUser&quot;: &quot;18210356392&quot;,
&quot;orgName&quot;: &quot;通用接口(勿删)&quot;,
&quot;channelIdentification&quot;: 3,
&quot;waybillChilds&quot;: &quot;SF2070017853671,SF2070017853689&quot;,
&quot;feeList&quot;: [
{
&quot;gatherEmpCode&quot;: &quot;000212&quot;,
&quot;inputTm&quot;: 1587455508000,
&quot;gatherZoneCode&quot;: &quot;755A&quot;,
&quot;paymentTypeCode&quot;: &quot;1&quot;,
&quot;feeAmtInd&quot;: 33,
&quot;feeIndType&quot;: 0,
&quot;feeAmt&quot;: 33,
&quot;feeTypeCode&quot;: &quot;1&quot;,
&quot;paymentChangeTypeCode&quot;: &quot;0&quot;,
&quot;settlementTypeCode&quot;: &quot;1&quot;,
&quot;versionNo&quot;: 0,
&quot;waybillId&quot;: -1,
&quot;bizOwnerZoneCode&quot;: &quot;755A&quot;,
&quot;currencyCode&quot;: &quot;CNY&quot;,
&quot;waybillNo&quot;: &quot;444166336658&quot;
},
{
&quot;gatherEmpCode&quot;: &quot;000212&quot;,
&quot;gatherZoneCode&quot;: &quot;755A&quot;,
&quot;paymentTypeCode&quot;: &quot;1&quot;,
&quot;feeAmtInd&quot;: 100.01,
&quot;feeIndType&quot;: 0,
&quot;feeAmt&quot;: 100.01,
&quot;feeTypeCode&quot;: &quot;67&quot;,
&quot;paymentChangeTypeCode&quot;: &quot;0&quot;,
&quot;settlementTypeCode&quot;: &quot;1&quot;,
&quot;versionNo&quot;: 0,
&quot;waybillId&quot;: -1,
&quot;serviceId&quot;: -1,
&quot;bizOwnerZoneCode&quot;: &quot;755A&quot;,
&quot;currencyCode&quot;: &quot;CNY&quot;,
&quot;waybillNo&quot;: &quot;444166336658&quot;
},
{
&quot;gatherEmpCode&quot;: &quot;000212&quot;,
&quot;gatherZoneCode&quot;: &quot;755A&quot;,
&quot;paymentTypeCode&quot;: &quot;1&quot;,
&quot;feeAmtInd&quot;: 100.01,
&quot;feeIndType&quot;: 0,
&quot;feeAmt&quot;: 100.01,
&quot;feeTypeCode&quot;: &quot;12&quot;,
&quot;paymentChangeTypeCode&quot;: &quot;0&quot;,
&quot;settlementTypeCode&quot;: &quot;1&quot;,
&quot;versionNo&quot;: 0,
&quot;waybillId&quot;: -1,
&quot;serviceId&quot;: -1,
&quot;bizOwnerZoneCode&quot;: &quot;755A&quot;,
&quot;currencyCode&quot;: &quot;CNY&quot;,
&quot;waybillNo&quot;: &quot;444166336658&quot;
},
{
&quot;gatherEmpCode&quot;: &quot;000212&quot;,
&quot;gatherZoneCode&quot;: &quot;755A&quot;,
&quot;paymentTypeCode&quot;: &quot;1&quot;,
&quot;feeAmtInd&quot;: 1,
&quot;feeIndType&quot;: 0,
&quot;feeAmt&quot;: 1,
&quot;feeTypeCode&quot;: &quot;3&quot;,
&quot;paymentChangeTypeCode&quot;: &quot;0&quot;,
&quot;settlementTypeCode&quot;: &quot;1&quot;,
&quot;versionNo&quot;: 0,
&quot;waybillId&quot;: -1,
&quot;serviceId&quot;: -1,
&quot;bizOwnerZoneCode&quot;: &quot;755A&quot;,
&quot;currencyCode&quot;: &quot;CNY&quot;,
&quot;waybillNo&quot;: &quot;444166336658&quot;
}
]
}</code></pre>
</li>
<li>
<p><strong>响应报文</strong></p>
<ol>
<li>
<p>成功报文</p>
<pre><code>{
&quot;status&quot;:&quot;OK&quot;
}</code></pre>
</li>
<li>失败报文
<pre><code>{
&quot;status&quot;:&quot;ERR&quot;
}</code></pre></li>
</ol>
</li>
</ul>