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


34.国补通知推送接口

<h3>功能描述</h3> <ul> <li> <p>该接口用于: 1、回传国补订单签收时3C数码产品外包装的SN码、IMEI码等照片信息,需与顺丰客户经理线下沟通后对接(获取微派任务编码、费用信息等) 2、下单或改单接口扩展字段有下发国补信息才会触发推送任务,对应参数为subsidySource、wpMerchantCode、wpServiceCode、wpExtJson,参数说明详见下单接口文档2.3.7.1 扩展字段备注 3、沙箱下单成功并且扩展字段带有4个国补参数,会自动推送mock的图片信息,扩展字段值沙箱不校验</p> </li> <li>客户需提供一个符合以下规范的HTTP/HTTPS URL,以接收顺丰快递管家通用接口推送的信息: 1.国补推送信息为JSON格式,通过HTTP/HTTPS POST方式推送给客户; 2.向顺丰快递管家通用接口返回响应JSON信息,响应JSON报文结果只能为true/false,如为false,顺丰快递管家通用接口将重新推送该国补信息,失败3次后不再推送;</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>元素&lt;请求&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <p>请求参数</p> <h1>属性名 类型(约束) 必填 默认值 描述</h1> <p>1 waybillNo String 是 客户运单号 2 imei String 否 多个iemi使用逗号分割。例如:358598528,24785223242。3C国补有此值 3 sn String 否 3C国补有此值 4 wpServiceCode String 否 微派任务编码 5 photoList List&lt;PhotoObject&gt; 否 图片信息 5.1 -photoUrl String 否 图片地址。list中的url地址是加密。url有效期24小时。解密示例见文档后面的《photoUrl解密示例》。秘钥由顺丰分配,16位长度的字母数字组成,例如:abcdefghij123456 5.2 -photoType String 否 1.设备背面照片;2.外观照片;3.面单照片;4.外包装SN码照片;5.开机后IMEI/SN码照片;6.亮屏照片(电脑、平板、穿戴)、7.组合拍照、8.打孔拍照 5.3 -photoTime String 否 yyyy-MM-dd HH:mm:ss格 式 5.4 -scanContent String 否 扫拍识别内容 6 scanResult List&lt;ScanResultObject&gt; 否 收件任务。只有家电国补有 6.1 -code String 否 采集项编码 6.2 -details List&lt;DetailsObject&gt; 否 详情列表 6.2.1 - - -verifyCode String 否 扫码采集的文本内容 6.2.2 - - -createTime String 否 采集时间,yyyy-MM-dd HH:mm:ss格式 6.2.3 - - -status String 否 核销状态: UNVERIFIED:待核销; VERIFIED:已核销; SUPPLEMENT:补录</p> <h3>元素&lt;响应&gt;</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;">success</td> <td style="text-align: center;">Boolean</td> <td style="text-align: center;">是</td> <td style="text-align: center;">接收推送信息状态</td> <td style="text-align: left;">true-成功,false-失败;失败会重推两次,共推送三次,全部返回ERR则不再推送。</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文1</strong></p> <pre><code>{ &amp;quot;photoList&amp;quot;: [ { &amp;quot;photoUrl&amp;quot;: &amp;quot;fGYLPBIJoPogeiLTK4BbSbdR9ugy0KTl+m0JQ4GvgvgmSP+rsh0yig1XdzPHHy7gVJ0bD+0V9+7vniVrzFLBOUF8AsWqx7Hl7V9ZihsrRCq7FWC9EFFcHE7KsRNtucPwk49IieY16jVTlVr81HE/RKArjfs9MYK8C/8LVYTxTn/Am71LDrbEfN5vb3FTL/IKIRIzSgK4vSzcJSsHBNMcBRAqFY7qhwy2nuER17OQ5wJlscEA5tO8teDgLgZxe8vMc5TW2elSdsuBpg0TdUGDVDNjKjB4nIZQiKxP661/eHUKOFyXzKeMjp8YMOcLlvDTRGWtOFH+RY+co9DmjQ5L3d13oIEu3dN0XwqmzkDZdiT7CdpkXQIAr4+rTs1m93BYD/D4y3fV+w9HaVOzOyEau1PNExxbnzI0GnDaLADR0QwDFKTiJypHqImnJ1QKzLCEh62LAmq0RYTbkoBygJcljLVx32gt3jf+vt0BQsEt1oPBD/RL8ow47NYA0XR59kZaih7GL542nXMTi+vaXGpJONO5dEcuDVXRs3Jmc3g1uQp6IlXj6j/2q1ul3hzVxyjkElk2SCgnoqVpwpwJuSMqZA1YF7iin3KiMASftT5qQ2+9jKhrI0BkGwahL2ag70jXy1xDZRu+Q+QUUiipgay3KW+2G9Z12bB/vf2g1v3FOJQ=&amp;quot;, &amp;quot;photoType&amp;quot;: &amp;quot;3&amp;quot;, &amp;quot;photoTime&amp;quot;: &amp;quot;2024-12-29 00:55:10&amp;quot; }, { &amp;quot;photoUrl&amp;quot;: &amp;quot;fGYLPBIJoPogeiLTK4BbSbdR9ugy0KTl+m0JQ4GvgvgmSP+rsh0yig1XdzPHHy7gVJ0bD+0V9+7vniVrzFLBOUF8AsWqx7Hl7V9ZihsrRCoZdhkZbHyW15kQUogBwdMEiQPus/cia3KtHTuo5I7j0GqBRtUR/TxR/SpNpRaGFQJC5vM2unTtQqk8MTpMWiKvXhJrmNCBMgo1zRNcqwLJNVRy0iAZxU2CkZEmu9EDXTrAHJb6xo4nSNKBUHQJq9hRqH0/uG6n99Lt4bTga41rbloF0w/T1HHvRSM0uLYtfm3ayHRMfCw0irFWym04AH3RIPH5U+w88gzCaq+TypGenMfp+ycrwWPkn3ZaIJJ13NxacOHZ22x3fs0e31U/fbKG4VU1EPRNp0bFL+MuUPwU5nBYdow0kM37zX3ocQL3/LRxXKXZEOTe5sgOvvC+VcZvvAEUQPQau0Ck0v9UJeBJHh0oYFTxbur9B9SLbrZuISl1qbdDCK9yLvs7PFJlRqzpaPKtKxrgSEMWE5/MpIsWYNJFwB3tEM1v4Wr7PV7jyHJebbEbGzuX+n/LRBQaieZTnHb2g8ZLDc1YC38my0eZkC5SHAGocm8CnTRW6HMSUCKd6fM8FbmQvXPJCCIq3SotX8qQGxHJ2FBeNqKZG8cflkETr7CkHyk8Re//7UNW1Tk=&amp;quot;, &amp;quot;photoType&amp;quot;: &amp;quot;5&amp;quot;, &amp;quot;photoTime&amp;quot;: &amp;quot;2024-12-29 00:55:05&amp;quot; }, { &amp;quot;photoUrl&amp;quot;: &amp;quot;fGYLPBIJoPogeiLTK4BbSbdR9ugy0KTl+m0JQ4GvgvgmSP+rsh0yig1XdzPHHy7gVJ0bD+0V9+7vniVrzFLBOUF8AsWqx7Hl7V9ZihsrRCqVa1X+atr6D1KDWxNZUpXh4aE7AS4Gm7bg+OktW3PNowW1RHH/UwEIu0K+QGM98+ECdHWCt5Juw6B0uifqPaIWlORQxC6i4e1yPrgrAjtlBe/i6qGyxxSGgSGFPolbSTx5lC+xBJtqDcpIQT3+zJMkjXyqlDdBm9+jhvgGHYhetbYztgR83Xf1zTVxq455rDxRpYZvXsBiNN3eETV6kn7S+gLih89Nq6igFYuhZAI7X/3ePxJ8fkBvRUd0w95hn9886rEjo3GBNbMj2TPiD3KbzdggQzFxhIiYPlC+HL2j7ChrYQ2s/ojpdIL6P1vuTsCr+9e12dQWpJBSi6JtkB/jc1iMjYSGb+DL9Fl1HqYk+CKdV639vn1+Z1Ehh3f5HCfcUHe6gXOUzkfRcuAgF3TTPHq4DA5xpukkkauyQeSYECEzBIPke0IO+lRUKFz4kqMC9h+ngIWpzIvFBOznEJRLTUYZGLd9owwuEr4PgOPiBcoCvD4h0RjpDlR6Mk0O2gxDfJGspCQlWVbcsf9Bf9sF9jI4VC+VIZhTzFNyRL8XTe4zLiEYrMhPLwLCi+DHWko=&amp;quot;, &amp;quot;photoType&amp;quot;: &amp;quot;8&amp;quot;, &amp;quot;photoTime&amp;quot;: &amp;quot;2024-12-29 00:55:01&amp;quot; } ], &amp;quot;wpServiceCode&amp;quot;: &amp;quot;Pro24032525&amp;quot;, &amp;quot;completeTime&amp;quot;: &amp;quot;2024-12-29 00:56:00&amp;quot;, &amp;quot;imei&amp;quot;: &amp;quot;imei1111111&amp;quot;, &amp;quot;sn&amp;quot;: &amp;quot;1111122222&amp;quot;, &amp;quot;waybillNo&amp;quot;: &amp;quot;SF3100002190142&amp;quot; }</code></pre> <p>请求业务报文msgData示例2</p> <pre><code>{ &amp;quot;wpServiceCode&amp;quot;: &amp;quot;Pro24032525&amp;quot;, &amp;quot;completeTime&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;imei&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;sn&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;scanResult&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;verifyCode1&amp;quot;, &amp;quot;details&amp;quot;: [ { &amp;quot;verifyCode&amp;quot;: &amp;quot;123456&amp;quot;, &amp;quot;createTime&amp;quot;: &amp;quot;2025-01-01 00:00:00&amp;quot;, &amp;quot;status&amp;quot;: &amp;quot;VERIFIED&amp;quot; } ] }, { &amp;quot;code&amp;quot;: &amp;quot;verifyCode2&amp;quot;, &amp;quot;details&amp;quot;: [ { &amp;quot;verifyCode&amp;quot;: &amp;quot;123456&amp;quot;, &amp;quot;createTime&amp;quot;: &amp;quot;2025-01-01 00:00:00&amp;quot;, &amp;quot;status&amp;quot;: &amp;quot;VERIFIED&amp;quot; } ] } ], &amp;quot;waybillNo&amp;quot;: &amp;quot;SF3100002190142&amp;quot; }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{ &amp;quot;success&amp;quot;:&amp;quot;true&amp;quot; }</code></pre> </li> <li>失败报文 <pre><code>{ &amp;quot;success&amp;quot;:&amp;quot;false&amp;quot; }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML