oTMS-openapi en
  1. oTMS API
oTMS-openapi en
  • oTMS API
    • Order Import
      PUT
    • orderOutbound
      POST
    • shipPointImport
      PUT
    • Delete delivery point
      DELETE
    • Order Assignment to Driver
      POST
    • TruckAndDriverImport
      PUT
    • Assign Driver to Order
      POST
    • Job Sheet Import
      PUT
    • Delete Job Sheet
      PUT
    • Order Recall
      POST
    • Share Link
      PUT
    • Carrier Export
      POST
    • Order Update
      PUT
    • Order Dispatch
      POST
    • Order Revoke
      PUT
    • Order Rating
      POST
    • Order Handover Creation
      PUT
    • Oorder Custom Update
      POST
    • Price File Matching
      POST
    • Order cost update
      POST
    • Shipper/Receiver export
      POST
    • Job Sheet Outbound
      POST
    • Job Sheet Recall
      PUT
    • TruckPosition
      POST
    • GPS Device
      POST
    • Jobsheet To Driver
      PUT
    • TrackandTrace
      POST
    • H5 Link
      PUT
  1. oTMS API

orderOutbound

POST
/ws/orderOutbound

Configuration Instructions#

oTMS provides Web Service interfaces in both production and testing environments, where the testing environment is primarily used for integration testing. In both environments, API account credentials must be assigned by the oTMS system administrator before they can be used.

Important Notes#

Please use the public interfaces reasonably. If abnormal calls or any issues affecting system performance are detected, we will impose restrictions on the API account calls, or even deactivate them.

Call Limitations#

Currently, the call limit for this interface is set to a maximum of 20 requests per second per company.

Request

Header Params
Authorization
string 
optional
Basic Authorization. If not empty, it will prioritize using this value for identity authentication. Otherwise, use the username and password in the request message.
Default:
Body Params application/xml
name
object (QName) 
optional
namespaceURI
string 
optional
localPart
string 
optional
prefix
string 
optional
value
object (OrderOutboundRequest) 
optional
version
string 
optional
Version number of the request
login
string 
optional
Username. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
password
string 
optional
Password. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
includeOrderInfo
boolean 
optional
Default:
false
includeOrderPosition
boolean 
optional
Default:
false
existDiscrepancy
boolean 
optional
Default:
false
queries
object (Queries) 
optional
orderBy
object (OrderBy) 
optional
start
integer <int32>
optional
Starting index of returned orders, minimum is 1. Default value is 1.
count
integer <int32>
optional
Maximum number of orders to return. The default value is 100.
includeLocationHistory
boolean 
optional
Whether the returned values include historical location reports of the vehicle. The default value is false.
Default:
false
includePortableDevice
boolean 
optional
Whether the returned values include bound portable devices. The default value is false.
Default:
false
includeLocationEvent
boolean 
optional
Whether the returned values include location event reports of the order. The default value is false.
Default:
false
includeRejection
boolean 
optional
Whether the returned values include cargo rejection information. The default value is false.
Default:
false
includeDiscrepancy
boolean 
optional
Whether the returned values include cargo damage information. The default value is false.
Default:
false
includeTruckAndDriver
boolean 
optional
Whether the returned values include vehicle and driver information. The default value is false.
Default:
false
includeMilestoneEvent
boolean 
optional
Whether the returned values include major events of the order. The default value is false.
Default:
false
includeExceptionEvent
boolean 
optional
Whether the returned values include exception events of the order. The default value is false.
Default:
false
includeCompensation
boolean 
optional
Whether the returned values include compensation information of the order. The default value is false.
Default:
false
includePickupDeliveryPoint
boolean 
optional
Whether the returned values include pickup and delivery points. The default value is false.
Default:
false
includeClient
boolean 
optional
Whether the returned values include customer information of the order. The default value is false.
Default:
false
includeVendor
boolean 
optional
Whether the returned values include carrier information of the order. The default value is false.
Default:
false
includeOrderLine
boolean 
optional
Whether the returned values include order lines. The default value is false.
Default:
false
pointsIntervalSecond
integer <int64>
optional
Minimum time interval (seconds) between points in the historical trajectory. The default value is 600.
includeOrderBasicInfo
boolean 
optional
Whether the returned values include bound portable devices. The default value is false.
Default:
false
includeOrderDelayReason
boolean 
optional
Whether the delay reasons of the order should be included in the response. The default value is false.
Default:
false
includeOrderLineRemark
boolean 
optional
Whether the returned values include remarks on order lines. The default value is false.
Default:
false
includeDiscrepancyFiles
boolean 
optional
Whether the returned values include images of cargo damage. The default value is false.
Default:
false
includeEpodFiles
boolean 
optional
Whether the returned values include images of return documents. The default value is false.
Default:
false
includeTransportMode
boolean 
optional
Whether the returned values include freight information. The default value is false. Prerequisite: includeOrderInfo=true
Default:
false
includeTransportExtension
boolean 
optional
Whether the returned values include extended freight information, such as kilometers and container types. The default value is false. Prerequisite: includeOrderInfo=true
Default:
false
nil
boolean 
optional
Default:
false
globalScope
boolean 
optional
Default:
false
typeSubstituted
boolean 
optional
Default:
false
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundRequest version="0.1" login="username" password="password">
    <queries>
        <query>
            <attribute>orderStatus</attribute>
            <eq>delivered</eq>
        </query>
        <query>
            <attribute>pickupSla</attribute>
            <ge>2024-1-1</ge>
            <le>2024-7-31</le>
        </query>
        <query>
            <attribute>customText1</attribute>
            <eq>STANDSP</eq>
        </query>
        <query>
            <attribute>customText14</attribute>
            <eq>2600158714</eq>
        </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>
    <orderBy>
        <desc>pickupSla</desc>
    </orderBy>
    <start>1</start>
    <count>10</count>
