订单导入

通过订单导入接口，可以将不同外部系统如ERP系统、WMS系统的大量订单进行批量的导入。单次导入最大订单数为100。

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

字段名	位置	是否必填	描述	Schema
body	body	是	订单导入请求	OrderImportRequest

错误码解释

全局反馈代码

反馈代码	说明
0	客户验证失败
1	不支持的请求版本
2	请求中的导入订单过多

单个请求反馈代码

反馈代码	说明
1000	客户代码未找到。
1001	无效的数据类型。
1002	备用。
1003	shipFromExternalId 发货方外部代码未找到。
1004	shipToExternalId 收货方外部代码未找到。
1005	singleLine/externalId 产品明细/货物(产品)外部代码未找到。
1006	缺少 transportType 运输方式。
1007	truckType 车辆类型匹配结果不唯一。
1008	truckType 车辆类型不匹配。
1009	发货方外部代码重复。
1010	收货方外部代码重复。
1011	货物(产品)外部代码重复。
1012	订单未设置价格（仅针对承运商）。
1013	发货方oTMS邮政编码匹配到乡镇。
1014	发货方oTMS邮政编码只与6位邮政编码匹配。
1015	发货方oTMS邮政编码不匹配。
1016	发货方oTMS邮政编码与6位和乡镇的都匹配。
1017	收货方oTMS邮政编码只与乡镇匹配。
1018	收货方邮政编码只与6位邮政编码匹配。
1019	收货方oTMS邮政编码不匹配。
1020	收货方oTMS邮政编码与6位和乡镇匹配。
1021	缺少货物/产品信息。订单明细中至少需提供 externalId 或 cargoDescription 之一。
1022	ERP单号重复。订单不能导入。
1023	试图更新的订单不是由导入接口导入。更新被拒绝。
1024	试图更新的订单不在收件箱或草稿箱中。更新被拒绝。
1025	没有匹配的价格文件。
1026	匹配了多个价格文件。
1027	订单信息不全无法自动分配。
1028	未提供司机和卡车的信息。
1029	匹配到的卡车不唯一。
1030	自定义字段不能识别——可能公司已经取消了自定义字段。订单不能导入。
1031	未启用自定义字段，将忽略导入订单中的自定义字段。
1032	订单缺少必填的自定义字段。订单不能导入。
1033	未定义的自定义字段枚举值。订单不能导入。
1034	订单明细缺少必填的自定义字段。订单不能导入。
1035	用户地区和试图更新的订单地区不匹配。更新被拒绝。
1036	货物/产品明细列表中有货物/产品的产品类别无效。订单不能导入。
1037	试图更新的订单的货物/产品明细列表中有货物/产品的产品类别不可更新。更新被拒绝。
1038	订单的运输时间和价格文件的运输时间不匹配。
1040	地区不存在。
1041	未提供发货方。
1042	未提供收货方。
1043	分公司未识别，或用户权限不匹配。
1044	拒绝草稿状态订单。rejectDraft为true时，不完整订单将被拒绝而非进入草稿箱。
1049	订单信息不完整，订单信息或货物/产品明细信息无效。
1052	发货方oTMS邮政编码只与乡镇匹配。
1053	收货方oTMS邮政编码只与乡镇匹配。
1070	承运商的状态异常。
1072	试图更新的订单已有货差。更新被拒绝。
1073	试图更新的订单已在账单中。更新被拒绝。
1080	无法匹配到卡车。
1081	匹配到的卡车与订单不匹配。
1082	无法匹配到司机。
1083	匹配到的司机不唯一。
1084	匹配到的卡车已在途，且绑定的司机不匹配。
1085	匹配到的司机已在途，且绑定的卡车不匹配。
1086	试图更新的订单被锁定。更新被拒绝。
1090	试图更新的订单只能被订单所属公司更新。更新被拒绝。
1091	试图更新的订单货物信息有无效信息。更新被拒绝。
1092	承运商代码未找到
1093	运输成本数据无效
1094	货物类型和温度报警阀值不匹配。
1095	温度报警阀值无效。
1096	温控箱编号无效。
1097	包装类型和温控箱编号不匹配。
1098	订单已被按量拆分，无法更新数量、重量、体积和保费
1100	其他错误。
1116	订单导入时，订单总重或总体积不在配置的总重或总体积的正常范围内。
1117	订单更新时，被更新订单的总重或总体积不在配置的总重或总体积的正常范围内。
1118	发货方如果email里需要追踪信息的连接，Email 或者手机号是必填。订单不能导入。
1119	收货方如果email里需要追踪信息的连接，Email 或者手机号是必填。订单不能导入。
1120	收货点和发货点不能重复。
1141	订单行总重量超过订单总重量。
1142	订单行总体积超过订单总体积。
1143	订单行总数量超过订单总数量。
1146	订单行总保费超过订单总保费。
1150	缺少 packageType 包装类型。
1151	缺少 cargoType 货物类型。
1152	时间窗信息不完整，请检查提送货时间。
1160	发货方信息不完整。
1170	收货方信息不完整。
1181	缺少 truckType 车辆类型。
1182	缺少 truckLength 正确车长。
1183	缺少 productName 产品名称。
1200	地区 branch 长度超长。
1201	ErpNumber 长度超长。
1202	地区名称 companyName 超长。
1203	邮政编码 postcode 不规范。
1204	地址 address 超长。
1205	联系方式不规范。
1206	自定义文本超长。
1207	自定义数字超出范围。
1208	自定义枚举超长。
1209	预计提货日期与当前时间相差超过365天。
1210	预计送达日期与当前时间相差超过365天。
1211	货物/产品的代码 productCode 超长。
2000	订单正在被更新。

application/xml

Successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderImportResponse version="0.1">
    <responseCode></responseCode>
    <processedOrders>1</processedOrders>
    <orders>
        <order sequence="1">
            <clientReferenceNumber></clientReferenceNumber>
            <importStatus>RELEASED</importStatus>
            <responseCodes>
                <responseCode>
                    <code>1017</code>
                </responseCode>
                <responseCode>
                    <code>1013</code>
                </responseCode>
                <responseCode>
                    <code>1031</code>
                </responseCode>
            </responseCodes>
            <orderNumber>YBLHQYHD017620</orderNumber>
        </order>
    </orders>
</orderImportResponse>

订单导入

订单导入#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

订单导入

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码