Order Rating

Order Rating Import Interface

The Order Rating Import Interface allows the import of rating records. A single request can support up to 100 rating records.

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 message will be used.

Default:

Body Params application/xml

version

string

required

Version number of the request. Current version number is 1.0

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.

ratings

array[object (RatingDetail) {11}]

required

List of rating details

sequence

integer <int32>

optional

Sequence number

orderNumber

string

optional

OTMS order number

rating

integer <int32>

optional

Rating value

latitude

number <double>

optional

Rating coordinate (latitude)

longitude

number <double>

optional

Rating coordinate (longitude)

createdBy

string

optional

Rater's email (the same rater can only rate an order once)

createdAt

string <date-time>

optional

Rating time

isPickup

boolean

optional

Whether it is a pickup rating. Default is false if not specified.

Default:

false

remark

string

optional

Remarks

clientCode

string

optional

Client Code

erpNumber

string

optional

ERP order number

Example

<?xml version="1.0" encoding="utf-8"?>
<externalRatingRequest version="1.0" login="login" password="password">
  <ratings>
    <ratingDetail sequence="1">
      <clientCode></clientCode>
      <erpNumber></erpNumber>
      <orderNumber>AXDHBMAV009886</orderNumber> 
      <rating>4</rating> 
      <latitude>31.230253</latitude> 
      <longitude>121.534672</longitude>
      <createdBy></createdBy>
      <createdAt>2024-11-08T12:02:03.045</createdAt>
      <remark>this is remark</remark>
    </ratingDetail> 
  </ratings>
</externalRatingRequest>

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/xml

Successful operation

Body

code

integer <int32>

optional

Return code

message

string

optional

Processing result

ratings

array[object (RatingImportResult) {5}]

optional

List of rating import results

orderNumber

string

optional

OTMS order number

code

integer <int32>

optional

Rating processing return code

message

string

optional

Description of processing result

erpNumber

string

optional

ERP order number

clientCode

string

optional

Client Code

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ratingImportResponse>
    <ratings>
        <ratingImportResult>
            <orderNumber>AXDHBMAV009886</orderNumber>
            <code>1000</code>
            <message>success</message>
        </ratingImportResult>
    </ratings>
</ratingImportResponse>

Order Rating Import Interface#

Configuration Instructions#

Important Notes#

Call Limitations#

Request

Request samples

Responses

Order Rating Import Interface

Configuration Instructions

Important Notes

Call Limitations