h5链接

订单导出接口供客户系统接入并生成H5链接。

版本号	文档	说明
0.1	当前版本文档

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。

目前对该接口的调用限制为每个公司每秒最多3个请求（如需增加可选购增值服务）。

接口说明

公共参数

环境	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

错误码解释

全局反馈代码

反馈代码	说明
0	身份验证失败。

单个请求反馈代码

反馈代码	说明
7001	成功。
7002	失败。
7003	ERP单号和oTMS单号都为空。
7005	oTMS单号不存在。
7006	ERP单号不存在。
7007	用户角色错误。
7008	订单token不存在。

请求参数

Body 参数application/xml

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderLinkRequest version="0.1" login="username" password="password">
    <orders>
        <order sequence="1">
            <erpNumber/>
            <orderNumber>DYZZWDNW004688</orderNumber>
            <userType>Shipper</userType>
        </order>
        <order sequence="2">
            <erpNumber/>
            <orderNumber>DYZZWDNW004688</orderNumber>
            <userType>Consignee</userType>
        </order>
    </orders>
</orderLinkRequest>

返回响应

🟢200成功

application/xml

successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderLinkResponse version="0.1">
    <responseCode>7001</responseCode>
    <successNum>2</successNum>
    <failNum>0</failNum>
    <orders>
        <order sequence="1">
            <status>SUCCEED</status>
            <code>7001</code>
            <orderNumber>dyzzwdnw004688</orderNumber>
            <userType>Shipper</userType>
            <url>https://demo.otms.cn/mp/#/order-preview-mobile/6E595338703E243717E5FB5EB50270A9/KCH2AZPSUOX2CJHMHFFTHBMT?linkTraceId=585980824890EC14</url>
        </order>
        <order sequence="2">
            <status>SUCCEED</status>
            <code>7001</code>
            <orderNumber>dyzzwdnw004688</orderNumber>
            <userType>Consignee</userType>
            <url>https://demo.otms.cn/mp/#/order-preview-mobile/6E595338703E243717E5FB5EB50270A9/Y7FQTQ2WSGOFF7EHV2FHFYIR?linkTraceId=57AA3BCC72FDD5BF</url>
        </order>
    </orders>
</orderLinkResponse>

h5链接

H5链接#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

H5链接

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码