版权所有©，上海海鼎信息工程股份有限公司，2016-2025，保留所有权利。

接口

1. 接口定义

1.1. 评论服务

1.1.1. 提交订单评价

POST /{tenant_id}/soms/commentservice/comment
1.1.1.1. 说明

提交订单评价

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order_comment
必填

订单评价

OrderComment
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.1.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}
1.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.2. 查询评价

POST /{tenant_id}/soms/commentservice/comment/query
1.1.2.1. 说明

查询评价

1.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
可选

页码，从0开始，必须>=0

integer (int32)

Query

page_size
可选

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:created(创建时间)、commentTime(评价时间)

string

Body

filter
必填

查询条件

OrderCommentFilter
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCommentPaging
1.1.2.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/query?desc=true
请求 body
{
  "platformIdEq" : "jdo2o",
  "stationIdEq" : "string",
  "idEq" : "string",
  "orderIdIn" : [ "string" ],
  "processStateEq" : "string",
  "processStateNotIn" : [ "string" ],
  "tagEq" : "string",
  "tagIn" : [ "string" ],
  "tagHas" : [ "string" ],
  "orderIdLike" : "32323232323323",
  "hasReply" : "invalid",
  "satisfieLevel" : "high",
  "hasContent" : false,
  "commentTimeStart" : "2016-03-02 12:00:01",
  "commentTimeEnd" : "2016-03-02 12:00:01",
  "id_in" : [ "string" ]
}
1.1.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "comments" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "202012021621",
    "store" : {
      "id" : "string",
      "name" : "string"
    },
    "time" : "2020-12-02 00:00:00",
    "content" : "很好",
    "labels" : [ "string" ],
    "details" : [ {
      "type" : "string",
      "score" : 0,
      "labels" : [ "string" ]
    } ],
    "order_id" : "202012021621",
    "platform_id" : "jdo2o",
    "shop_id" : "213",
    "image_urls" : [ "string" ],
    "extra_info" : {
      "next_time" : "2020-12-02 00:00:00",
      "next_content" : "很好",
      "delivery_content" : "很好",
      "next_image_urls" : "url"
    },
    "like_skus" : [ "string" ],
    "dislike_skus" : [ "string" ],
    "expire_time" : "2020-06-17 10:00:00",
    "front_comment_id" : "string",
    "reply_state" : "string",
    "reply_time" : "2020-06-17 10:00:00",
    "reply_content" : "string",
    "process_state" : "string",
    "process_remark" : "string",
    "remark" : "string",
    "tags" : [ "string" ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.1.3. 获取评价

GET /{tenant_id}/soms/commentservice/comment/{id}
1.1.3.1. 说明

获取评价

1.1.3.2. 参数
类型 名称 说明 类型

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户ID

string
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderComment
1.1.3.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string
1.1.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}

1.1.4. 更新评价回复

POST /{tenant_id}/soms/commentservice/comment/{id}/reply
1.1.4.1. 说明

更新评价回复

1.1.4.2. 参数
类型 名称 说明 类型

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

更新评价回复request

UpdateReplyContentRequest
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.4.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string/reply?operator=string
请求 body
{
  "reply_content" : "string"
}
1.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.3. OrderComment

订单评价

名称 说明 类型

content
可选

评价内容
样例 : "很好"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

details
可选

评价积分
样例 : [ "OrderCommentDetail" ]

< OrderCommentDetail > array

dislike_skus
可选

点踩的商品列表
样例 : [ "string" ]

< string > array

expire_time
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

extra_info
可选

评价自定义字段，不同平台不同内容
样例 : OrderExtraInfo

OrderExtraInfo

front_comment_id
可选

样例 : "string"

string

id
可选

评价ID
样例 : "202012021621"

string

image_urls
可选

评价图片
样例 : [ "string" ]

< string > array

labels
可选

评价标签
样例 : [ "string" ]

< string > array

like_skus
可选

点赞的商品列表
样例 : [ "string" ]

< string > array

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单ID
样例 : "202012021621"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

process_remark
可选

处理说明
样例 : "string"

string

process_state
可选

处理状态
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

reply_content
可选

回复内容
样例 : "string"

string

reply_state
可选

回复状态
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

shop_id
可选

商家ID
样例 : "213"

string

store
可选

门店
样例 : IdName

IdName

tags
可选

标签
样例 : [ "string" ]

< string > array

time
可选

评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.4. OrderCommentDetail

名称 说明 类型

labels
可选

评价标签
样例 : [ "string" ]

< string > array

score
可选

评价得分
样例 : 0

integer (int32)

type
可选

评价类型
样例 : "string"

string

2.5. OrderCommentFilter

名称 说明 类型

commentTimeEnd
可选

评价时间结束,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

commentTimeStart
可选

评价时间开始,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

hasContent
可选

是否有评价内容
默认值 : false
样例 : false

boolean

hasReply
可选

回复状态：none、replied、invalid
样例 : "invalid"

string

idEq
可选

评价ID
样例 : "string"

string

id_in
可选

样例 : [ "string" ]

< string > array

orderIdIn
可选

订单ID集合
样例 : [ "string" ]

< string > array

orderIdLike
可选

订单号模糊搜索
样例 : "32323232323323"

string

platformIdEq
可选

平台ID
样例 : "jdo2o"

string

processStateEq
可选

处理状态：未处理、处理成功、处理失败
样例 : "string"

string

processStateNotIn
可选

状态不存在
样例 : [ "string" ]

< string > array

satisfieLevel
可选

满意程度（low、medium、high）
样例 : "high"

string

stationIdEq
可选

门店ID
样例 : "string"

string

tagEq
可选

标签
样例 : "string"

string

tagHas
可选

标签包含……必须完全包含
样例 : [ "string" ]

< string > array

tagIn
可选

标签在……中，包含一个就行
样例 : [ "string" ]

< string > array

2.6. OrderCommentPaging

订单评价分页对象

名称 说明 类型

comments
可选

订单评价列表
样例 : [ "OrderComment" ]

< OrderComment > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.7. OrderExtraInfo

名称 说明 类型

delivery_content
可选

配送评价内容
样例 : "很好"

string

next_content
可选

追加评价内容
样例 : "很好"

string

next_image_urls
可选

配送评价图片
样例 : "url"

< string > array

next_time
可选

追加评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.8. UpdateReplyContentRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string