Merge branch 'master' of http://gitlab.fjmaimaimai.com/allied-creation/document

+version: v1
+kind: HttpApi
+metadata:
+  service: dividendsReturnedOrder
+  path: /dividends-returned-orders
+  endpoints: 
+  - method: createDividendsReturnedOrder
+    route:
+      post: /  
+  - method: updateDividendsReturnedOrder
+    route:
+      put: /{dividendsReturnedOrderId}
+  - method: getDividendsReturnedOrder
+    route:
+      get: /{dividendsReturnedOrderId}
+  - method: removeDividendsReturnedOrder
+    route:
+      delete: /{dividendsReturnedOrderId}
+  - method: searchDividendsReturnedOrder
+    route:
+      post: /search
+  - method: importDividendsReturnedOrder
+    route:
+      post: /import
+  - method: listDividendsReturnedOrder
+    route:
+      get: /
+    params:
+      - name: offset
+      - name: limit

+version: v1
+kind: Attribute
+metadata:
+  name: dividendsReturnedCustomerName
+  description: 退货客户名称
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: dividendsReturnedDate
+  description: 退货日期
+  type: 
+    primitive: datetime

+version: v1
+kind: Attribute
+metadata:
+  name: dividendsReturnedOrderNumber
+  description: 分红退货单号
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: dividendsReturnedOrderRefund
+  description: 退货金额
+  type: 
+    primitive: float64

 version: v1
 kind: Attribute
 metadata:
-  name: dividendsOriginalReturnedOrderNum
+  name: originalOrderNum
   description: 来源单号，源单号，订单号
   type: 
     primitive: string

+version: v1
+kind: Schema
+metadata:
+  name: dividendsReturnedOrder
+  description: 分红退货单实体
+  attributes:
+  - ref: dividendsReturnedOrderId
+    required: true
+  - ref: dividendsReturnedOrderNumber
+    description: 分红退货单号
+    required: true
+  - ref: dividendsReturnedOrderRefund
+    required: true
+  - ref: originalOrderNum
+    description: 源单号（原始订单号）
+    required: true
+  - ref: dividendsOrderNumber
+    description: 关联分红订单号
+    required: true
+  - ref: dividendsReturnedCustomerName
+    description: 退货客户姓名
+    required: true
+  - ref: dividendsReturnedDate
+    required: true
+  - ref: region
+    description: 退货区域
+    required: true
+  - ref: remarks
+    description: 备注
+    required: true
+  - ref: dividendStatus
+    required: true
+  - ref: dividendTime
+    required: true
+  - ref: organization
+    required: true
+  - ref: createdAt
+    required: true
+  - ref: deletedAt
+    required: true
+  - ref: updatedAt
+    required: true
+  - ref: operator
+    required: true
+  - ref: operateTime
+    required: true

@@ -2,7 +2,7 @@ version: v1
 kind: Schema
 metadata:
   name: orderGood
-  description: 订单产品领域实体
+  description: 订单产品领域实体（包括分红订单、分红退货单）
   attributes:
   - ref: orderGoodId
     required: true

+version: v1
+kind: Method
+metadata:
+  name: createDividendsReturnedOrder
+  type: command
+  description: 创建分红退货单服务
+  payload:
+  - ref: dividendsReturnedOrderRefund
+    required: true
+  - ref: dividendsReturnedCustomerName
+    required: true
+  - ref: originalOrderNum
+    required: true
+  - ref: remarks
+    required: true
+  - ref: dividendsReturnedDate
+    required: true
+  - name: regionName
+    description: 退货区域名称
+    type: 
+      primitive: string
+  - name: orderGoods
+    description: 订单产品列表
+    type:
+      array: orderGoods
+  result:
+  - name: dividendsReturnedOrder
+    type: 
+      schema: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: getDividendsReturnedOrder
+  type: query
+  description: 返回分红退货单服务
+  result:
+  - name: dividendsReturnedOrders
+    type: 
+      schema: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: importDividendsReturnedOrder
+  type: command
+  description: 导入分红退货单
+  payload:
+  - name: file
+    description: 导入文件
+    type: 
+      primitive: string
+  - name: where
+    description: 参数列表
+    type: 
+      primitive: string
+  result:
+  - name: dividendsReturnedOrder
+    type: 
+      schema: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: listDividendsReturnedOrder
+  type: query
+  description: 返回分红退货单服务列表
+  payload:
+  - ref: offset
+    required: true
+  - ref: limit
+    required: true
+  result:
+  - ref: count
+    required: true 
+  - name: dividendsReturnedOrders
+    type: 
+      array: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: removeDividendsReturnedOrder
+  type: command
+  description: 移除分红退货单服务
+  result:
+  - name: dividendsReturnedOrder
+    type: 
+      schema: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: searchDividendsReturnedOrder
+  type: query
+  description: 查找分红退货单
+  payload:
+  - ref: dividendsReturnedCustomerName
+    description: 退货客户姓名
+    required: false
+  - ref: dividendsReturnedOrderNumber
+    description: 分红退货单号
+    required: false
+  - ref: pageSize
+    required: false
+  - ref: pageNumber
+    required: false
+  result:
+  - name: dividendsReturnedOrders
+    type: 
+      array: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Method
+metadata:
+  name: updateDividendsReturnedOrder
+  type: command
+  description: 更新分红退货单服务
+  payload:
+  - ref: dividendsReturnedOrderRefund
+    required: true
+  - ref: dividendsReturnedCustomerName
+    required: true
+  - ref: originalOrderNum
+    required: true
+  - ref: remarks
+    required: true
+  - ref: dividendsReturnedDate
+    required: true
+  - name: regionName
+    description: 退货区域
+    type: 
+      primitive: string
+  - name: orderGoods
+    description: 订单产品列表
+    type:
+      array: orderGoods
+  result:
+  - name: dividendsReturnedOrder
+    type: 
+      schema: dividendsReturnedOrder
+    required: true

+version: v1
+kind: Service
+metadata:
+  name: dividendsReturnedOrder
+  description: 分红退货单服务