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

Carrier Export

POST
/ws/vendorOutbound

Carrier Export Interface#

Through the Carrier Export Interface, customer systems can connect to the oTMS system to query carrier information.
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 10 requests per second per company.

Request

Header Params
Authorization
string 
optional
Basic Authorization. If not empty, this value will be used for identity authentication with priority. Otherwise, the username and password in the request message will be used.
Default:
Body Params application/xml
object {0}
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendorOutboundRequest version="0.1" login="login" password="password"/>

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/vendorOutbound' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendorOutboundRequest version="0.1" login="login" password="password"/>'

Responses

🟢200成功
application/xml
Successful operation
Body
vendors
array[object (VendorOutbound) {6}] 
optional
Carrier information
name
string 
optional
Company name
code
string 
optional
Company code
registeredAt
string <date-time>
optional
Company registration time
contactPerson
object (ContactPerson) 
optional
transportTypes
array[string]
optional
Transport types that the carrier can handle, including the following constants:
FTL - Full Truck Load
LTL - Less Than Truck Load
AIR - Air Freight
EXPRESS - Express Delivery
RAIL - Rail Transport
WATER - Water Transport
Allowed values:
FTLLTLAIREXPRESSRAILWATER
cargoTypes
array[string]
optional
Cargo types that the carrier can handle, including the following constants:
1 - General Cargo
2 - Temperature-Controlled Cargo
3 - Dangerous Goods
4 - Dangerous Goods and Temperature-Controlled Cargo
Allowed values:
TYPE_1TYPE_1_1TYPE_1_2TYPE_2TYPE_3TYPE_3_1TYPE_4
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendorOutboundResponse>
    <vendors>
        <vendor>
            <name>testsp</name>
            <code>MDVZMIDF</code>
            <registeredAt>2022-08-18Z</registeredAt>
            <contactPerson>
                <name>liang liang</name>
                <phone>000-1111110020</phone>
                <mobile>+622365141</mobile>
                <email>526398474@qq.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>LTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>2022-3</name>
            <code>QDJSXGLW</code>
            <registeredAt>2022-11-28Z</registeredAt>
            <contactPerson>
                <name>yang cong-3</name>
                <phone></phone>
                <mobile>+621391858</mobile>
                <email>onion_0929@163.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>onion</name>
            <code>IMSOIVUO</code>
            <registeredAt>2022-07-14Z</registeredAt>
            <contactPerson>
                <name>liang lifang</name>
                <phone>000-12334567</phone>
                <mobile>+62139185800</mobile>
                <email>lianglifang1121@163.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>AIR</transportTypes>
                <transportTypes>RAIL</transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>LTL</transportTypes>
                <transportTypes>WATER</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>2022-2</name>
            <code>UMTYZJKP</code>
            <registeredAt>2022-11-28Z</registeredAt>
            <contactPerson>
                <name>yang cong-2</name>
                <phone></phone>
                <mobile>+62139185800</mobile>
                <email>709661200@qq.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>LTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>2022-1</name>
            <code>NHJXXBUR</code>
            <registeredAt>2022-11-28Z</registeredAt>
            <contactPerson>
                <name>yang cong</name>
                <phone></phone>
                <mobile>+6213918580</mobile>
                <email>zoraliang2022@163.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>2022-5</name>
            <code>LULAHLPA</code>
            <registeredAt>2022-11-28Z</registeredAt>
            <contactPerson>
                <name>yang cong-5</name>
                <phone>000-12345678</phone>
                <mobile>+6213918580</mobile>
                <email>onion_1121@163.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>LTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>2022-4</name>
            <code>WVMKRLKZ</code>
            <registeredAt>2022-11-28Z</registeredAt>
            <contactPerson>
                <name>yang cong-4</name>
                <phone></phone>
                <mobile>+6213256421</mobile>
                <email>onion_2021@163.com</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>FTL</transportTypes>
                <transportTypes>EXPRESS</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
    </vendors>
</vendorOutboundResponse>
Modified at 2025-06-06 02:46:48
Previous
Share Link
Next
Order Update
Built with