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


扫码上传接口

<p><strong>简要描述:</strong></p> <ul> <li>扫码上传接口</li> </ul> <p><strong>请求URL:</strong></p> <ul> <li>/openapi/express/upload</li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST</li> </ul> <p><strong>参数:</strong></p> <table> <thead> <tr> <th>参数名</th> <th>必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>userId</td> <td>是</td> <td>String</td> <td>派件人/操作人id,用户列表接口返回的用户ID</td> </tr> <tr> <td>userName</td> <td>是</td> <td>String</td> <td>用户名称,用户列表接口返回的用户名</td> </tr> <tr> <td>type</td> <td>是</td> <td>String</td> <td>扫码类型(DS: 到件, PJ:派件 DP:到派合一 ZY:转邮 DZ:到转合一)</td> </tr> <tr> <td>deviceId</td> <td>是</td> <td>String</td> <td>设备号,可以随便填写</td> </tr> <tr> <td>list</td> <td>是</td> <td>ItemDto[]</td> <td>扫码列表</td> </tr> <tr> <td>containerNo</td> <td>否</td> <td>String</td> <td>车签号</td> </tr> </tbody> </table> <p><strong>ItemDto</strong></p> <table> <thead> <tr> <th>参数名</th> <th>必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>sheetNo</td> <td>是</td> <td>String</td> <td>运单号</td> </tr> <tr> <td>company</td> <td>是</td> <td>String</td> <td>快递公司编码 [YTO, ZTO, STO, YUNDA, HTKY, TTKDEX, JT, EMS]</td> </tr> <tr> <td>containerNo</td> <td>否</td> <td>String</td> <td>车签号,此处优先级高于上层车签号</td> </tr> <tr> <td>createDate</td> <td>是</td> <td>String</td> <td>扫描时间 格式:2021-01-13 15:00:00</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{ list: [ { sheetNo: '567675687678', company: 'JT', createDate: '2021-01-13 12:00:00' }, { sheetNo: '938674645564', company: 'YTO', createDate: '2021-01-13 15:00:00' } ], deviceId: '54354365465', type: 'DS', containerNo: '1234567890', userId: '1', userName: '测试' }</code></pre> <p><strong>正常返回示例</strong></p> <pre><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;data&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot; }</code></pre> <p><strong>错误返回示例</strong></p> <pre><code> { &amp;quot;code&amp;quot;: 1005, &amp;quot;message&amp;quot;: &amp;quot;处理失败&amp;quot; }</code></pre> <p>正式环境测试<br /> <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/6ff5cfd5788241d10ef984c1a49cd664" alt="" /><br /> <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/a562aaef0d83afe47d5d083596cd07a6" alt="" /><br /> <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/1fa9b0225749f962b5d9b792a3a6f0e2" alt="" /></p> <p><strong>备注</strong></p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML