订单评分
订单评分导入接口，一个请求最大支持100条rating记录
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | 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 |
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 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 | 否 | 备注 | |
| clientCode | string | 否 | 客户 Code | |
| erpNumber | string | 否 | ERP 单号 |
RatingImportRequest
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 请求的版本号。当前版本号为1.0 | |
| login | string | 否 | 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| password | string | 否 | 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| ratings | array[RatingDetail] | 是 | 评分信息列表 |
RatingImportResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| code | integer (int32) | 否 | 返回码 | |
| message | string | 否 | 处理结果 | |
| ratings | array[RatingImportResult] | 否 | 评分导入结果列表 |
RatingImportResult
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| orderNumber | string | 否 | OTMS订单号 | |
| code | integer (int32) | 否 | 评分处理返回码 | |
| message | string | 否 | 处理结果描述 | |
| erpNumber | string | 否 | erp单号 | |
| clientCode | string | 否 | clientCode |
请求示例
<?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>SH0010506585２</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>SH0010506585２</orderNumber>
<code>9999</code>
<message>failed</message>
</ratingImportResult>
</ratings>
</ratingImportResponse>