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

Delete delivery point

DELETE
/ws/shipPointImport

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 message will be used.
Default:
Body Params application/xml
version
string 
required
Version number of the request. Current version number is 0.1
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.
shipPoints
array[object (RemovedShipPoint) {5}] 
required
List of pickup and delivery points to delete
sequence
integer <int32>
required
Sequence number
clientCode
string 
optional
oTMS offline customer company code (applicable to carrier accounts)
clientReferenceNumber
string 
optional
System order identifier of the calling system
type
enum<string> 
optional
Client reference identifier, can take the following values:
0 - Pickup point
1 - Delivery point
2 - Hub
Allowed values:
PICKUP_POINTDELIVERY_POINTHUB
externalId
string 
optional
External identifier
Example
<?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

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

🟢200成功
application/xml
successful operation
Body
version
string 
required
Response version number
responseCode
array [object {3}] 
optional
Global response code
0
string 
required
Customer verification failed.
1
string 
required
Unsupported request version.
2
string 
required
There is too much delivery point data in the request.
processedShipPoints
string 
optional
Number of processed pickup and delivery points
shipPoints
array [object {5}] 
optional
List of processed pickup and delivery points
sequence
integer <int32>
optional
Sequence number
clientReferenceNumber
string 
optional
Client reference number, obtained from the received pickup and delivery point.
importStatus
string 
optional
Pickup and delivery point import status, including the following constants:
ADDED
UPDATED
REMOVED
FAILED
responseCodes
array [object {1}] 
optional
List of order response codes, detailed explanation of the import result, may be empty
responseCodeParameters
object 
optional
Example
<?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
Previous
shipPointImport
Next
Order Assignment to Driver
Built with