运输单导入

通过运输单导入接口，可以将不同外部系统（如ERP系统、WMS系统）的大量运输单进行批量导入到oTMS系统。

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

配置说明

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

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

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

接口说明

公共参数

环境	HTTP请求方法	HTTPS请求地址	请求主体MIME类型	响应主体MIME类型
正式环境	PUT	`https://login.otms.cn/ws/jobSheetImport`	application/xml	application/xml
沙箱环境	PUT	`https://demo.otms.cn/ws/jobSheetImport`	application/xml	application/xml

请求参数

字段名	位置	是否必填	描述	Schema
body	body	是	运输单导入请求	JobSheetImportRequest
Authorization	header	否	Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码	string

错误码解释

全局反馈代码

反馈代码	说明
0	客户验证失败 / 没有运输单权限。
1	不支持的请求版本。
2	请求中的导入运输单数量超过限制。

单个请求反馈代码

反馈代码	说明
1001	请求参数不合法。
1035	运输单和订单的地区不匹配。
1040	参数 (branch) 对应的地区错误。
1093	参数 (cost) 不合法。
1102	导入运输单为空。
1103	导入运输单中订单列表为空。
1104	参数 (packageType) 不合法。
1105	参数 (cargoType) 不合法。
1106	订单状态不合法（要求：已释放）。
1107	订单已存在运输单中。
1108	运输单导入失败。
1109	订单没有找到。
1110	车长不合法。
1111	订单总重量超过卡车容量。
1112	订单总体积超过卡车容量。
1113	订单参数 (clientCode) 为空。
1114	参数 (externalShipmentID) 重复，不能导入。
1121	改变订单状态失败。
1122	承运商没有找到。
1125	运输单自动分配失败。
1126	没有运输单自动分配权限。
1100	未知错误。

请求参数

Body 参数application/xml

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetImportRequest version="0.1" login="login" password="password">
    <jobSheets>
        <importedJobSheet sequence="1122">
            <externalShipmentID></externalShipmentID>
            <branch></branch>
            <applyTariffType>ORIGIN_DESTINATION</applyTariffType>
            <cargoDetails>
                <cargoType>1</cargoType>
                <packageType>A</packageType>
            </cargoDetails>
            <transportMode>
                <transportType>LTL</transportType>
                <truckType>2</truckType>
                <truckLength></truckLength>
                <truckCbmCapacity></truckCbmCapacity>
                <truckMtCapacity></truckMtCapacity>
            </transportMode>
            <autoDispatch></autoDispatch>
            <vendorCode></vendorCode>
            <cost></cost>
            <jobSheetOrders>
                <jobSheetOrder>
                    <clientCode>DYZZWDNW</clientCode>
                    <orderNumber/>
                    <erpNumber>250321001</erpNumber>
                    <sequence>1</sequence>
                </jobSheetOrder>
                <jobSheetOrder>
                    <clientCode></clientCode>
                    <orderNumber>DYZZWDNW004683</orderNumber>
                    <erpNumber/>
                    <sequence>2</sequence>
                </jobSheetOrder>
            </jobSheetOrders>
        </importedJobSheet>
    </jobSheets>
</jobSheetImportRequest>

返回响应

🟢200成功

application/xml

successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetImportResponse version="0.1">
    <responseCode>200</responseCode>
    <jobSheets>
        <jobSheet sequence="1122">
            <externalShipmentID></externalShipmentID>
            <importStatus>IMPORTED</importStatus>
            <jobSheetOrdersResponse>
                <jobSheetOrders>
                    <erpNumber>250321001</erpNumber>
                    <responseCodes>
                        <responseCode>
                            <code>200</code>
                        </responseCode>
                    </responseCodes>
                </jobSheetOrders>
                <jobSheetOrders>
                    <orderNumber>DYZZWDNW004683</orderNumber>
                    <responseCodes>
                        <responseCode>
                            <code>200</code>
                        </responseCode>
                    </responseCodes>
                </jobSheetOrders>
            </jobSheetOrdersResponse>
            <responseCodes>
                <responseCode>
                    <code>200</code>
                </responseCode>
            </responseCodes>
        </jobSheet>
    </jobSheets>
</jobSheetImportResponse>

运输单导入

运输单导入#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

运输单导入

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码