Shipper/Receiver Base Data Export
Consignee/Consignor Export Interface#
Through the Consignee/Consignor Export Interface, customer systems can connect to the oTMS system to query consignee and consignor information and status.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 prioritized for authentication. Otherwise, the username and password in the request body will be used.
Body Params application/xml
Version number of the request
Username. Used for API caller authentication. If the Authorization in the request header is not empty, this value will be ignored.
Password. Used for API caller authentication. If the Authorization in the request header is not empty, this value will be ignored.
query
array[object (ShipPointQuery) {6}]
Query conditions. Multiple conditions are connected logically with ‘AND’.
Starting index of returned orders, minimum is 1. Default is 1.
Maximum number of shippers/receivers to return. Default is 100.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundRequest version="0.1" login="login" password="password">
<queries>
<query>
<attribute>externalId</attribute>
<in>
<value>MPC1</value>
<value>PH3505</value>
</in>
</query>
</queries>
<start>1</start>
<count>10</count>
</shipPointOutboundRequest>
Request samples
curl --location --request POST 'https://login.otms.com/ws/shipPointOutbound' \
--header 'Authorization;' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundRequest version="0.1" login="login" password="password">
<queries>
<query>
<attribute>externalId</attribute>
<in>
<value>MPC1</value>
<value>PH3505</value>
</in>
</query>
</queries>
<start>1</start>
<count>10</count>
</shipPointOutboundRequest>'
Responses
shipPoints
object (ShipPoints)
shipPoint
array[object (ShipPoint) {17}]
Shipper/receiver information
Starting index of returned shippers/receivers
Actual number of shippers/receivers returned
Total number of shippers/receivers filtered by this query
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundResponse>
<shipPoints>
<shipPoint>
<name>Cabuyao Plant</name>
<externalId>MPC1</externalId>
<province>Laguna</province>
<town>Cabuyao</town>
<address>Park Dr. Ext, LISP, Pulo</address>
<zipcode>4025</zipcode>
<contactName>Alvin</contactName>
<contactMobile>+639286675551</contactMobile>
<contactPhone>-</contactPhone>
<contactEmail></contactEmail>
<longitude>-90.49489</longitude>
<latitude>31.22409</latitude>
<locationType>0</locationType>
</shipPoint>
<shipPoint>
<name>Amulung</name>
<externalId>PH3505</externalId>
<province>Cagayan</province>
<town>Amulung</town>
<address>Amulung</address>
<zipcode>3505</zipcode>
<contactName>Amulung</contactName>
<contactMobile>+631546800</contactMobile>
<contactPhone>null-null</contactPhone>
<longitude>121.72305</longitude>
<latitude>17.8386</latitude>
<locationType>0</locationType>
</shipPoint>
</shipPoints>
<start>1</start>
<count>10</count>
<total>2</total>
</shipPointOutboundResponse>
Modified at 2025-06-06 02:46:48
