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

Job Sheet Outbound

POST
/ws/jobSheetOutbound
Waybill Export/Tracking

Waybill Export/Tracking Interface#

Through the Waybill Export/Tracking Interface, customer systems can connect to the oTMS system to query waybill information and status.

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, this value will be used for authentication. Otherwise, the username and password in the request body will be used.
Default:
Body Params application/xml
name
object (QName) 
optional
namespaceURI
string 
optional
localPart
string 
optional
prefix
string 
optional
value
object (JobSheetOutboundRequest) 
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.
queries
object (Queries) 
optional
orderBy
object (JobSheetOrderBy) 
optional
start
integer <int32>
optional
Start index for returned orders, minimum is 1. Default is 1.
count
integer <int32>
optional
Maximum number of orders to return. Default is 100.
includeOrderInfo
boolean 
optional
Whether order information should be included in the response. Default is false.
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"?>
<jobSheetOutboundRequest version="0.1" login="login" password="password">
    <queries>
        <query>
            <attribute>jobSheetNumber</attribute>
            <eq>JSAXDHBMAV001495</eq>
        </query>
    <start>1</start>
    <count>10</count>
</jobSheetOutboundRequest>

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/jobSheetOutbound' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetOutboundRequest version="0.1" login="login" password="password">
    <queries>
        <query>
            <attribute>jobSheetNumber</attribute>
            <eq>JSAXDHBMAV001495</eq>
        </query>
    <start>1</start>
    <count>10</count>
</jobSheetOutboundRequest>'

Responses

🟢200成功
application/xml
successful operation
Body
jobSheets
object (JobSheets) 
optional
jobSheet
array[object (JobSheetDetail) {26}] 
optional
Waybill information
start
integer <int32>
optional
Start index for returned waybills
count
integer <int32>
optional
Actual number of waybills returned
total
integer <int32>
optional
Total number of waybills filtered by this query
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetOutboundResponse>
    <jobSheets>
        <jobSheet>
            <jobSheetNumber>JSAXDHBMAV001495</jobSheetNumber>
            <quantity>14</quantity>
            <totalVolume>6.000000000</totalVolume>
            <totalWeight>1800.000</totalWeight>
            <transportType>LTL</transportType>
            <cargoType>1</cargoType>
            <packageType>A</packageType>
            <truckType>2</truckType>
            <pickupSla>2024-06-20T23:59:59.000</pickupSla>
            <deliverySla>2024-06-22T23:59:59.000</deliverySla>
            <state>DELIVERY</state>
            <currentStatus>DELIVERED</currentStatus>
            <vendorName>onion</vendorName>
            <shipFrom>
                <name>Amulung</name>
                <province>Cagayan</province>
                <town>Amulung</town>
            </shipFrom>
            <shipTo>
                <name>AAAA</name>
                <province>Rizal Province</province>
                <town>San Mateo</town>
            </shipTo>
            <assignedDriver>
                <driverName>15800000000</driverName>
                <mobile>15800000000</mobile>
                <truckPlate>AA082407</truckPlate>
                <truckLength>7.2</truckLength>
                <mtCapacity>5.0</mtCapacity>
                <cbmCapacity>38.0</cbmCapacity>
            </assignedDriver>
            <customFields/>
        </jobSheet>
    </jobSheets>
    <start>1</start>
    <count>1</count>
    <total>1</total>
</jobSheetOutboundResponse>
Previous
Shipper/Receiver export
Next
Job Sheet Recall
Built with