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 Recall

PUT
/ws/jobSheetRecall
Transport Order Recall

Waybill Recall#

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 authentication first. Otherwise, the username and password in the request body will be used.
Default:
Body Params application/xml
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.
jobSheets
array[object (JobSheetDelete) {3}] 
required
List of transport orders to be recalled. The maximum number of recalls in a single request is 20.
sequence
integer <int32>
required
Sequence number
jobSheetNumber
string 
optional
Transport order number
externalShipmentId
string 
optional
External identification number of the transport order
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallRequest version="0.1" login="login" password="password">
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSAXDHBMAV009056</jobSheetNumber>
            <externalShipmentId>24110801</externalShipmentId>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber>JSAXDHBMAV011671</jobSheetNumber>
            <externalShipmentId>24110701</externalShipmentId>
        </jobSheet>
    </jobSheets>
</jobSheetRecallRequest>

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/jobSheetRecall' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallRequest version="0.1" login="login" password="password">
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSAXDHBMAV009056</jobSheetNumber>
            <externalShipmentId>24110801</externalShipmentId>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber>JSAXDHBMAV011671</jobSheetNumber>
            <externalShipmentId>24110701</externalShipmentId>
        </jobSheet>
    </jobSheets>
</jobSheetRecallRequest>'

Responses

🟢200成功
application/xml
Successful operation
Body
version
string 
required
Response version number
responseCode
string 
optional
Global feedback code
jobSheets
array[object (JobSheetDeleteResult) {6}] 
optional
Detailed information about the results of the transport order recall
sequence
integer <int32>
required
Sequence number
jobSheetNumber
string 
optional
Transport order number
externalShipmentId
string 
optional
External identification number of the transport order
status
string 
optional
Response status
code
string 
required
Response code
msg
string 
optional
Response message
Error code prompt
object 
optional
Single request feedback code
100
string 
optional
success
101
string 
optional
did not find the shipping document
109
string 
optional
Transport Order Status Error
111
string 
optional
transport order recall failed (please check order status)
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallResponse version="0.1">
    <responseCode></responseCode>
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSAXDHBMAV009056</jobSheetNumber>
            <externalShipmentId>24110801</externalShipmentId>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber>JSAXDHBMAV011671</jobSheetNumber>
            <externalShipmentId>24110701</externalShipmentId>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </jobSheet>
    </jobSheets>
</jobSheetRecallResponse>
Modified at 2025-06-06 02:46:48
Previous
Job Sheet Outbound
Next
TruckPosition
Built with