Through the Consignee/Consignor Export Interface, customer systems can connect to the oTMS system to query consignee and consignor information and status.
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.
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.
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 prioritized for authentication. Otherwise, the username and password in the request body will be used.
Default:
Body Params application/xml
version
string
optional
Version number of the request
login
string
optional
Username. Used for API caller authentication. If the Authorization in the request header is not empty, this value will be ignored.
password
string
optional
Password. Used for API caller authentication. If the Authorization in the request header is not empty, this value will be ignored.
queries
object(Queries)
optional
query
array[object (ShipPointQuery) {6}]
optional
Query conditions. Multiple conditions are connected logically with ‘AND’.
start
integer<int32>
optional
Starting index of returned orders, minimum is 1. Default is 1.
count
integer<int32>
optional
Maximum number of shippers/receivers to return. Default is 100.