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/orderOutbound

订单导出/追踪#

通过订单导出/追踪接口，客户系统接入 oTMS 系统，查询 oTMS 订单信息和状态。
注意：如果订单已结账超过3个月或者已经删除的订单，该接口将无法查询到该订单。
版本号文档说明
0.1当前版本文档
0.2查看0.2版本文档

配置说明#

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

接口说明#

公共参数#

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

请求参数#

字段名位置是否必填描述Schema
bodybody是订单查询请求JAXBElementOrderOutboundRequest
bodybody是订单查询请求。包含用以筛选订单的查询条件OrderOutboundRequest

请求参数

Header 参数

Body 参数application/xml

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundRequest version="0.2" login="username" password="password">
    <queries>
        <query>
            <attribute>orderStatus</attribute>
            <eq>delivered</eq>
        </query>
        <query>
            <attribute>pickupSla</attribute>
            <ge>2025-1-1</ge>
            <le>2025-3-31</le>
        </query>
    </queries>
    <includeOrderInfo>true</includeOrderInfo>
    <includeOrderPosition>true</includeOrderPosition>
    <includeLocationHistory>true</includeLocationHistory>
    <includePortableDevice>true</includePortableDevice>
    <includeLocationEvent>true</includeLocationEvent>
    <includeRejection>true</includeRejection>
    <includeDiscrepancny>true</includeDiscrepancny>
    <includeTruckAndDriver>true</includeTruckAndDriver>
    <includeMilestoneEvent>true</includeMilestoneEvent>
    <includeExceptionEvent>true</includeExceptionEvent>
    <includeCompensation>true</includeCompensation>
    <includePickupDeliveryPoint>true</includePickupDeliveryPoint>
    <includeClient>true</includeClient>
    <includeVendor>true</includeVendor>
    <includeOrderLine>true</includeOrderLine>
    <includeSpecialChargesInfo>true</includeSpecialChargesInfo>
    <includeEpodFiles>true</includeEpodFiles>
    <includeOrderBasicInfo>true</includeOrderBasicInfo>
    <includeOrderDelayReason>true</includeOrderDelayReason>
    <includeOrderLineRemark>true</includeOrderLineRemark>
    <includeDiscrepancnyFiles>true</includeDiscrepancnyFiles>
    <includeTransportMode>true</includeTransportMode>
    <includeTransportExtension>true</includeTransportExtension>
    <orderBy>
        <desc>pickupSla</desc>
    </orderBy>
    <start>1</start>
    <count>10</count>
</orderOutboundRequest>

返回响应

