h5链接
订单导出接口供客户系统接入并生成h5链接。
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
|---|---|---|---|---|
| 正式环境 | PUT | https://login.otms.cn/ws/orderLink | application/xml | application/xml |
| 沙箱环境 | PUT | https://demo.otms.cn/ws/orderLink | application/xml | application/xml |
请求参数
| 字段名 | 位置 | 是否必填 | 描述 | Schema |
|---|---|---|---|---|
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string | |
| body | body | 是 | 订单查询请求中包含用以筛选订单的查询条件。 | H5OrderLinkWebService |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | OrderLinkResponse |
H5OrderLinkWebService
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|
OrderLinkResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 否 | 相应版本号 | |
| responseCode | string | 否 | 响应码 | |
| successNum | integer (int32) | 否 | 生成h5链接成功数量 | |
| failNum | integer (int32) | 否 | 生成h5链接失败数量 | |
| responseEntries | array[OrderLinkResponseEntry] | 否 | h5链接列表 |
OrderLinkResponseEntry
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 否 | 序列数，用来匹配与请求中对应的记录 | |
| status | string | 否 | 响应状态: SUCCEED - 成功 FAILED - 失败 |
|
| code | string | 否 | 响应码 | |
| erpNumber | string | 否 | Erp单号 | |
| orderNumber | string | 否 | oTMS单号 | |
| userType | string | 否 | 用户角色 | |
| url | string | 否 | h5链接 |
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderLinkRequest version="0.1" login="username" password="password">
<orders>
<order sequence="1">
<erpNumber/>
<orderNumber>PP001003113</orderNumber>
<userType>Shipper</userType>
</order>
<order sequence="2">
<erpNumber/>
<orderNumber>PP001003113</orderNumber>
<userType>Consignee</userType>
</order>
<order sequence="3">
<erpNumber>ddddddd</erpNumber>
<orderNumber/>
<userType>Shipper</userType>
</order>
<order sequence="4">
<erpNumber>888888</erpNumber>
<orderNumber/>
<userType>Consignee</userType>
</order>
<order sequence="5">
<erpNumber/>
<orderNumber>66666</orderNumber>
<userType>Shipper</userType>
</order>
<order sequence="6">
<erpNumber/>
<orderNumber>PP001003113</orderNumber>
<userType>ddddd</userType>
</order>
</orders>
</orderLinkRequest>
响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderLinkResponse version="0.1">
<responseCode>7002</responseCode>
<successNum>2</successNum>
<failNum>4</failNum>
<orders>
<order sequence="1">
<status>SUCCEED</status>
<code>7001</code>
<orderNumber>PP001003113</orderNumber>
<userType>Shipper</userType>
<url>http://localhost:8080/mp/#/order-preview-mobile/38B917BEC4173CC7EC7CA8C669E6F154/OWWV26AXVEANN2JWHNMS2XJX?linkTraceId=A36583C7DDC6AD0D</url>
</order>
<order sequence="2">
<status>SUCCEED</status>
<code>7001</code>
<orderNumber>PP001003113</orderNumber>
<userType>Consignee</userType>
<url>http://localhost:8080/mp/#/order-preview-mobile/38B917BEC4173CC7EC7CA8C669E6F154/NDZ765IUCFMLIL2E7INZIBYW?linkTraceId=C5BB2E3A8FED7E92</url>
</order>
<order sequence="3">
<status>FAILED</status>
<code>7006</code>
</order>
<order sequence="4">
<status>FAILED</status>
<code>7006</code>
</order>
<order sequence="5">
<status>FAILED</status>
<code>7005</code>
</order>
<order sequence="6">
<status>FAILED</status>
<code>7007</code>
</order>
</orders>
</orderLinkResponse>
全局反馈代码
| 反馈代码 | 说明 |
| 0 | 身份验证失败。 |
单个请求反馈代码
| 反馈代码 | 说明 |
| 7001 | 成功。 |
| 7002 | 失败。 |
| 7003 | Erp 单号和oTMS单号都为空。 |
| 7005 | oTMS单号不存在。 |
| 7006 | Erp 单号不存在。 |
| 7007 | 用户角色错误。 |
| 7008 | 订单token不存在。 |