自动化设备到派-http接口文档


拦截件接口

<h5>简要描述</h5> <ul> <li>拦截件接口</li> </ul> <h5>请求URL</h5> <ul> <li><code>/openapi/express/check</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sheetNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>运单号</td> </tr> <tr> <td style="text-align: left;">company</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>快递公司编码 [YTO, ZTO, STO, YUNDA, HTKY, TTKDEX, JT, EMS]</td> </tr> <tr> <td style="text-align: left;">userId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>派件用户ID</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>固定值&quot;PJ&quot;</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>{ &amp;quot;company&amp;quot;: &amp;quot;ZTO&amp;quot;, &amp;quot;sheetNo&amp;quot;: &amp;quot;75706890164395&amp;quot;, &amp;quot;userId&amp;quot;: &amp;quot;1755099536575205376&amp;quot;, &amp;quot;type&amp;quot;: &amp;quot;PJ&amp;quot; }</code></pre> <h5>正常返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;data&amp;quot;: { &amp;quot;company&amp;quot;: &amp;quot;ZTO&amp;quot;, &amp;quot;isIntercept&amp;quot;: true, &amp;quot;isDf&amp;quot;: false, &amp;quot;isCod&amp;quot;: false, &amp;quot;isFresh&amp;quot;: false, &amp;quot;isVip&amp;quot;: false, &amp;quot;isPrivate&amp;quot;: false, &amp;quot;msg&amp;quot;: &amp;quot;运单75706890164395是【拦截改地址】快件,请尽快打单转出&amp;quot; }, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot;, &amp;quot;success&amp;quot;: true, &amp;quot;isEncrypt&amp;quot;: false }</code></pre> <h5>错误返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 400, &amp;quot;message&amp;quot;: &amp;quot;签名错误&amp;quot;, &amp;quot;success&amp;quot;: false }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">isIntercept</td> <td style="text-align: left;">boolean</td> <td>是否拦截件</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>拦截件信息描述</td> </tr> <tr> <td style="text-align: left;">isDf</td> <td style="text-align: left;">boolean</td> <td>是否到付类型拦截件</td> </tr> <tr> <td style="text-align: left;">isCod</td> <td style="text-align: left;">boolean</td> <td>是否货到付款类型拦截件</td> </tr> <tr> <td style="text-align: left;">isFresh</td> <td style="text-align: left;">boolean</td> <td>是否生鲜类型拦截件</td> </tr> <tr> <td style="text-align: left;">isVip</td> <td style="text-align: left;">boolean</td> <td>是否电联类型拦截件</td> </tr> <tr> <td style="text-align: left;">isPrivate</td> <td style="text-align: left;">boolean</td> <td>是否隐私类型拦截件</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML