Order Assignment to Driver - oTMS-openapi en

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. Otherwise, the username and password in the request body will be used.

Default:

Body Params application/xml

version

string

required

Request version number. Current version number is 0.1

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.

driverAssignments

array[object (DriverAssignment) {9}]

optional

List of driver assignments

sequence

integer <int32>

optional

Sequence number

clientCode

string

optional

Customer code of the order. Only applicable to supplier accounts.

orderNumber

string

optional

oTMS order number of the order. At least one of this field or the erpNumber field must be provided.

erpNumber

string

optional

ERP order number of the order. At least one of this field or the orderNumber field must be provided.

branch

string

optional

Branch name of the order.

ignoreOrderMatch

boolean

optional

Whether to ignore whether the truck type matches the order, default is false.

Default:

false

driverTruckInfos

array[object (DriverTruckInfo) {4}]

optional

List of driver and truck information

matchTariff

boolean

optional

Whether to match tariff files

Default:

false

tariffSelectionMode

enum<string>

optional

Tariff file matching rule

Allowed values:

CHEAPESTSHORTEST_LEADTIME

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assignDriverRequest version="0.1" login="login" password="password">
    <driverAssignments>
        <driverAssignment sequence="1">
            <clientCode>WWUTAUAV</clientCode>
            <orderNumber>WWUTAUAV966185</orderNumber>
            <branch></branch>
            <driverTruckInfos>
                <driverTruckInfo>
                    <truckPlate>TA67890</truckPlate>
                    <driverName></driverName>
                    <driverMobile>123456789</driverMobile>
                </driverTruckInfo>
            </driverTruckInfos>
        </driverAssignment>
    </driverAssignments>
</assignDriverRequest>

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

array [object {2}]

optional

Global feedback code

string

optional

Customer verification failed.

string

optional

Unsupported request version.

successfulAssignments

integer <int32>

required

Number of successful assignment operations

assignResults

array [object {6}]

optional

List of assignment operations

sequence

integer <int32>

optional

Sequence number

assignStatus

string

optional

Result of the assignment operation, which can take one of the following two values:
DISPATCHED - Assignment succeeded, no error occurred
FAILED - Assignment failed

assignedOrders

integer <int32>

optional

Number of orders assigned to the driver in this operation.

orderNumbers

array[string]

optional

List of oTMS order numbers representing all orders assigned to the driver in the assignment operation.

responseInfos

array[object (ResponseInfo) {4}]

optional

List of driver-truck and response code information

responseCodes

array [object {21}]

optional

Single request feedback code

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assignDriverResponse version="0.1">
    <responseCode></responseCode>
    <successfulAssignments>0</successfulAssignments>
    <assignResults>
        <assignResult sequence="1">
            <assignStatus>FAILED</assignStatus>
            <responseInfos>
                <responseInfo>
                    <truckPlate>TA67890</truckPlate>
                    <driverName></driverName>
                    <driverMobile>123456789</driverMobile>
                    <responseCodes>
                        <responseCode>1131</responseCode>
                    </responseCodes>
                </responseInfo>
            </responseInfos>
        </assignResult>
    </assignResults>
</assignDriverResponse>