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


23.预下单校验接口

<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;">/public/order/v1/beforehandOrder</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> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配客户sendAppId</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">orderId</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">客户订单号</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">cargoName</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">拖寄物信息(传入则会校验托寄物品类信息)</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">contactInfoList</td> <td style="text-align: center;">List&lt;ContactInfo&gt;</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;">monthlyCard</td> <td style="text-align: center;">String(20)</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;">expressTypeId</td> <td style="text-align: center;">Number (5)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">快件产品类别,传值产品编码,详见《附录-2.快件产品类别表》,只有在商务上与顺丰约定的类别方可使用</td> </tr> </tbody> </table> <h4>请求元素 contactInfoList/List&lt;ContactInfo&gt;</h4> <table> <thead> <tr> <th>序号</th> <th>属性名</th> <th>类型(约束)</th> <th>必填</th> <th>默认值</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>contactType</td> <td>Number (1)</td> <td>是</td> <td></td> <td>地址类型: 1,寄件方信息 2,到件方信息</td> </tr> <tr> <td>2</td> <td>tel</td> <td>String(20)</td> <td>否</td> <td></td> <td>tel与mobile二选一(如果收寄双方联系方式都有传则会进行电话黑名单防骚扰校验)</td> </tr> <tr> <td>3</td> <td>mobile</td> <td>String(20)</td> <td>否</td> <td></td> <td></td> </tr> <tr> <td>4</td> <td>province</td> <td>String(30)</td> <td>是</td> <td></td> <td>所在省级行政区名称,必须是标准的省级行政区名称如:北京、广东省、广西壮族自治区等;如无法有效获取此字段,可以仅传“省”,在address中填写包含省市信息的完整地址</td> </tr> <tr> <td>5</td> <td>city</td> <td>String(100)</td> <td>是</td> <td></td> <td>所在地级行政区名称,必须是标准的城市称谓 如:北京市、深圳市、大理白族自治州等;如无法有效获取此字段,可以仅传“市”,在address中填写包含省市信息的完整地址</td> </tr> <tr> <td>6</td> <td>county</td> <td>String(30)</td> <td>否</td> <td></td> <td>所在县/区级行政区名称,必须是标准的县/区称谓,如:福田区,南涧彝族自治县、准格尔旗等。</td> </tr> <tr> <td>7</td> <td>address</td> <td>String(200)</td> <td>是</td> <td></td> <td>详细地址。若province/city传的是“省”/“市”,则此字段必须包含省市信息,避免影响原寄地代码识别,如:广东省深圳市福田区新洲十一街万基商务大厦10楼</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> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String (200)</td> <td style="text-align: center;">否</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;">succ</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/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List (/)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据,可能为空</td> </tr> </tbody> </table> <h4>响应result&lt;List&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: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">serviceDate</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">示例:2021-04-25</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">startTime</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">示例:2021-04-25 08:30:00</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">endTime</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">示例:2021-04-25 21:00:00</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{     &amp;quot;orderId&amp;quot;: &amp;quot;LP00461749454112&amp;quot;,     &amp;quot;contactInfoList&amp;quot;: [{         &amp;quot;address&amp;quot;: &amp;quot;解放一路&amp;quot;,         &amp;quot;city&amp;quot;: &amp;quot;福州市,闽清县&amp;quot;,         &amp;quot;contactType&amp;quot;: 2,         &amp;quot;county&amp;quot;: &amp;quot;福州市,闽清县&amp;quot;,         &amp;quot;mobile&amp;quot;: &amp;quot;13544020940&amp;quot;,         &amp;quot;province&amp;quot;: &amp;quot;福建省&amp;quot;,         &amp;quot;tel&amp;quot;: &amp;quot;13544020940&amp;quot;     }, {         &amp;quot;address&amp;quot;: &amp;quot;解放一路&amp;quot;,         &amp;quot;city&amp;quot;: &amp;quot;上海市&amp;quot;,         &amp;quot;contactType&amp;quot;: 1,         &amp;quot;county&amp;quot;: &amp;quot;闵行区&amp;quot;,         &amp;quot;mobile&amp;quot;: &amp;quot;13544020940&amp;quot;,         &amp;quot;province&amp;quot;: &amp;quot;上海&amp;quot;     }],     &amp;quot;expressTypeId&amp;quot;: 1,     &amp;quot;cargoName&amp;quot;: &amp;quot;手机&amp;quot;,     &amp;quot;monthlyCard&amp;quot;: &amp;quot;123456789&amp;quot;,     &amp;quot;companyId&amp;quot;:&amp;quot;201905140011021&amp;quot; }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{     &amp;quot;result&amp;quot;: [         {             &amp;quot;serviceDate&amp;quot;: &amp;quot;2022-06-23&amp;quot;,             &amp;quot;startTime&amp;quot;: &amp;quot;2022-06-23 06:00:00&amp;quot;,             &amp;quot;endTime&amp;quot;: &amp;quot;2022-06-23 21:30:00&amp;quot;         },         {             &amp;quot;serviceDate&amp;quot;: &amp;quot;2022-06-24&amp;quot;,             &amp;quot;startTime&amp;quot;: &amp;quot;2022-06-24 06:00:00&amp;quot;,             &amp;quot;endTime&amp;quot;: &amp;quot;2022-06-24 21:30:00&amp;quot;         },         {             &amp;quot;serviceDate&amp;quot;: &amp;quot;2022-06-25&amp;quot;,             &amp;quot;startTime&amp;quot;: &amp;quot;2022-06-25 06:00:00&amp;quot;,             &amp;quot;endTime&amp;quot;: &amp;quot;2022-06-25 21:30:00&amp;quot;         }     ],     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,     &amp;quot;msg&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;到件地址不能为空&amp;quot; }</code></pre></li> <li>失败报文-范例2 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;托寄物违禁品不可收寄&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML