【顺丰快递管家】通用接口文档


19.到付月结使用记录推送接口

<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.推送方式为按时间范围推送,推送昨日00:00:00到23:59:59的已经补全运费的数据。推送成功则不重复推送,推送失败则会再次推送,失败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>元素&lt;请求&gt;</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: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">uuid</td> <td style="text-align: center;">String(36)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">uuid,用来记录日志。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">statementCodeUsageList</td> <td style="text-align: center;">Array</td> <td style="text-align: center;">是</td> <td style="text-align: left;">到付月结使用记录集合</td> </tr> </tbody> </table> <h4>statementCodeUsageList&lt;到付月结使用记录集合&gt;</h4> <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;">mailno</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">顺丰运单号,建议使用运单号作为筛选条件,用付款码出示时间(月结绑定时间)usageCreateTime为基准进行记录信息的更新,因为一个运单可能存在绑定多次到付月结二维码的情况</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">creator</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;">3</td> <td style="text-align: center;">creatorPhone</td> <td style="text-align: center;">String(20)</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;">creatorRealName</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;">5</td> <td style="text-align: center;">organizationName</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;">6</td> <td style="text-align: center;">senderContact</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;">7</td> <td style="text-align: center;">senderMobile</td> <td style="text-align: center;">String(20)</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;">senderTel</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;">9</td> <td style="text-align: center;">senderAddress</td> <td style="text-align: center;">String(600)</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;">recipientContact</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;">11</td> <td style="text-align: center;">recipientTel</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;">12</td> <td style="text-align: center;">recipientMobile</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;">13</td> <td style="text-align: center;">recipientAddress</td> <td style="text-align: center;">String(600)</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;">totalFee</td> <td style="text-align: center;">String(20)</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;">feeAmt</td> <td style="text-align: center;">String(20)</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;">vasFee</td> <td style="text-align: center;">String(20)</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;">meterageWeightQty</td> <td style="text-align: center;">String(20)</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;">packagesNo</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;">usageCreateTime</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;">20</td> <td style="text-align: center;">signTime</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;">21</td> <td style="text-align: center;">thirdPlatformId</td> <td style="text-align: center;">String(40)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">第三方平台用户ID --- 待上线</td> </tr> <tr> <td style="text-align: center;">22</td> <td style="text-align: center;">custid</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;">23</td> <td style="text-align: center;">objString</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">月结码加密串</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</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;">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>{ &amp;quot;statementCodeUsageList&amp;quot;: [ { &amp;quot;creator&amp;quot;: &amp;quot;jsx123456&amp;quot;, &amp;quot;senderAddress&amp;quot;: &amp;quot;北京北京市顺义区****&amp;quot;, &amp;quot;meterageWeightQty&amp;quot;: &amp;quot;1.0&amp;quot;, &amp;quot;organizationName&amp;quot;: &amp;quot;北京区公司&amp;quot;, &amp;quot;senderMobile&amp;quot;: &amp;quot;176****2218&amp;quot;, &amp;quot;creatorPhone&amp;quot;: &amp;quot;176****2218&amp;quot;, &amp;quot;senderTel&amp;quot;: &amp;quot;1761******&amp;quot;, &amp;quot;mailno&amp;quot;: &amp;quot;SF2060036071435&amp;quot;, &amp;quot;creatorRealName&amp;quot;: &amp;quot;沈轩&amp;quot;, &amp;quot;packagesNo&amp;quot;: &amp;quot;3.0&amp;quot;, &amp;quot;totalFee&amp;quot;: &amp;quot;17&amp;quot;, &amp;quot;senderContact&amp;quot;: &amp;quot;刘二&amp;quot;, &amp;quot;usageCreateTime&amp;quot;: &amp;quot;2021-09-18 10:54:37&amp;quot;, &amp;quot;recipientAddress&amp;quot;: &amp;quot;北京市北京市丰台区北京北京市丰台区****&amp;quot; }, { &amp;quot;creator&amp;quot;: &amp;quot;jsx123456&amp;quot;, &amp;quot;senderAddress&amp;quot;: &amp;quot;北京北京市顺义区****&amp;quot;, &amp;quot;meterageWeightQty&amp;quot;: &amp;quot;1.0&amp;quot;, &amp;quot;organizationName&amp;quot;: &amp;quot;北京区公司&amp;quot;, &amp;quot;signTime&amp;quot;: &amp;quot;2021-11-02 17:03:37&amp;quot;, &amp;quot;senderMobile&amp;quot;: &amp;quot;176****2218&amp;quot;, &amp;quot;creatorPhone&amp;quot;: &amp;quot;176****2218&amp;quot;, &amp;quot;senderTel&amp;quot;: &amp;quot;1761******&amp;quot;, &amp;quot;mailno&amp;quot;: &amp;quot;SF1020099331790&amp;quot;, &amp;quot;creatorRealName&amp;quot;: &amp;quot;沈轩&amp;quot;, &amp;quot;packagesNo&amp;quot;: &amp;quot;3.0&amp;quot;, &amp;quot;totalFee&amp;quot;: &amp;quot;15&amp;quot;, &amp;quot;senderContact&amp;quot;: &amp;quot;沈轩&amp;quot;, &amp;quot;usageCreateTime&amp;quot;: &amp;quot;2021-09-18 10:54:37&amp;quot;, &amp;quot;recipientAddress&amp;quot;: &amp;quot;北京市北京市丰台区北京北京市丰台区****&amp;quot; } ], &amp;quot;uuid&amp;quot;: &amp;quot;1fbb15aa44db446fa543fcc413ca9971&amp;quot; }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{ &amp;quot;status&amp;quot;:&amp;quot;OK&amp;quot; }</code></pre> </li> <li>失败报文 <pre><code>{ &amp;quot;status&amp;quot;:&amp;quot;ERR&amp;quot; }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML