oTMS-openapi
  1. oTMS API
oTMS-openapi
  • oTMS API
    • 订单导入
      PUT
    • 订单导出/追踪
      POST
    • 提送货点导入
      PUT
    • 提送货点删除
      DELETE
    • 卡车和司机导入
      PUT
    • 订单分配司机
      POST
    • 运输单导入
      PUT
    • 运输单删除
      PUT
    • 订单外部追踪
      POST
    • 订单召回
      POST
    • 订单分享链接
      PUT
    • 承运商导出
      POST
    • h5链接
      PUT
    • 订单更新
      PUT
    • 订单费用更新
      POST
    • 订单分配
      POST
    • 车辆信息
      POST
    • 订单撤销
      PUT
    • 运输单分配司机
      PUT
    • 订单评分
      POST
    • 订单交接创建
      PUT
    • 订单自定义文本字段更新
      POST
    • 订单快速交接
      POST
    • 价格文件匹配
      POST
    • 收货方/发货方导出
      POST
    • 运输单导出/追踪
      POST
    • 运输单召回
      PUT
    • 文件上传
      POST
    • 订单事件推送
      PUT
    • 运输单事件推送
      PUT
    • 拒收导出
      POST
    • 收货码查询
      POST
    • 便携式设备导入
      POST
  1. oTMS API

订单交接创建

PUT
https://login.otms.cn/ws/handoverCreate

订单交接创建#

通过订单交接创建接口,可以将外部系统如ERP系统、WMS系统的批量订单打包为一个交接订单,作为一个整体方便后续提送货操作。
版本号文档说明
0.1当前版本文档

配置说明#

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多3个请求(如需增加可选购增值服务)

接口说明#

公共参数#

环境HTTP请求方法HTTPS请求地址请求主体MIME类型响应主体MIME类型
正式环境PUThttps://login.otms.cn/ws/handoverCreateapplication/xmlapplication/xml
沙箱环境PUThttps://demo.otms.cn/ws/handoverCreateapplication/xmlapplication/xml

请求参数#

字段名位置是否必填描述Schema
bodybody是订单交接创建请求HandoverCreateRequest
Authorizationheader否Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码string

错误码解释#

全局反馈代码#

反馈代码说明
0身份验证失败。
1版本不正确。
2请求内容超出最大限制。
3错误的请求。

单个请求反馈代码#

反馈代码说明
999创建批量订单交接码失败。
1000未找到client code所对应的公司。
1109未找到对应的订单。
1127拆分的订单不支持创建交接码。
1128一单多车的订单不支持创建交接码。
1129订单的当前节点不支持创建交接码。
1112匹配到多个订单。
1113请求中缺少client code。
1134订单交接功能未启用。
1100其他错误。

请求参数

Body 参数application/xml

示例
<?xml version="1.0" encoding="utf-8"?>
<handoverCreateRequest login="username" version="0.1" password="password">
<handoverOrders>
  <order sequence="1">
    <orderNumber>DYZZWDNW004661</orderNumber>
  </order>
  <order sequence="2">
    <erpNumber>250321005</erpNumber>
    <clientCode>AXDHBMAV</clientCode>
  </order> 
</handoverOrders>
</handoverCreateRequest>

返回响应

🟢200成功
application/xml
successful operation
Body

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<handoverCreateResponse version="0.1">
    <responseCode>200</responseCode>
    <handoverCode>WOURGBUZ533WC2UUZEIRBPN5</handoverCode>
    <orders>
        <order sequence="1">
            <orderNumber>DYZZWDNW004661</orderNumber>
            <status>SUCCEED</status>
            <responseCodes/>
        </order>
        <order sequence="2">
            <erpNumber>250321005</erpNumber>
            <orderNumber>DYZZWDNW004662</orderNumber>
            <status>SUCCEED</status>
            <responseCodes/>
        </order>
    </orders>
</handoverCreateResponse>
上一页
订单评分
下一页
订单自定义文本字段更新
Built with