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

Share Link

PUT
/ws/order/share
Share Link

Order Export Interface#

The Order Export Interface allows customer systems to integrate and generate shareable links.

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"?>
<orderShareRequest version="0.1" login="login" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>241107005</erpNumber>
            <orderNumber></orderNumber>
        </order>
        <order sequence="2">
            <erpNumber></erpNumber>
            <orderNumber>AXDHBMAV009886</orderNumber>
        </order>        
    </orders>
</orderShareRequest>

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 PUT 'https://login.otms.com/ws/order/share' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderShareRequest version="0.1" login="login" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>241107005</erpNumber>
            <orderNumber></orderNumber>
        </order>
        <order sequence="2">
            <erpNumber></erpNumber>
            <orderNumber>AXDHBMAV009886</orderNumber>
        </order>        
    </orders>
</orderShareRequest>'

Responses

🟢200成功
application/xml
Successful operation
Body
version
string 
optional
Response version number
responseCode
object 
optional
Response code
2400
string 
optional
successful.
2401
string 
optional
failed.
2402
string 
optional
The Erp and oTMS tracking numbers are both empty.
2403
string 
optional
Both the Erp and oTMS tracking numbers have values.
2404
string 
optional
oTMS tracking number does not exist.
2405
string 
optional
The Erp tracking number does not exist.
2406
string 
optional
generated sharing link error.
successNum
integer <int32>
optional
Number of share links generated successfully
failNum
integer <int32>
optional
Number of share links that failed to generate
responseEntries
array[object (OrderShareResponseEntry) {6}] 
optional
List of share links
sequence
integer <int32>
optional
Sequence number, used to match corresponding records in the request
status
string 
optional
Response status:
SUCCEED - Success
FAILED - Failure
code
string 
optional
Response code
erpNumber
string 
optional
ERP number
orderNumber
string 
optional
oTMS number
url
string 
optional
Share link
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderShareResponse version="0.1">
    <responseCode>2400</responseCode>
    <successNum>2</successNum>
    <failNum>0</failNum>
    <orders>
        <order sequence="1">
            <status>SUCCEED</status>
            <code>2400</code>
            <erpNumber>241107005</erpNumber>
            <url>https://qa.otms.com/mp/?tab=ALL#/order-preview/F15DAB4E48C8C457EC7CA8C669E6F154/54e557d00861fded7137d205d4245cbc</url>
        </order>
        <order sequence="2">
            <status>SUCCEED</status>
            <code>2400</code>
            <orderNumber>AXDHBMAV009886</orderNumber>
            <url>https://qa.otms.com/mp/?tab=ALL#/order-preview/F3837124BB1D93D6EC7CA8C669E6F154/912e98cdaff7ae830f9b7778132388ef</url>
        </order>
    </orders>
</orderShareResponse>
Previous
Order Recall
Next
Carrier Export
Built with