11.清单运费推送接口
<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.以防推送接口有延迟,建议配合对应查询接口,对一段时间内没有收到推送消息的订单,主动查询清单运费信息;
6.子母件推送运费是包含母单+子单的总费用;</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或12位运单号(母单号),如: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;">childNos</td>
<td style="text-align: center;">Text</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">子单号:多个用逗号隔开,子母件,当一票有多个包裹时,每个子件的运单号,最多1200个子单号</td>
</tr>
<tr>
<td style="text-align: center;">7</td>
<td style="text-align: center;">customerAcctCode</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">否</td>
<td style="text-align: left;">月结账号:10位数字,用来做账单结算的账号</td>
</tr>
<tr>
<td style="text-align: center;">8</td>
<td style="text-align: center;">volume</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;">9</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-主运费;其它-增值服务费</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>{
"orderNo": "52840aa5ec1c4f52a20864baad9c70c5",
"waybillNo": "444166336658",
"quantity": 1,
"meterageWeightQty": 1,
"productName": "顺丰标快",
"feeList": [
{
"gatherEmpCode": "000212",
"inputTm": 1587455508000,
"gatherZoneCode": "755A",
"paymentTypeCode": "1",
"feeAmtInd": 33,
"feeIndType": 0,
"feeAmt": 33,
"feeTypeCode": "1",
"paymentChangeTypeCode": "0",
"settlementTypeCode": "1",
"versionNo": 0,
"waybillId": -1,
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"waybillNo": "444166336658"
},
{
"gatherEmpCode": "000212",
"gatherZoneCode": "755A",
"paymentTypeCode": "1",
"feeAmtInd": 100.01,
"feeIndType": 0,
"feeAmt": 100.01,
"feeTypeCode": "67",
"paymentChangeTypeCode": "0",
"settlementTypeCode": "1",
"versionNo": 0,
"waybillId": -1,
"serviceId": -1,
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"waybillNo": "444166336658"
},
{
"gatherEmpCode": "000212",
"gatherZoneCode": "755A",
"paymentTypeCode": "1",
"feeAmtInd": 100.01,
"feeIndType": 0,
"feeAmt": 100.01,
"feeTypeCode": "12",
"paymentChangeTypeCode": "0",
"settlementTypeCode": "1",
"versionNo": 0,
"waybillId": -1,
"serviceId": -1,
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"waybillNo": "444166336658"
},
{
"gatherEmpCode": "000212",
"gatherZoneCode": "755A",
"paymentTypeCode": "1",
"feeAmtInd": 1,
"feeIndType": 0,
"feeAmt": 1,
"feeTypeCode": "3",
"paymentChangeTypeCode": "0",
"settlementTypeCode": "1",
"versionNo": 0,
"waybillId": -1,
"serviceId": -1,
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"waybillNo": "444166336658"
}
]
}</code></pre>
</li>
<li>
<p><strong>响应报文</strong></p>
<ol>
<li>
<p>成功报文</p>
<pre><code>{
"status":"OK"
}</code></pre>
</li>
<li>失败报文
<pre><code>{
"status":"ERR"
}</code></pre></li>
</ol>
</li>
</ul>