</orderOutboundRequest>

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://login.otms.com/ws/orderOutbound' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundRequest version="0.1" login="username" password="password">
    <queries>
        <query>
            <attribute>orderStatus</attribute>
            <eq>delivered</eq>
        </query>
        <query>
            <attribute>pickupSla</attribute>
            <ge>2024-1-1</ge>
            <le>2024-7-31</le>
        </query>
        <query>
            <attribute>customText1</attribute>
            <eq>STANDSP</eq>
        </query>
        <query>
            <attribute>customText14</attribute>
            <eq>2600158714</eq>
        </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>
    <orderBy>
        <desc>pickupSla</desc>
    </orderBy>
    <start>1</start>
    <count>10</count>
</orderOutboundRequest>'

Responses

🟢200成功
application/xml
Successful operation
Body
orders
object (Orders) 
optional
order
array[object (OrderDetail) {15}] 
optional
Order information
start
integer <int32>
optional
Starting index of returned orders
count
integer <int32>
optional
Actual number of orders returned
total
integer <int32>
optional
Total number of orders filtered in this query
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundResponse>
    <orders>
        <order>
            <vendorDetail>
                <partnerCode>STANDSP</partnerCode>
                <partnerName>StandardSPOtmsCompany</partnerName>
                <partnerHeadOfficeCode>sp</partnerHeadOfficeCode>
                <orderNumber>STANDSR450640</orderNumber>
                <erpNumber>cyn2024091901_1;2600158714;</erpNumber>
                <price>0.50</price>
                <priceDetails>
                    <priceDetail>
                        <name>base</name>
                        <rate>0.50</rate>
                    </priceDetail>
                </priceDetails>
                <consolidationId></consolidationId>
                <rateAdjustments/>
                <billAccepted>false</billAccepted>
                <vat>0.0</vat>
                <vatRegisterNo> </vatRegisterNo>
            </vendorDetail>
            <orderInfo>
                <location>童车_苏州昆山</location>
                <shipFrom>
                    <name>haohaizi_pingxiang</name>
                    <externalId>haohaizi_pingxiang</externalId>
                    <province>hebei</province>
                    <town>xingtaishi</town>
                    <county>pingxiangxian</county>
                    <address>xingtaixian</address>
                    <customFields/>
                    <contactName>c</contactName>
                    <contactMobile>19999999999</contactMobile>
                    <longitude>114.16774440241458</longitude>
                    <latitude>37.15242169927538</latitude>
                </shipFrom>
                <shipTo>
                    <name>haohaizi_kunshan</name>
                    <externalId>haohaizi_kunshan</externalId>
                    <province>jiangsu</province>
                    <town>suzhoushi</town>
                    <county>kunshangshi</county>
                    <address>kunshangshi</address>
                    <customFields/>
                    <contactName>c</contactName>
                    <contactMobile>19999999999</contactMobile>
                    <longitude>120.96580778410554</longitude>
                    <latitude>31.32893679549736</latitude>
                </shipTo>
                <totalWeight>42.000</totalWeight>
                <totalVolume>50.000000</totalVolume>
                <totalQuantity>6</totalQuantity>
                <totalInsurance>0.00</totalInsurance>
                <customFields>
                    <customText1>STANDSP</customText1>
                    <customText4>P</customText4>
                    <customText7>LTL</customText7>
                    <customText8>2024-06-19 17:00</customText8>
                    <customText9>kunshangshi</customText9>
                    <customText10>cy2024091901_1</customText10>
                    <customText12>tongche</customText12>
                    <customText13>1</customText13>
                    <customText14>2600158714</customText14>
                    <customText15>ZH004678</customText15>
                    <customText17>1</customText17>
                    <customText18>Ware</customText18>
                </customFields>
                <dockAppointment>
                    <expectedArrivalTime>2024-06-22T23:59:59.000</expectedArrivalTime>
                    <driverName>test</driverName>
                    <truckPlate>HB63214</truckPlate>
                    <driverMobile>123456789</driverMobile>
                </dockAppointment>
                <positions/>
                <cargoType>1</cargoType>
                <locationHistories>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:28:28.000</locationDateTime>
                        <longitude>121.52840424</longitude>
                        <latitude>31.21907043</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:29:28.000</locationDateTime>
                        <longitude>121.52840424</longitude>
                        <latitude>31.21907043</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:29:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:29:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:30:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:30:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:31:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:31:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T15:32:27.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T16:06:01.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T16:06:01.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2024-09-19T16:06:44.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                </locationHistories>
            </orderInfo>
            <pickupSla>2024-06-19T23:59:59.000</pickupSla>
            <deliverySla>2024-06-22T23:59:59.000</deliverySla>
            <orderStatus>delivered</orderStatus>
            <orderEvents>
                <event>
                    <name>new</name>
                    <time>2024-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>released</name>
                    <time>2024-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>dispatched</name>
                    <time>2024-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>vendor released</name>
                    <time>2024-09-19T15:20:22.000</time>
                </event>
                <event>
                    <name>vendor dispatched</name>
                    <time>2024-09-19T15:21:58.000</time>
                </event>
                <event>
                    <name>picked</name>
                    <time>2024-09-19T15:25:41.000</time>
                </event>
                <event>
                    <time>2024-09-19T15:30:58.000</time>
                    <operationTime>2024-09-19T16:06:05.000</operationTime>
                </event>
                <event>
                    <name>delivered</name>
                    <time>2024-09-19T16:06:54.000</time>
                    <latitude>31.2230219165261</latitude>
                    <longitude>121.53920836083034</longitude>
                </event>
                <event>
                    <time>2024-09-19T16:07:14.000</time>
                    <operationTime>2024-09-19T16:11:11.000</operationTime>
                </event>
                <event>
                    <name>epod</name>
                    <time>2024-09-19T16:07:40.000</time>
                </event>
            </orderEvents>
            <assignedDrivers>
                <pickup>
                    <assignedDriver>
                        <driverName>test</driverName>
                        <mobile>123456789</mobile>
                        <truckPlate>HB63214</truckPlate>
                    </assignedDriver>
                </pickup>
                <delivery>
                    <assignedDriver>
                        <driverName>test</driverName>
                        <mobile>123456789</mobile>
                        <truckPlate>HB63214</truckPlate>
                    </assignedDriver>
                </delivery>
            </assignedDrivers>
        </order>
    </orders>
    <start>1</start>
    <count>1</count>
    <total>1</total>
</orderOutboundResponse>
Modified at 2025-06-06 02:46:48
Previous
Order Import
Next
shipPointImport
Built with