🟢200成功
application/xml
successful operation
Body

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundResponse>
    <orders>
        <order>
            <vendorDetail>
                <partnerCode>WWUTAUAV</partnerCode>
                <partnerName>StandardSROtmsCompany</partnerName>
                <partnerHeadOfficeCode>StandardSPOtmsCompany</partnerHeadOfficeCode>
                <orderNumber>WWUTAUAV967437</orderNumber>
                <erpNumber>250708001</erpNumber>
                <price>0.00</price>
                <priceDetails/>
                <consolidationId></consolidationId>
                <rateAdjustments/>
                <billAccepted>false</billAccepted>
                <vat>0.0</vat>
            </vendorDetail>
            <orderInfo>
                <shipFrom>
                    <name>合肥</name>
                    <province>安徽省</province>
                    <town>合肥市</town>
                    <address>安徽省合肥市</address>
                    <customFields/>
                    <contactName>合肥</contactName>
                    <contactMobile>13100002221</contactMobile>
                    <longitude>117.23344266497664</longitude>
                    <latitude>31.826577833686887</latitude>
                    <loading>false</loading>
                    <supportXtt>false</supportXtt>
                </shipFrom>
                <shipTo>
                    <name>洛阳</name>
                    <province>河南省</province>
                    <town>洛阳市</town>
                    <address>河南省洛阳市</address>
                    <customFields/>
                    <contactName>洛阳</contactName>
                    <contactMobile>13112345678</contactMobile>
                    <longitude>112.4594212983115</longitude>
                    <latitude>34.62426277921943</latitude>
                    <loading>true</loading>
                    <supportXtt>false</supportXtt>
                    <deliveryCode>false</deliveryCode>
                    <sendEpodSms>false</sendEpodSms>
                    <orderEpodUploadType>PAPERY_POD</orderEpodUploadType>
                    <ignoreDeliveryCode>false</ignoreDeliveryCode>
                </shipTo>
                <totalWeight>1869.000</totalWeight>
                <totalVolume>2.919000000</totalVolume>
                <totalQuantity>178</totalQuantity>
                <totalInsurance>0.00</totalInsurance>
                <orderLines>
                    <orderLine>
                        <productCode>Y-1112B00-YT04-CN00</productCode>
                        <productName>DASHI BLUE LS IDY/大师(蓝) 低糖型高活性干酵母 - 5KGX2 - CN - 00</productName>
                        <quantity>70</quantity>
                        <volume>1.148000000</volume>
                        <weight>735.000</weight>
                        <unitType>2</unitType>
                        <customFields>
                            <customText6>2024-12-31</customText6>
                            <customText7>SD4221Q</customText7>
                            <customText14>700.00</customText14>
                            <customText15>Y11-0126</customText15>
                        </customFields>
                    </orderLine>
                    <orderLine>
                        <productCode>Y-1112B00-YT04-CN00</productCode>
                        <productName>DASHI BLUE LS IDY/大师(蓝) 低糖型高活性干酵母 - 5KGX2 - CN - 00</productName>
                        <quantity>108</quantity>
                        <volume>1.771000000</volume>
                        <weight>1134.000</weight>
                        <unitType>2</unitType>
                        <customFields>
                            <customText6>2025-01-01</customText6>
                            <customText7>SD4221Q</customText7>
                            <customText14>1080.00</customText14>
                            <customText15>Y11-0126</customText15>
                        </customFields>
                    </orderLine>
                </orderLines>
                <customFields/>
                <dockAppointment>
                    <expectedArrivalTime>2025-07-10T09:31:53.000</expectedArrivalTime>
                    <driverName>ABCD1 liang</driverName>
                    <truckPlate>浙A67890 鄂F77788</truckPlate>
                    <driverMobile>13912345678 18012345678</driverMobile>
                </dockAppointment>
                <positions/>
                <transportType>LTL</transportType>
                <cargoType>1</cargoType>
                <locationHistories/>
                <transportMode>
                    <transportType>LTL</transportType>
                    <truckType>2</truckType>
                </transportMode>
            </orderInfo>
            <pickupSla>2025-07-05T23:59:59.000</pickupSla>
            <deliverySla>2025-07-10T09:31:53.000</deliverySla>
            <orderStatus>delivered</orderStatus>
            <pickupDelayReason>SR提送货</pickupDelayReason>
            <orderEvents>
                <event>
                    <name>new</name>
                    <time>2025-07-08T09:29:39.000</time>
                    <operationTime>2025-07-08T09:29:39.000</operationTime>
                    <updateSource>SHIPPER</updateSource>
                </event>
                <event>
                    <name>released</name>
                    <time>2025-07-08T09:31:17.000</time>
                    <operationTime>2025-07-08T09:31:17.000</operationTime>
                    <updateSource>ME</updateSource>
                </event>
                <event>
                    <name>dispatched</name>
                    <time>2025-07-08T09:31:17.000</time>
                    <operationTime>2025-07-08T09:31:17.000</operationTime>
                    <updateSource>ME</updateSource>
                </event>
                <event>
                    <name>picked</name>
                    <time>2025-07-08T09:31:53.000</time>
                    <operationTime>2025-07-08T09:32:00.000</operationTime>
                    <updateSource>UNKNOWN</updateSource>
                </event>
                <event>
                    <time>2025-07-08T09:32:00.000</time>
                    <operationTime>2025-07-08T09:32:06.000</operationTime>
                    <remark>浙A67890到达钦州港</remark>
                </event>
                <event>
                    <time>2025-07-08T09:32:40.000</time>
                    <operationTime>2025-07-08T09:32:46.000</operationTime>
                    <remark>沪B7L012离开钦州港</remark>
                </event>
                <event>
                    <time>2025-07-08T09:32:47.000</time>
                    <operationTime>2025-07-08T09:32:53.000</operationTime>
                    <remark>沪B7L012到达上海中转</remark>
                </event>
                <event>
                    <time>2025-07-08T09:33:07.000</time>
                    <operationTime>2025-07-08T09:33:13.000</operationTime>
                    <remark>鄂F77788离开上海中转</remark>
                </event>
                <event>
                    <name>delivered</name>
                    <time>2025-07-08T09:33:13.000</time>
                    <operationTime>2025-07-08T09:33:19.000</operationTime>
                    <updateSource>UNKNOWN</updateSource>
                </event>
            </orderEvents>
            <assignedDrivers>
                <pickup>
                    <assignedDriver>
                        <driverName>ABCD1</driverName>
                        <realName>AAA</realName>
                        <mobile>13913456780</mobile>
                        <idCard>310202601021110</idCard>
                        <truckPlate>浙A67890</truckPlate>
                    </assignedDriver>
                </pickup>
                <delivery>
                    <assignedDriver>
                        <driverName>liang</driverName>
                        <realName>AAA</realName>
                        <mobile>13913456780</mobile>
                        <idCard>310202601021110</idCard>
                        <truckPlate>鄂F77788</truckPlate>
                    </assignedDriver>
                </delivery>
            </assignedDrivers>
        </order>
    </orders>
    <start>1</start>
    <count>1</count>
    <total>1</total>
</orderOutboundResponse>
上一页
订单导入
下一页
提送货点导入
Built with