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.
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.
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"?><orderLinkRequestversion="0.1"login="login"password="password"><orders><ordersequence="1"><erpNumber/><orderNumber>AXDHBMAV009887</orderNumber>////Need to check the option to send external tracking emails
<userType>Shipper</userType></order></orders></orderLinkRequest>
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/orderLink' \
--header'Authorization;' \
--header'Content-Type: application/xml' \
--data-raw'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderLinkRequest version="0.1" login="login" password="password">
<orders>
<order sequence="1">
<erpNumber/>
<orderNumber>AXDHBMAV009887</orderNumber>////Need to check the option to send external tracking emails
<userType>Shipper</userType>
</order>
</orders>
</orderLinkRequest>'
Responses
🟢200成功
application/xml
Successful operation
Body
version
string
optional
Response version number
responseCode
string
optional
Response code
successNum
integer<int32>
optional
Number of H5 links generated successfully
failNum
integer<int32>
optional
Number of H5 links that failed to generate
responseEntries
array[object (OrderLinkResponseEntry) {7}]
optional
List of H5 links
sequence
integer<int32>
optional
Sequence number, used to match corresponding records in the request
