Order Recall
Recall Orders via the Interface#
Through this interface, external systems can directly recall orders in the oTMS system.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
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.
Body Params application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRecallRequest version="0.1" login="login" password="password">
<orders>
<order sequence="1">
<erpNumber>241107004</erpNumber>
</order>
<order sequence="2">
<erpNumber>241107003</erpNumber>
</order>
</orders>
</orderRecallRequest>
Request samples
curl --location --request POST 'https://login.otms.com/ws/orderRecall' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRecallRequest version="0.1" login="login" password="password">
<orders>
<order sequence="1">
<erpNumber>241107004</erpNumber>
</order>
<order sequence="2">
<erpNumber>241107003</erpNumber>
</order>
</orders>
</orderRecallRequest>'
Responses
successfulRecalled
integer <int32>
Number of orders successfully recalled
Set of ERP numbers for recalled orders
Return result sequence number
Result of the recall operation:
SUCCEED - Recall succeeded, no errors occurred
FAILED - Recall failed, errors occurred
NOT_RECALLED - Recall failed due to not meeting recall conditions
List of return codes, detailing the specific recall results
ERP number of successfully recalled order
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRecallResponse version="0.1">
<responseCode>SUCCESS</responseCode>
<successfulRecalled>2</successfulRecalled>
<orders>
<order sequence="1">
<recallStatus>SUCCESS</recallStatus>
<responseCodes/>
<erpNumber>241107004</erpNumber>
</order>
<order sequence="2">
<recallStatus>SUCCESS</recallStatus>
<responseCodes/>
<erpNumber>241107003</erpNumber>
</order>
</orders>
</orderRecallResponse>
Modified at 2025-06-06 02:46:48
