Import Pickup and Delivery Points
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 authentication first. Otherwise, the username and password in the request message will be used.
Body Params application/xml
Version number of the request. Current version number is 0.1
Username. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
Password. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
shipPoints
array[object (RemovedShipPoint) {5}]
List of pickup and delivery points to delete
oTMS offline customer company code (applicable to carrier accounts)
clientReferenceNumber
string
System order identifier of the calling system
Client reference identifier, can take the following values:
0 - Pickup point
1 - Delivery point
2 - Hub
Allowed values:PICKUP_POINTDELIVERY_POINTHUB
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointRemoveRequest version="0.1" login="username" password="password">
<shipPoints>
<shipPoint sequence="1">
<clientReferenceNumber>sh00105001</clientReferenceNumber>
<type>0</type>
<externalId>11223344</externalId>
</shipPoint>
<shipPoint sequence="2">
<clientReferenceNumber>sh00105002</clientReferenceNumber>
<type>1</type>
<externalId>11223344</externalId>
</shipPoint>
</shipPoints>
</shipPointRemoveRequest>
Request samples
curl --location --request DELETE 'https://login.otms.com/ws/shipPointImport' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointRemoveRequest version="0.1" login="username" password="password">
<shipPoints>
<shipPoint sequence="1">
<clientReferenceNumber>sh00105001</clientReferenceNumber>
<type>0</type>
<externalId>11223344</externalId>
</shipPoint>
<shipPoint sequence="2">
<clientReferenceNumber>sh00105002</clientReferenceNumber>
<type>1</type>
<externalId>11223344</externalId>
</shipPoint>
</shipPoints>
</shipPointRemoveRequest>'
Responses
responseCode
array [object {3}]
Customer verification failed.
Unsupported request version.
There is too much delivery point data in the request.
processedShipPoints
string
Number of processed pickup and delivery points
shipPoints
array [object {5}]
List of processed pickup and delivery points
clientReferenceNumber
string
Client reference number, obtained from the received pickup and delivery point.
Pickup and delivery point import status, including the following constants:
ADDED
UPDATED
REMOVED
FAILED
responseCodes
array [object {1}]
List of order response codes, detailed explanation of the import result, may be empty
responseCodeParameters
object
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointRemoveResponse version="0.1">
<responseCode/>
<processedShipPoints>2</processedShipPoints>
<shipPoints>
<shipPoint>
<clientReferenceNumber>sh00105001</clientReferenceNumber>
<importStatus>REMOVED</importStatus>
<responseCodes/>
</shipPoint>
<shipPoint>
<clientReferenceNumber>sh00105002</clientReferenceNumber>
<importStatus>REMOVED</importStatus>
<responseCodes/>
</shipPoint>
</shipPoints>
</shipPointRemoveResponse>
Modified at 2025-06-06 02:46:48
