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

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"?>
<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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/xml

Successful operation

Body

version

string

required

Response version number

responseCode

string

optional

Global feedback code

successfulRecalled

integer <int32>

optional

Number of orders successfully recalled

orders

array [object {4}]

optional

Set of ERP numbers for recalled orders

sequence

integer <int32>

optional

Return result sequence number

recallStatus

string

optional

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

responseCodes

object

optional

List of return codes, detailing the specific recall results

erpNumber

string

optional

ERP number of successfully recalled order

Example

<?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>

Recall Orders via the Interface#

Configuration Instructions#

Important Notes#

Call Limitations#

Request

Request samples

Responses

Recall Orders via the Interface

Configuration Instructions

Important Notes

Call Limitations