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

订单自定义文本字段更新

POST
https://login.otms.cn/ws/orderCustomUpdate

订单自定义文本字段更新#

通过订单自定义文本字段更新接口,可以将不同外部系统如ERP系统、WMS系统的大量订单进行批量的自定义文本字段更新。
版本号文档说明
0.1当前版本文档

配置说明#

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

接口说明#

公共参数#

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

请求参数#

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

错误码解释#

全局反馈代码#

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

单个请求反馈代码#

反馈代码说明
7000客户代码未找到。
7001无效的数据类型。
7003订单匹配结果不唯一。
7004用户地区权限不匹配。
7006订单不属于该公司。
7008已入账单的订单不允许更新。
7009订单不存在。
7043自定义字段不能识别——可能公司已经取消了自定义字段。订单不能更新。
7044未定义的自定义字段枚举值。订单不能更新。
7045未启用自定义字段,将忽略更新订单中的自定义字段。
7046订单缺少必填的自定义字段。订单不能更新。
7051承运商账户通过erpNumber更新订单时必须提供clientCode。
7054订单优化进行中,更新被拒绝。
7100其他错误。

请求参数

Body 参数application/xml

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderCustomUpdateRequest version="0.1" login="username" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>250321005</erpNumber>
            <customFields>
                <customText1>2</customText1>
                <customText2>2</customText2>
                <customText3>3</customText3>
                <customText4>4</customText4>
                <customText5>5</customText5>
                <customText6>6</customText6>
                <customText7>7</customText7>
                <customText8>8</customText8>
                <customText9>9</customText9>
                <customText10>10</customText10>
                <customText11>11</customText11>
                <customText12>12</customText12>
                <customText13>13</customText13>
                <customText14>14</customText14>
                <customText15>15</customText15>
                <customText16>16</customText16>
                <customText17>17</customText17>
                <customText18>18</customText18>
                <customText19>19</customText19>
                <customText20>20</customText20>
                <customText21>21</customText21>
                <customText22>22</customText22>
                <customText23>23</customText23>
                <customText24>24</customText24>
                <customText25>25</customText25>
                <customText26>26</customText26>
                <customText27>27</customText27>
                <customText28>28</customText28>
                <customText29>29</customText29>
                <customText30>36</customText30>
            </customFields>
        </order>
    </orders>
</orderCustomUpdateRequest>

返回响应

🟢200成功
application/xml
successful operation
Body

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderUpdateResponse version="0.1">
    <responseCode></responseCode>
    <processedOrders>1</processedOrders>
    <orders>
        <order sequence="1">
            <erpNumber>250321005</erpNumber>
            <orderNumber>DYZZWDNW004662</orderNumber>
            <updateStatus>UPDATED</updateStatus>
            <responseCodes/>
            <errorColumnName></errorColumnName>
        </order>
    </orders>
</orderUpdateResponse>
上一页
订单交接创建
下一页
订单快速交接
Built with