oTMS logo 开放平台
Documentation Help

订单评分

订单评分导入接口,一个请求最大支持100条rating记录

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

接口说明

公共参数

环境 HTTP请求方法 HTTPS请求地址 请求主体MIME类型 响应主体MIME类型
正式环境 POST https://login.otms.cn/ws/openapi/ratings application/xml application/xml
沙箱环境 POST https://demo.otms.cn/ws/openapi/ratings application/xml application/xml

请求参数

字段名 位置 是否必填 描述 Schema
body body 订单评分数据导入请求 RatingImportRequest

响应参数

状态码 描述 响应模型
200 successful operation RatingImportResponse

详细描述

RatingDetail

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序号
orderNumber string OTMS订单号
rating integer (int32) 评分值
latitude number (double) 评分坐标(纬度)
longitude number (double) 评分坐标(经度)
createdBy string 评分人邮箱(同一评分人对同一订单只能评一次)
createdAt string (date-time) 评分时间
isPickup boolean 是否提货评分,不填默认false
remark string 备注

RatingImportRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号。当前版本号为1.0
login string 用户名。用于 API 调用者身份认证。
password string 密码。用于 API 调用者身份认证。
ratings array[RatingDetail] 评分信息列表

RatingImportResponse

字段名 类型 是否必填 描述 示例
code integer (int32) 返回码
message string 处理结果
ratings array[RatingImportResult] 评分导入结果列表

RatingImportResult

字段名 类型 是否必填 描述 示例
orderNumber string OTMS订单号
code integer (int32) 评分处理返回码
message string 处理结果描述

报文示例

请求示例

<?xml version="1.0" encoding="utf-8"?>
<externalRatingRequest version="1.0" login="*******" password="************">
  <ratings>
    <ratingDetail sequence="1">
      <orderNumber>SH00105065851</orderNumber> 
      <rating>4</rating> 
      <latitude>31.230253</latitude> 
      <longitude>121.534672</longitude>
      <createdBy>tester@otms.com</createdBy>
      <createdAt>2017-05-22T01:02:03.045</createdAt>
      <remark>this is remark</remark>
    </ratingDetail> 
    <ratingDetail sequence="2">
      <orderNumber>SH00105065852</orderNumber>  
      <rating>4</rating> 
      <latitude>31.230253</latitude> 
      <longitude>121.534672</longitude>
      <createdBy>tester@otms.com</createdBy> 
      <createdAt>2017-05-22T01:02:03.045</createdAt>
      <remark>this is remark</remark>
    </ratingDetail>
  </ratings>
</externalRatingRequest>

响应示例

<?xml version="1.0" encoding="utf-8"?>
<ratingImportResponse>
  <code>0<code>
  <message>success</message>
  <ratings>
    <ratingImportResult> 
      <orderNumber>SH00105065851</orderNumber> 
      <code>0000</code> 
      <message>success</message>
    </ratingImportResult> 
    <ratingImportResult>
      <orderNumber>SH00105065852</orderNumber> 
      <code>9999</code> 
      <message>failed</message>
    </ratingImportResult>
  </ratings>
</ratingImportResponse>

API工具