lwc-cloud-erp-rm-order API 接口文档

服务地址

地址	说明
http://localhost:8080	开发环境
https://api.leadwaycloud.com	测试环境

接口详情

PUT

/api/trade-reason/update/{id}

交易理由管理接口修改交易理由接口 OperationId: update

调用方法

PUT /api/trade-reason/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	交易理由ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateTradeReasonDTO com.leadwaycloud.rm.order.business.history.model.DTO.reason.UpdateTradeReasonDTO

名称	类型	必填	说明	示例
orderType	string	否	类型	"SALE"
reason	string	否	交易理由

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason	否

PUT

/api/order/reconcile-update-apply/{applyId}

订单对账业务接口修改对账申请接口 OperationId: updateReconcileApply

调用方法

PUT /api/order/reconcile-update-apply/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

Content-Type: application/json 必填: 是 类型: UpdateReconcileApplyDTO com.leadwaycloud.rm.order.business.reconcile.dto.UpdateReconcileApplyDTO

名称	类型	必填	说明	示例
otherCode	string	否	客户对账单号
receiveInvoiceAddress	string	否	收票地址	"xxx"
payMethod	string	否	付款方式	"xxx"
invoiceRequire	string	否	开票要求	"xxx"
contractOrder	boolean	否	是否合同订单	false
remark	string	否	备注	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/order/kds/change-status

订单KDS业务接口变更餐饮订单kds状态接口 OperationId: changeCateringOrderKdsStatus

调用方法

PUT /api/order/kds/change-status

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ChangeCateringOrderKdsStatusDTO com.leadwaycloud.rm.order.business.kds.dto.ChangeCateringOrderKdsStatusDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1858875177140284
newStatus	string	是	新的订单状态【 BE_PRODUCED : 待制作 PRODUCTION : 制作中 BE_PICKED : 待取餐 PICKED : 已取餐】	"PRODUCTION"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/order/delivery/update-express

订单发货业务接口变更发货单快递信息接口 OperationId: updateOrderDeliveryExpress

调用方法

PUT /api/order/delivery/update-express

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeliveryExpressUpdateDTO com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryExpressUpdateDTO

名称	类型	必填	说明	示例
deliveryId	integer(int64)	是	发货单ID	3
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	是	快递单号	"SF42524252343"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/order/delivery/update-code

订单发货业务接口变更发货单单号接口 OperationId: updateOrderDeliveryCode

调用方法

PUT /api/order/delivery/update-code

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeliveryCodeUpdateDTO com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryCodeUpdateDTO

名称	类型	必填	说明	示例
deliveryId	integer(int64)	是	发货单ID	3
code	string	否	发货单单号	"3"
reserved2	string	否	备用字段2(CRM发货单ID)
reserved3	string	否	备用字段3(SAP发货单号)
reserved4	string	否	备用字段4(SAP贷项凭证申请号)

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/v1/e-invoice/apply

电子发票专用接口通过订单号申请发票 OperationId: applyInvoice

调用方法

POST /api/v1/e-invoice/apply

参数

无

请求体

Content-Type: application/json 必填: 是 类型: InvoiceBuyerInfo com.leadwaycloud.rm.order.business.history.model.DTO.invoice.InvoiceBuyerInfo

名称	类型	必填
type	string	否
sendMethod	string	否
invoiceType	string	否
email	string	否
mobile	string	否
name	string	否
taxNumber	string	否
address	string	否
bank	string	否
account	string	否
phone	string	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/trade-reason/add

交易理由管理接口新增交易理由接口 OperationId: add

调用方法

POST /api/trade-reason/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddTradeReasonDTO com.leadwaycloud.rm.order.business.history.model.DTO.reason.AddTradeReasonDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
orderType	string	是	类型	"SALE"
reason	string	是	交易理由

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason	否

POST

/api/presale-order/create

预售单管理根据手持提交数据创建预购单 OperationId: create

调用方法

POST /api/presale-order/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddPresaleOrderCustomerInfoDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.AddPresaleOrderCustomerInfoDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
assetId	integer(int64)	是	设备ID	1
posNo	string	是	pos号	"1"
transNo	string	是	交易号	"1"
receipt	string	是	小票	"1"
note	string	否	备注	"1"
activeId	integer(int64)	是	活动ID	1
customerName	string	是	客户名称	"1"
phone	string	是	电话	"1"
backupPhone	string	否	备用电话	"1"
receiveMode	string	是	提货方式【 STORE_SELF : 门店自提 SUPPLY_POINT_SELF : 供应商自提 HOME_DELIVERY : 送货上门】	"STORE_SELF"
address	string	否	地址	"1"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/presale-order/confirm-delivery/{presaleOrderId}

预售单管理确认提货 OperationId: confirmDelivery

调用方法

POST /api/presale-order/confirm-delivery/{presaleOrderId}

参数

名称	位置	必填	类型	说明	示例
presaleOrderId	path	是	integer(int64)	预售单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/presale-order/cancel/{presaleOrderId}

预售单管理取消预购单 OperationId: cancel

调用方法

POST /api/presale-order/cancel/{presaleOrderId}

参数

名称	位置	必填	类型	说明	示例
presaleOrderId	path	是	integer(int64)	预售单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/presale-order/association-presale/{companyId}

预售单管理处理未关联预售单数据 OperationId: associationPresale

调用方法

POST /api/presale-order/association-presale/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	预售单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/presale-order/archive

预售单管理归档 OperationId: archive

调用方法

POST /api/presale-order/archive

参数

无

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/pos-order-journal/record-pos-order-journal

机台订单记录接口接收机台订单记录提交接口 OperationId: recordRmPosOrderJournal

调用方法

POST /api/pos-order-journal/record-pos-order-journal

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddRmPosOrderJournalDTO com.leadwaycloud.rm.order.business.history.model.DTO.pos.order.journal.AddRmPosOrderJournalDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	否	状态
orderInfo	string	否	交易信息
submitTime	string	否	提交时间	"2020-10-11 13:09:11"

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmPosOrderJournal com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPosOrderJournal	否

POST

/api/order/wrokflow/callback

订单审核业务接口 Workflow任务回调 OperationId: callback

调用方法

POST /api/order/wrokflow/callback

参数

无

请求体

Content-Type: application/json 必填: 是 类型: WorkflowDTO$CallbackDTO com.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$CallbackDTO

名称	类型	必填	说明
merchantId	integer(int64)	否	商户ID
submitBy	string	否	当前审批人/操作人
businessTypeKey	string	是	业务唯一key
businessId	string	是	业务ID
taskId	string	否	节点实例任务ID
serviceName	string	否	回调服务名
function	string	是	具体执行方法（自定义配置，可缺省）
businessData	object	否	业务数据（发起时业务、审批中特有变量并集）
instanceState	string	是	实例状态（pass, reject, terminate）
terminationRemark	string	否	消息
body	object	否	自定义配置数据

响应

状态码: 200 说明: OK Content-Type: */* 类型: WorkflowDTO$ReturnDTO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	WorkflowDTO$ReturnDTO	否

POST

/api/order/verify/result-hand-enter

订单审核业务接口审批结果手工录入 OperationId: verifyResultHandEnter

调用方法

POST /api/order/verify/result-hand-enter

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderVerifyResultDTO com.leadwaycloud.rm.order.business.verify.dto.OrderVerifyResultDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
businessKey	string	是	业务类型	"xxx"
pass	boolean	是	是否通过	false
notice	string	否	审核结果描述	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: WorkflowDTO$ReturnDTO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	WorkflowDTO$ReturnDTO	否

POST

/api/order/verify-refund/{id}

订单审核业务接口退货订单发起审核接口 OperationId: verifyRefundOrder

调用方法

POST /api/order/verify-refund/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/verify-exchange/{id}

订单审核业务接口换货订单发起审核接口 OperationId: verifyExchangeOrder

调用方法

POST /api/order/verify-exchange/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-sale-order/member

订单修改业务接口销售订单修改会员接口 OperationId: updateForSaleOrderMember

调用方法

POST /api/order/update-sale-order/member

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForSaleMemberResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleMemberResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID
customerId	integer(int64)	否	客户ID

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-sale-order/item

订单修改业务接口销售订单修改商品接口 OperationId: updateForSaleOrderItem

调用方法

POST /api/order/update-sale-order/item

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForSaleItemResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForSaleItemResDTO$OrderUpdateForSaleItemDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-sale-order/item-qty

订单修改业务接口销售订单修改商品数量接口 OperationId: updateForSaleOrderItemQty

调用方法

POST /api/order/update-sale-order/item-qty

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForSaleItemQtyResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemQtyResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
orderItemId	integer(int64)	是	订单商品ID	1
qty	integer(int32)	是	订单商品数量	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-sale-order/item-delivery

订单修改业务接口销售订单修改商品发货方式接口 OperationId: updateForSaleOrderItemDelivery

调用方法

POST /api/order/update-sale-order/item-delivery

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForSaleItemDeliveryResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemDeliveryResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
itemDeliveryList	OrderItemDeliveryForSaleDTO[]	是	订单商品第三方配送

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-sale-order/delivery-mode

订单修改业务接口销售订单修改配送方式接口 OperationId: updateForSaleOrderDeliveryMode

调用方法

POST /api/order/update-sale-order/delivery-mode

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForSaleDeliveryModeResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleDeliveryModeResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
acceptSplittingDelivery	boolean	否	是否接受拆单发货
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-refund-order/item

订单修改业务接口退货订单修改商品接口 OperationId: updateForRefundOrder

调用方法

POST /api/order/update-refund-order/item

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForRefundItemResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForRefundItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForRefundItemResDTO$OrderUpdateForRefundItemDTO	否
orderItemList	OrderCreateItemForRefundDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-order/merchant-note

订单修改业务接口订单追加订单商户备注接口 OperationId: updateForSaleOrder

调用方法

POST /api/order/update-order/merchant-note

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateAppendMerchantNoteResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateAppendMerchantNoteResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
note	string	是	备注	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/update-exchange-order/item

订单修改业务接口换货订单修改商品接口 OperationId: updateForExchangeOrder

调用方法

POST /api/order/update-exchange-order/item

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderUpdateForExchangeItemResDTO com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForExchangeItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForExchangeItemResDTO$OrderUpdateForExchangeItemDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/search-data/cache-async

订单缓存业务接口订单搜索数据缓存接口 OperationId: asyncCacheOrderSearchData

优先取订单集合

调用方法

POST /api/order/search-data/cache-async

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CacheOrderSearchDataReqDTO com.leadwaycloud.rm.common.business.order.mdoel.dto.CacheOrderSearchDataReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	否	订单集合
companyId	integer(int64)	否	公司ID
startDate	string	否	交易开始日期	"2020-10-10"
endDate	string	否	交易结束日期	"2020-10-10"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/sale-order/unlock-item-stock/{orderId}

交易订单处理接口解锁销售订单商品库存接口 OperationId: unlockSaleOrderItemStock

付款失败调用进行订单库存解锁

调用方法

POST /api/order/sale-order/unlock-item-stock/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/sale-order/refund-inspection/{orderId}

交易订单处理接口销售订单退货商品校验接口 OperationId: refundInspection

调用方法

POST /api/order/sale-order/refund-inspection/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

POST

/api/order/sale-order/lock-item-stock/{orderId}

交易订单处理接口锁定销售订单商品库存接口 OperationId: lockSaleOrderItemStock

付款前调用进行订单库存锁定.返回商品数据则表示某个商品库存不足,订单库存锁定失败

调用方法

POST /api/order/sale-order/lock-item-stock/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderItem com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderItem

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderItem[]	否	返回数据

POST

/api/order/refund-verify/{orderId}

交易订单处理接口退货订单审核接口 OperationId: refundOrderVerify

调用方法

POST /api/order/refund-verify/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

Content-Type: application/json 必填: 是 类型: RefundOrderVerifyDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.RefundOrderVerifyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否通过	false
notice	string	否	原因	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/reconcile-void-apply/{applyId}

订单对账业务接口作废对账申请接口 OperationId: voidReconcileApply

调用方法

POST /api/order/reconcile-void-apply/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/reconcile-customer

订单对账业务接口搜索需要对账的客户接口 OperationId: generateCustomReconcile

调用方法

POST /api/order/reconcile-customer

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SearchReconcileCustomerDTO com.leadwaycloud.rm.order.business.reconcile.dto.SearchReconcileCustomerDTO

名称	类型	必填	说明
companyId	integer(int64)	是	公司ID
year	integer(int32)	是	年
month	integer(int32)	是	月

响应

状态码: 200 说明: OK Content-Type: */* 类型: ReconcileCustomerVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileCustomerVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileCustomerVO[]	否	返回数据

POST

/api/order/reconcile-custom-confirm-apply/{applyId}

订单对账业务接口客户确认对账申请接口 OperationId: customConfirmReconcileApply

调用方法

POST /api/order/reconcile-custom-confirm-apply/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/reconcile-create-apply

订单对账业务接口生成客户对账单申请接口 OperationId: generateCustomReconcile_1

调用方法

POST /api/order/reconcile-create-apply

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GenerateReconcileApplyDTO com.leadwaycloud.rm.order.business.reconcile.dto.GenerateReconcileApplyDTO

名称	类型	必填	说明
customerId	integer(int64)	是	客户ID
year	integer(int32)	是	年
month	integer(int32)	是	月

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/reconcile-confirm-apply/{applyId}

订单对账业务接口确认对账申请接口 OperationId: confirmReconcileApply

调用方法

POST /api/order/reconcile-confirm-apply/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/reconcile-add-attachment

订单对账业务接口对账申请附件上传接口 OperationId: addReconcileAttachment

调用方法

POST /api/order/reconcile-add-attachment

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddReconcileAttachmentDTO com.leadwaycloud.rm.order.business.reconcile.dto.AddReconcileAttachmentDTO

名称	类型	必填	说明	示例
applyId	integer(int64)	是	对账申请ID
attachmentList	AttachmentBO[]	否	附件集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/receive

交易订单处理接口订单收货接口 OperationId: orderReceive

调用方法

POST /api/order/receive

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderReceiveDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderReceiveDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	否	订单ID(三选一)	1
orderCode	string	否	订单编号(三选一)	"1"
orderDeliveryId	integer(int64)	否	订单配送ID(三选一),如果不传则默认对交易订单的所有订单配送进行收货操作	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-sale/{id}

订单收货业务接口销售订单根据订单ID收货接口 OperationId: saleOrderReceiveByOrderId

调用方法

POST /api/order/receive-sale/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-sale/delivery/{deliveryId}

订单收货业务接口销售订单根据配送单ID收货接口 OperationId: saleOrderReceiveByOrderDeliveryId

调用方法

POST /api/order/receive-sale/delivery/{deliveryId}

参数

名称	位置	必填	类型	说明	示例
deliveryId	path	是	integer(int64)

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-sale/code/{code}

订单收货业务接口销售订单根据订单编号收货接口 OperationId: saleOrderReceiveByOrderCode

调用方法

POST /api/order/receive-sale/code/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是	string	订单编号	"xxx"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-refund/{id}

订单收货业务接口退货订单根据订单ID收货接口 OperationId: refundOrderReceiveByOrderId

调用方法

POST /api/order/receive-refund/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-refund/delivery/{deliveryId}

订单收货业务接口退货订单根据配送单ID收货接口 OperationId: refundOrderReceiveByOrderDeliveryId

调用方法

POST /api/order/receive-refund/delivery/{deliveryId}

参数

名称	位置	必填	类型	说明	示例
deliveryId	path	是	integer(int64)

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/receive-refund/code/{code}

订单收货业务接口退货订单根据订单编号收货接口 OperationId: refundOrderReceiveByOrderCode

调用方法

POST /api/order/receive-refund/code/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是	string	订单编号	"xxx"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/push/order-delivery-data/{deliveryId}

订单推送业务接口推送订单发货单数据接口 OperationId: pushOrderDeliveryData

调用方法

POST /api/order/push/order-delivery-data/{deliveryId}

参数

名称	位置	必填	类型	说明	示例
deliveryId	path	是	integer(int64)	发货单ID	1812404461173778

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/push/order-data

订单推送业务接口推送订单数据接口 OperationId: pushOrderData

调用方法

POST /api/order/push/order-data

参数

无

请求体

Content-Type: application/json 必填: 是 类型: PushOrderDTO com.leadwaycloud.rm.order.business.push.dto.PushOrderDTO

名称	类型	必填	说明	示例
orderPushType	string	是	订单推送类型【 CREATE : 创建 CONFIRM : 确认 COMMIT : 提交 CANCEL : 取消 DELETE : 删除 PAYMENTED : 支付/退款完成 DELIVERY : 发货 RECEIVE : 收货 INVOICE : 开票 UPDATE_DELIVERY_MODEL : 修改配送信息 UPDATE_ITEM_DELIVERY_METHOD : 修改商品发货方式信息 REFUND_VERIFY_PASS : 退货订单审核通过 EXCHANGE_CONVERT_ORDER : 换货订单转换订单】	"CREATE"
orderId	integer(int64)	是	订单ID	1812404461173774

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/print-sale-order-info/{id}

订单打印业务接口获取销售订单打印数据接口 OperationId: getSaleOrderPrintData

调用方法

POST /api/order/print-sale-order-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: SaleOrderPrintVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SaleOrderPrintVO	否

POST

/api/order/print-refund-order-list-info

订单打印业务接口获取退货清单打印数据接口 OperationId: getRefundOrderListPrintData

调用方法

POST /api/order/print-refund-order-list-info

参数

无

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: RefundOrderListPrintVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.RefundOrderListPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RefundOrderListPrintVO	否

POST

/api/order/print-refund-order-info/{id}

订单打印业务接口获取退货订单打印数据接口 OperationId: getRefundOrderPrintData

调用方法

POST /api/order/print-refund-order-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RefundOrderPrintVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RefundOrderPrintVO	否

POST

/api/order/paymented-sale

订单支付完成业务接口销售订单支付完成接口 OperationId: saleOrderFinish

调用方法

POST /api/order/paymented-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderPaymentedReqDTO com.leadwaycloud.rm.order.business.paymented.dto.OrderPaymentedReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/paymented-refund

订单支付完成业务接口退货订单支付完成接口 OperationId: refundOrderFinish

调用方法

POST /api/order/paymented-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderPaymentedReqDTO com.leadwaycloud.rm.order.business.paymented.dto.OrderPaymentedReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/manual/process-order-convert

交易订单处理接口手工处理订单库存扣减接口 OperationId: processOrderConvert

建议每次处理不超过100条

调用方法

POST /api/order/manual/process-order-convert

参数

无

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/kds/push-oil/{orderId}

订单KDS业务接口推送kds油品订单 OperationId: pushOilOrderToKds

调用方法

POST /api/order/kds/push-oil/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1075150827903475

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/kds/push-catering/{merchantId}/{companyId}

订单KDS业务接口推送kds餐饮订单 OperationId: pushCateringOrderToKds

调用方法

POST /api/order/kds/push-catering/{merchantId}/{companyId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	574533689957248
companyId	path	是	integer(int64)	公司ID	574533689957252

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/kds/push/{merchantId}/{companyId}

订单KDS业务接口推送kds餐饮订单 OperationId: pushCateringOrderToKds_1

调用方法

POST /api/order/kds/push/{merchantId}/{companyId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	574533689957248
companyId	path	是	integer(int64)	公司ID	574533689957252

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/invoice-sale-order

订单开票业务接口销售订单开票申请接口 OperationId: saleOrderInvoice

调用方法

POST /api/order/invoice-sale-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderInvoiceForSaleOrderReqDTO com.leadwaycloud.rm.order.business.invoice.dto.OrderInvoiceForSaleOrderReqDTO

名称	类型	必填	说明	示例
invoiceTitleId	integer(int64)	是	发票抬头ID	1
invoiceAddressId	integer(int64)	否	收票地址ID	1
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/invoice-reconcile

订单开票业务接口对账单开票申请接口 OperationId: reconcileInvoice

调用方法

POST /api/order/invoice-reconcile

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderInvoiceForReconcileReqDTO com.leadwaycloud.rm.order.business.invoice.dto.OrderInvoiceForReconcileReqDTO

名称	类型	必填	说明	示例
invoiceTitleId	integer(int64)	是	发票抬头ID	1
invoiceAddressId	integer(int64)	否	收票地址ID	1
applyId	integer(int64)	是	对账单ID集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/history/cache-async

订单缓存业务接口历史订单缓存接口 OperationId: asyncCacheHistoryOrder

调用方法

POST /api/order/history/cache-async

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CacheOrderInfoReqDTO com.leadwaycloud.rm.common.business.order.mdoel.dto.CacheOrderInfoReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	订单集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/finish/{orderId}

交易订单处理接口订单交易完成接口 OperationId: orderFinish

调用方法

POST /api/order/finish/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/finish/{companyId}/{orderCode}

交易订单处理接口订单交易完成接口 OperationId: orderFinish_1

调用方法

POST /api/order/finish/{companyId}/{orderCode}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
orderCode	path	是	string	订单编号	"xxx"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/extend/exchange-convert-sale/{id}

订单转换业务接口换货单生成销售单(草稿)接口 OperationId: exchangeConvetSale

调用方法

POST /api/order/extend/exchange-convert-sale/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	换货订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/extend/exchange-convert-refund/{id}

订单转换业务接口换货单生成退货单(确认)接口 OperationId: exchangeConvetRefund

调用方法

POST /api/order/extend/exchange-convert-refund/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	换货订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/download

订单下载业务接口订单下载接口 OperationId: orderDownload

调用方法

POST /api/order/download

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDownloadRequestDTO com.leadwaycloud.rm.order.business.download.dto.OrderDownloadRequestDTO

无

响应

状态码: 200 说明: OK

无

POST

/api/order/delivery

交易订单处理接口订单发货接口 OperationId: orderDelivery

调用方法

POST /api/order/delivery

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeliveryDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderDeliveryDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	OrderDeliveryItemDTO[]	否	订单配送包含的商品
stockMoveId	integer(int64)	否	出库单ID	1
fare	number(double)	否	运费	0

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delivery/online-self-order/batch

交易订单处理接口线上自提订单批量发货接口 OperationId: onlineSelfOrderAllItemBatchDelivery

调用方法

POST /api/order/delivery/online-self-order/batch

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OnlineSelfOrderBatchDeliveryDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.OnlineSelfOrderBatchDeliveryDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	销售订单ID集合	[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delivery-sale

订单发货业务接口销售订单发货接口 OperationId: saleOrderDelivery

调用方法

POST /api/order/delivery-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeliveryReqDTO com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryReqDTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	OrderDeliveryItemDTO	否
stockMoveId	integer(int64)	否	出库单ID	1
unStockDelivery	boolean	否	无库存发货	false
remark	string	否	备注

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delivery-sale/self/batch

订单发货业务接口自提销售订单批量发货接口 OperationId: onlineSelfSaleOrderAllItemBatchDelivery

调用方法

POST /api/order/delivery-sale/self/batch

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderFullDeliveryReqDTO com.leadwaycloud.rm.order.business.delivery.dto.OrderFullDeliveryReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	销售订单ID集合	[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delivery-refund

订单发货业务接口退货订单发货接口 OperationId: refundOrderDelivery

调用方法

POST /api/order/delivery-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeliveryReqDTO com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryReqDTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	OrderDeliveryItemDTO	否
stockMoveId	integer(int64)	否	出库单ID	1
unStockDelivery	boolean	否	无库存发货	false
remark	string	否	备注

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delete-sale

订单删除业务接口销售订单删除接口 OperationId: deleteSaleOrder

调用方法

POST /api/order/delete-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeleteReqDTO com.leadwaycloud.rm.order.business.delete.dto.OrderDeleteReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delete-refund

订单删除业务接口退货订单删除接口 OperationId: deleteRefundOrder

调用方法

POST /api/order/delete-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeleteReqDTO com.leadwaycloud.rm.order.business.delete.dto.OrderDeleteReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/delete-exchange

订单删除业务接口换货订单删除接口 OperationId: deleteExchangeOrder

调用方法

POST /api/order/delete-exchange

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDeleteReqDTO com.leadwaycloud.rm.order.business.delete.dto.OrderDeleteReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/create

交易订单处理接口创建订单接口 OperationId: createOrder

如果paid=true,接口会自动完成订单,无需调用订单交易完成接口

调用方法

POST /api/order/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
type	string	是	交易类型,rm_order_type表code栏位	"SALE"
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"STORE_POS"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
paid	boolean	否	是否已经支付	false
cancel	boolean	否	是否已经取消	false
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderHandmadeDiscountList	OrderHandmadeDiscountDTO[]	否	订单手工折扣
orderItemList	OrderItemDTO[]	否	订单商品
orderDeliveryMode	OrderDeliveryModeDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
associateOrderCode	string	否	关联订单单号,退款订单时提供
saveTime	integer(int32)	否	订单保留时间(小时),线上订单提供该数据时，会根据下单时间+saveTime来确定订单自动过期时间，如果没有传则默认12小时	1
thirdPartyId	integer(int64)	否	会员编号	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/order/create-sale/erp

订单创建业务接口创建销售订单(ERP)接口 OperationId: createSaleOrder

调用方法

POST /api/order/create-sale/erp

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForSaleReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForSaleReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderHandmadeDiscList	OrderCreateHandmadeDiscForSaleDTO[]	否	订单手工折扣
orderPos	OrderCreatePosForSaleDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/create-refund/erp

订单创建业务接口创建退货订单(ERP)接口 OperationId: createReufundOrder

调用方法

POST /api/order/create-refund/erp

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForRefundReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForRefundReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/create-other/erp

订单创建业务接口创建其他订单(ERP)接口 OperationId: createOtherOrder

调用方法

POST /api/order/create-other/erp

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForOtherReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForOtherReqDTO

名称	类型	必填	说明
order	OrderCreateForOtherDTO	是
orderItemList	OrderCreateItemForOtherDTO[]	否	订单商品
orderPos	OrderCreatePosForOtherDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/create-exchagne/erp

订单创建业务接口创建换货订单(ERP)接口 OperationId: createExchangeOrder

调用方法

POST /api/order/create-exchagne/erp

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForExchangeReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForExchangeReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/confirm-sale

订单确认业务接口销售订单确认接口 OperationId: confirmOrder

调用方法

POST /api/order/confirm-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderConfirmReqDTO com.leadwaycloud.rm.order.business.confirm.dto.OrderConfirmReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1
customerNote	string	否	客户备注	"xxx"
merchantNote	string	否	商户备注	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/confirm-refund

订单确认业务接口退货订单确认接口 OperationId: confirmRefundOrder

调用方法

POST /api/order/confirm-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderConfirmReqDTO com.leadwaycloud.rm.order.business.confirm.dto.OrderConfirmReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1
customerNote	string	否	客户备注	"xxx"
merchantNote	string	否	商户备注	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/confirm-exchange

订单确认业务接口换货订单确认接口 OperationId: confirmExchangeOrder

调用方法

POST /api/order/confirm-exchange

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderConfirmReqDTO com.leadwaycloud.rm.order.business.confirm.dto.OrderConfirmReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1
customerNote	string	否	客户备注	"xxx"
merchantNote	string	否	商户备注	"xxx"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/commit-sale/store

订单提交业务接口提交销售订单(门店)接口 OperationId: commitSaleOrder

调用方法

POST /api/order/commit-sale/store

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitSaleForStoreReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForStoreReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderHandmadeDiscList	OrderCreateHandmadeDiscForSaleDTO[]	否	订单手工折扣
orderPos	OrderCreatePosForSaleDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-sale/mobile

订单提交业务接口提交销售订单(移动端)接口 OperationId: commitSaleOrder_1

调用方法

POST /api/order/commit-sale/mobile

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitSaleForMobileReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-sale/mall

订单提交业务接口提交销售订单(商城)接口 OperationId: commitSaleOrder_2

调用方法

POST /api/order/commit-sale/mall

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitSaleForMallReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-refund/store

订单提交业务接口提交退货订单(门店)接口 OperationId: createRefundOrder

调用方法

POST /api/order/commit-refund/store

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitRefundForStoreReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForStoreReqDTO

名称	类型	必填	说明	示例
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-refund/mobile

订单提交业务接口提交退货订单(移动端)接口 OperationId: createRefundOrder_1

调用方法

POST /api/order/commit-refund/mobile

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitRefundForMobileReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-refund/mall

订单提交业务接口提交退货订单(商城)接口 OperationId: createRefundOrder_2

调用方法

POST /api/order/commit-refund/mall

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitRefundForMallReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-exchange/mobile

订单提交业务接口提交换货订单(移动端)接口 OperationId: createRefundOrder_3

调用方法

POST /api/order/commit-exchange/mobile

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitExchangeForMobileReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitExchangeForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/commit-exchange/mall

订单提交业务接口提交换货订单(商城)接口 OperationId: createRefundOrder_4

调用方法

POST /api/order/commit-exchange/mall

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCommitExchangeForMallReqDTO com.leadwaycloud.rm.order.business.commit.dto.OrderCommitExchangeForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

POST

/api/order/cancel/{orderId}

交易订单处理接口取消订单接口 OperationId: cancelOrder

调用方法

POST /api/order/cancel/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/cancel/{companyId}/{orderCode}

交易订单处理接口取消订单接口 OperationId: cancelOrder_1

调用方法

POST /api/order/cancel/{companyId}/{orderCode}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
orderCode	path	是	string	订单编号	"xxx"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/cancel-sale

订单取消业务接口销售订单取消接口 OperationId: cancelSaleOrder

调用方法

POST /api/order/cancel-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCancelForSaleReqDTO com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForSaleReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/cancel-refund

订单取消业务接口退货订单取消接口 OperationId: cancelRefundOrder

调用方法

POST /api/order/cancel-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCancelForRefundReqDTO com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForRefundReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/cancel-exchange

订单取消业务接口换货订单取消接口 OperationId: cancelExchangeOrder

调用方法

POST /api/order/cancel-exchange

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCancelForExchangeReqDTO com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForExchangeReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order/calc-sale

订单计算业务接口计算销售订单接口 OperationId: createSaleOrder_1

调用方法

POST /api/order/calc-sale

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForSaleReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForSaleReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderHandmadeDiscList	OrderCreateHandmadeDiscForSaleDTO[]	否	订单手工折扣
orderPos	OrderCreatePosForSaleDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderAmountVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderAmountVO	否

POST

/api/order/calc-refund

订单计算业务接口计算退货订单接口 OperationId: createRefundOrder_5

调用方法

POST /api/order/calc-refund

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForRefundReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForRefundReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderAmountVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderAmountVO	否

POST

/api/order/calc-exchange

订单计算业务接口计算换货订单接口 OperationId: createExchangeOrder_1

调用方法

POST /api/order/calc-exchange

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OrderCreateForExchangeReqDTO com.leadwaycloud.rm.order.business.create.dto.OrderCreateForExchangeReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderAmountVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderAmountVO	否

POST

/api/order/cache-async

订单缓存业务接口订单缓存接口 OperationId: asyncCacheOrder

调用方法

POST /api/order/cache-async

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CacheOrderInfoReqDTO com.leadwaycloud.rm.common.business.order.mdoel.dto.CacheOrderInfoReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	订单集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order/add-merchant-note/{orderId}

交易订单处理接口订单添加商户备注接口 OperationId: addMerchantNote

调用方法

POST /api/order/add-merchant-note/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

Content-Type: application/json 必填: 是 类型: OrderMerchantNoteBO com.leadwaycloud.rm.common.business.order.mdoel.bo.OrderMerchantNoteBO

名称	类型	必填	说明	示例
note	string	是	参数名称	"折扣名称"
user	string	是	备注人	"张三"
time	string	否	备注时间	"2020-10-11 13:09:11"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order-search/surplus-after-server-quota-info/{id}

订单扩展搜索业务接口订单商品剩余可售后额度查询接口 OperationId: queryOrderSurplusRefundItemQuota

调用方法

POST /api/order-search/surplus-after-server-quota-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ItemServiceQuotaVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.search.vo.ItemServiceQuotaVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ItemServiceQuotaVO[]	否	返回数据

POST

/api/order-search/delivery/surplus-quota-info/{id}

订单扩展搜索业务接口订单商品剩余可发货数量/重量查询接口 OperationId: queryOrderSurplusDeliveryItemQuota

调用方法

POST /api/order-search/delivery/surplus-quota-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ItemDeliveryQuotaVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.search.vo.ItemDeliveryQuotaVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ItemDeliveryQuotaVO[]	否	返回数据

POST

/api/order-expand/sale-order/unlock-item-stock/{orderId}

交易订单扩展接口解锁销售订单商品库存接口 OperationId: unlockSaleOrderItemStock_1

付款失败调用进行订单库存解锁

调用方法

POST /api/order-expand/sale-order/unlock-item-stock/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/order-expand/sale-order/refund-inspection/{orderId}

交易订单扩展接口销售订单退货商品校验接口 OperationId: refundInspection_1

调用方法

POST /api/order-expand/sale-order/refund-inspection/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

POST

/api/order-expand/sale-order/lock-item-stock/{orderId}

交易订单扩展接口锁定销售订单商品库存接口 OperationId: lockSaleOrderItemStock_1

付款前调用进行订单库存锁定.返回商品数据则表示某个商品库存不足,订单库存锁定失败

调用方法

POST /api/order-expand/sale-order/lock-item-stock/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderItem com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderItem

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderItem[]	否	返回数据

POST

/api/order-expand/manual/process-order-delivery-convert

交易订单扩展接口手工处理发货单库存扣减接口 OperationId: processOrderDeliveryConvert

建议每次处理不超过100条

调用方法

POST /api/order-expand/manual/process-order-delivery-convert

参数

无

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order-expand/manual/process-order-convert

交易订单扩展接口手工处理订单库存扣减接口 OperationId: processOrderConvert_1

建议每次处理不超过100条

调用方法

POST /api/order-expand/manual/process-order-convert

参数

无

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/order-expand/add-merchant-note/{orderId}

交易订单扩展接口订单添加商户备注接口 OperationId: addMerchantNote_1

调用方法

POST /api/order-expand/add-merchant-note/{orderId}

参数

名称	位置	必填	类型	说明	示例
orderId	path	是	integer(int64)	订单ID	1

请求体

Content-Type: application/json 必填: 是 类型: OrderMerchantNoteBO com.leadwaycloud.rm.common.business.order.mdoel.bo.OrderMerchantNoteBO

名称	类型	必填	说明	示例
note	string	是	参数名称	"折扣名称"
user	string	是	备注人	"张三"
time	string	否	备注时间	"2020-10-11 13:09:11"

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/sale-order/unlock-item-stock

线上订单管理接口解锁销售订单商品库存接口 OperationId: unlockSaleOrderItemStock_2

付款失败调用进行订单库存解锁

调用方法

POST /api/online-order/sale-order/unlock-item-stock

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UnlockOrderStockDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.UnlockOrderStockDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	公司ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/sale-order/submit

线上订单管理接口提交销售订单接口 OperationId: saleOrderSubmit

调用方法

POST /api/online-order/sale-order/submit

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitMallSaleOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.SubmitMallSaleOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"WECHAT_MINI_APPS"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	是
orderItemList	OrderItemDTO[]	是	订单商品
orderDeliveryMode	OrderDeliveryModeDTO	是
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
saveTime	integer(int32)	否	订单保留时间(小时)。线上订单提供该数据时，会根据下单时间+saveTime来确定订单自动过期时间，如果没有传则默认12小时	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/online-order/sale-order/refund-apply

线上订单管理接口销售订单退货申请接口 OperationId: saleOrderReturnApply

调用方法

POST /api/online-order/sale-order/refund-apply

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderReturnApplyDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReturnApplyDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	销售订单ID	1
orderDeliveryItemList	MallOrderDeliveryItemDTO[]	否	订单配送包含的商品
reason	string	否	交易理由

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/online-order/sale-order/receive

线上订单管理接口销售订单收货接口 OperationId: saleOrderReceive

调用方法

POST /api/online-order/sale-order/receive

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderReceiveDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReceiveDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	否	订单ID(参数三选一)	1
orderCode	string	否	订单编号(参数三选一)	"1"
orderDeliveryId	integer(int64)	否	订单配送ID(参数二选一,如果没有传则对订单所有配送记录进行收货)	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/sale-order/payment-finish

线上订单管理接口销售订单付款完成接口 OperationId: saleOrderPaymentFinish

销售订单调用后变更付款状态/退货订单调用后变更退款状态

调用方法

POST /api/online-order/sale-order/payment-finish

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderPaymentFinishDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderPaymentFinishDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/sale-order/lock-item-stock

线上订单管理接口锁定销售订单商品库存接口 OperationId: lockSaleOrderItemStock_2

付款前调用进行订单库存锁定.返回商品数据则表示某个商品库存不足,订单库存锁定失败

调用方法

POST /api/online-order/sale-order/lock-item-stock

参数

无

请求体

Content-Type: application/json 必填: 是 类型: LockOrderStockDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.LockOrderStockDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderItem com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderItem

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderItem[]	否	返回数据

POST

/api/online-order/sale-order/delivery

线上订单管理接口销售订单发货接口 OperationId: saleOrderDelivery_1

调用方法

POST /api/online-order/sale-order/delivery

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderDeliveryDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderDeliveryDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	MallOrderDeliveryItemDTO[]	否	订单配送包含的商品
stockMoveId	integer(int64)	否	出库单ID	1
unStockDelivery	boolean	否	无库存发货	false

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/refund-order/submit

线上订单管理接口提交退货订单接口 OperationId: refundOrderSubmit

调用方法

POST /api/online-order/refund-order/submit

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderReturnDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReturnDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1
self	boolean	是	是否自退	false
expressId	integer(int64)	否	合作的快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
fare	number(double)	否	运费	0
selfPickupDate	string	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/online-order/refund-order/return-finish

线上订单管理接口退货订单退款完成接口 OperationId: refundOrderReturnFinish

销售订单调用后变更付款状态/退货订单调用后变更退款状态

调用方法

POST /api/online-order/refund-order/return-finish

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderRefundFinishDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderRefundFinishDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/refund-order/receive

线上订单管理接口退货订单收货接口 OperationId: refundOrderReceive

调用方法

POST /api/online-order/refund-order/receive

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderReceiveDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReceiveDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	否	订单ID(参数三选一)	1
orderCode	string	否	订单编号(参数三选一)	"1"
orderDeliveryId	integer(int64)	否	订单配送ID(参数二选一,如果没有传则对订单所有配送记录进行收货)	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/refund-order/apply-process

线上订单管理接口订单退货申请处理接口 OperationId: refundOrderApplyProcess

调用方法

POST /api/online-order/refund-order/apply-process

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallReturnApplyProcessDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallReturnApplyProcessDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1
pass	boolean	是	是否通过	false

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/online-order/add-merchant-note

线上订单管理接口订单添加商户备注接口 OperationId: addOrderMerchantNote

调用方法

POST /api/online-order/add-merchant-note

参数

无

请求体

Content-Type: application/json 必填: 是 类型: MallOrderAddMerchantNoteDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderAddMerchantNoteDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
merchantNote	OrderMerchantNoteBO	是

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/offline-order/submit-sale-order

线下订单管理接口提交销售订单接口 OperationId: submitSaleOrder

调用方法

POST /api/offline-order/submit-sale-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreSaleOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreSaleOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO[]	是	订单商品
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
orderHandmadeDiscountList	OrderHandmadeDiscountDTO[]	否	订单手工折扣

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/offline-order/submit-refund-order

线下订单管理接口提交退款订单接口 OperationId: submitRefundOrder

调用方法

POST /api/offline-order/submit-refund-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreRefundOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreRefundOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
orderAmount	number(double)	是	订单金额	100
associateOrderCode	string	是	关联订单单号
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

POST

/api/offline-order/submit-other-type-order

线下订单管理接口提交其他类型订单接口 OperationId: submitOtherTypeOrder

调用方法

POST /api/offline-order/submit-other-type-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreOtherTypeOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreOtherTypeOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
type	string	是	类型	"SALE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	优惠金额	0
orderAmount	number(double)	是	订单金额	100
associateOrderCode	string	否	关联订单单号
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/offline-order/submit-order

线下订单管理接口订单提交接口 OperationId: submitOrder

调用方法

POST /api/offline-order/submit-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
type	string	是	交易类型	"SALE"
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
paid	string	否	是否已经支付	"false"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO[]	否	订单商品
customerNote	string	否	客户备注
reason	string	否	交易理由
associateOrderCode	string	否	关联订单单号(退款交易时提供)
orderRestaurant	OrderRestaurantDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/offline-order/refund-finish/submit-refund-order

线下订单管理接口退款完成提交退款订单接口 OperationId: paymentFinishSubmitRefundOrder

提交退款订单并通知退款完成

调用方法

POST /api/offline-order/refund-finish/submit-refund-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreRefundOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreRefundOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
orderAmount	number(double)	是	订单金额	100
associateOrderCode	string	是	关联订单单号
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/offline-order/payment-finish/submit-sale-order

线下订单管理接口付款完成提交销售订单接口 OperationId: paymentFinishSubmitSaleOrder

提交销售订单并通知支付完成

调用方法

POST /api/offline-order/payment-finish/submit-sale-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SubmitStoreSaleOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreSaleOrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO[]	是	订单商品
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
orderHandmadeDiscountList	OrderHandmadeDiscountDTO[]	否	订单手工折扣

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/offline-order/order-payment-finish

线下订单管理接口订单付款完成接口 OperationId: paymentFinish

销售订单调用后变更付款状态/退款订单调用后变更退款状态

调用方法

POST /api/offline-order/order-payment-finish

参数

无

请求体

Content-Type: application/json 必填: 是 类型: StoreOrderPaymentFinishDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.StoreOrderPaymentFinishDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/v1/e-invoice/query

电子发票专用接口通过订单号查询发票 OperationId: queryInvoice

调用方法

GET /api/v1/e-invoice/query

参数

名称	位置	必填	类型	说明	示例
hashCode	query	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/trade-reason/query/{id}

交易理由管理接口查询交易理由(ID)接口 OperationId: query

调用方法

GET /api/trade-reason/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason	否

GET

/api/trade-reason/query-list/{merchantId}

交易理由管理接口查询交易理由(列表[所有])接口 OperationId: queryList

调用方法

GET /api/trade-reason/query-list/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason[]	否	返回数据

GET

/api/trade-reason/query-list/{merchantId}/{orderType}

交易理由管理接口查询交易理由(列表[订单类型])接口 OperationId: queryList_1

调用方法

GET /api/trade-reason/query-list/{merchantId}/{orderType}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
orderType	path	是	string	订单类型	"SALE"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason[]	否	返回数据

GET

/api/query/{merchantId}/{code}

订单查询接口查询订单(单号)接口 OperationId: query_1

调用方法

GET /api/query/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

GET

/api/query/{id}

订单查询接口查询订单(ID)接口 OperationId: query_2

调用方法

GET /api/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

GET

/api/query/sale-order/surplus-refund-item-detail/{merchantId}/{code}

订单查询接口查询销售订单商品剩余可退货数量/重量接口 OperationId: querySaleOrderSurplusRefundItemDetail

调用方法

GET /api/query/sale-order/surplus-refund-item-detail/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Double com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Double

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/query/query/item-surplus-delivery-info/{merchantId}/{code}

订单查询接口查询订单商品剩余可发货数量/重量接口 OperationId: queryOrderSurplusDeliveryItemQuota_1

调用方法

GET /api/query/query/item-surplus-delivery-info/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Double com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Double

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/query/pickup-outlets-order-delivery/{selfPickupOutletsId}/{takeCode}

订单查询接口根据提货码查询属于提货点的订单未收货的配送信息接口 OperationId: queryPickupOutletsOrderDeliveryUnReceiveByTakeCode

只查询一年内匹配提货码的订单配送信息

调用方法

GET /api/query/pickup-outlets-order-delivery/{selfPickupOutletsId}/{takeCode}

参数

名称	位置	必填	类型	说明	示例
selfPickupOutletsId	path	是	integer(int64)	自提点ID	1
takeCode	path	是	string	提货码	"098969"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderDelivery com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery[]	否	返回数据

GET

/api/query/page

订单查询接口查询订单(分页)接口 OperationId: query_3

调用方法

GET /api/query/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
code	query	否	string	编号	"0989681627412313123"
type	query	否	string	类型	"SALE"
channel	query	否	string	渠道	"ONLINE"
startAmount	query	否	double	最小金额	10
endAmount	query	否	double	最大金额	100
startTime	query	否	string	开始时间	"2020-10-10 13:09:11"
endTime	query	否	string	结束时间	"2020-10-11 13:09:11"
memberBarcode	query	否	string	会员编号	215252342234232160
memberInfo	query	否	string	会员信息(名称/编号/手机号码)
posId	query	否	long	交易机台	1
test	query	否	boolean	是否是测试订单	false
deliveryMode	query	否	string	发货方式	"SELF"
status	query	否	string	状态	"APPLY"
posPkNo	query	否	long	机台交易流水号	1
queryBePaid	query	否	boolean	是否查询待付款订单(七选一)	false
queryBeReceived	query	否	boolean	是否查询待收货订单(七选一)	false
queryFinished	query	否	boolean	是否查询已完成订单(七选一)	false
queryCanceled	query	否	boolean	是否查询已取消订单(七选一)	false
queryExpired	query	否	boolean	是否查询已过期订单(七选一)	false
queryDelivery	query	否	boolean	是否查询待发货订单(七选一)	false
queryApplying	query	否	boolean	是否查询申请中订单(七选一)	false
archive	query	否	bool	是否归档	false
receiveMode	query	否	string	提货方式	"STORE_SELF"
companyIdList	query	否	list	公司ID集合	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: SimpleRmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.SimpleRmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SimpleRmOrder	否

GET

/api/query/page/pos

订单查询接口查询订单VO(分页)接口 OperationId: pageQueryPosOrder

调用方法

GET /api/query/page/pos

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	是	long	公司ID	1
posId	query	否	long	交易机台	1
code	query	否	string	编号	"0989681627412313123"
type	query	否	string	类型	"SALE"
channel	query	否	string	渠道	"ONLINE"
orderDate	query	否	string	交易日期	"2020-10-10"
memberBarcode	query	否	string	会员编号	215252342234232160
phone	query	否	string	会员手机号码	13800000000
posPkNo	query	否	long	机台交易流水号	1
status	query	否	string	状态	"APPLY"
paymentStatus	query	否	string	付款状态	"PAID"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: OrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.history.model.VO.order.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

GET

/api/query/order/delivery/{id}

订单查询接口查询订单配送信息接口 OperationId: queryOrderDelivery

调用方法

GET /api/query/order/delivery/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderDelivery com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery[]	否	返回数据

GET

/api/query/delivery/{id}

订单查询接口查询配送信息接口 OperationId: queryDelivery

调用方法

GET /api/query/delivery/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	发货单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderDelivery com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery	否

GET

/api/query/associate/refund-order/{id}

订单查询接口查询订单关联的退货订单接口 OperationId: queryAssociateRefundOrder

调用方法

GET /api/query/associate/refund-order/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder[]	否	返回数据

GET

/api/presale-order/page

预售单管理查询预售单分页列表 OperationId: page

调用方法

GET /api/presale-order/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
code	query	否	string	编号	"0989681627412313123"
type	query	否	string	类型	"SALE"
channel	query	否	string	渠道	"ONLINE"
startAmount	query	否	double	最小金额	10
endAmount	query	否	double	最大金额	100
startTime	query	否	string	开始时间	"2020-10-10 13:09:11"
endTime	query	否	string	结束时间	"2020-10-11 13:09:11"
memberBarcode	query	否	string	会员编号	215252342234232160
memberInfo	query	否	string	会员信息(名称/编号/手机号码)
posId	query	否	long	交易机台	1
test	query	否	boolean	是否是测试订单	false
deliveryMode	query	否	string	发货方式	"SELF"
status	query	否	string	状态	"APPLY"
posPkNo	query	否	long	机台交易流水号	1
queryBePaid	query	否	boolean	是否查询待付款订单(七选一)	false
queryBeReceived	query	否	boolean	是否查询待收货订单(七选一)	false
queryFinished	query	否	boolean	是否查询已完成订单(七选一)	false
queryCanceled	query	否	boolean	是否查询已取消订单(七选一)	false
queryExpired	query	否	boolean	是否查询已过期订单(七选一)	false
queryDelivery	query	否	boolean	是否查询待发货订单(七选一)	false
queryApplying	query	否	boolean	是否查询申请中订单(七选一)	false
archive	query	否	bool	是否归档	false
receiveMode	query	否	string	提货方式	"STORE_SELF"
companyIdList	query	否	list	公司ID集合	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

GET

/api/presale-order/get/{id}

预售单管理查询预售单详情 OperationId: query_4

调用方法

GET /api/presale-order/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrder com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

GET

/api/presale-order/check-archiving

预售单管理检查待归档预购单 OperationId: waitArchive

调用方法

GET /api/presale-order/check-archiving

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/presale-order/app-page

预售单管理手持查询预售单 OperationId: appPage

调用方法

GET /api/presale-order/app-page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
companyId	query	是	long	公司ID	1
posNo	query	否	String	pos号	1
transNo	query	否	String	交易号	1
customerName	query	否	String	客户名称	1
phone	query	否	String	电话后4位	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmPresaleOrderCustomerInfo com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmPresaleOrderCustomerInfo

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPresaleOrderCustomerInfo	否

GET

/api/pos-order-journal/query/pos-order-journal/{merchantId}/{code}

机台订单记录接口分页查询机台订单记录接口 OperationId: query_5

调用方法

GET /api/pos-order-journal/query/pos-order-journal/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	订单编号	2342235142342

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmPosOrderJournal com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPosOrderJournal	否

GET

/api/pos-order-journal/query-page/pos-order-journal

机台订单记录接口分页查询机台订单记录接口 OperationId: pageQueryRmPosOrderJournal

调用方法

GET /api/pos-order-journal/query-page/pos-order-journal

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
posId	query	否	long	机台ID	1
code	query	否	string	编号	"0989681627412313123"
type	query	否	string	类型	"SALE"
channel	query	否	string	渠道	"ONLINE"
status	query	否	string	状态
startTime	query	否	string	开始时间	"2020-10-11 13:09:11"
endTime	query	否	string	截止时间	"2020-10-11 13:09:11"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmPosOrderJournal com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPosOrderJournal	否

GET

/api/order/update-sale-order/member/check/{id}

订单修改业务接口是否允许销售订单修改会员检查接口 OperationId: updateForSaleOrderMemberCheck

调用方法

GET /api/order/update-sale-order/member/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-sale-order/item/check/{id}

订单修改业务接口是否允许销售订单修改商品检查接口 OperationId: updateForSaleOrderItemCheck

调用方法

GET /api/order/update-sale-order/item/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-sale-order/item-qty/check/{id}

订单修改业务接口是否允许销售订单修改商品数量检查接口 OperationId: updateForSaleOrderItemQtyCheck

调用方法

GET /api/order/update-sale-order/item-qty/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-sale-order/item-delivery/check/{id}

订单修改业务接口是否允许销售订单修改商品发货方式检查接口 OperationId: updateForSaleOrderItemDeliveryCheck

调用方法

GET /api/order/update-sale-order/item-delivery/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-sale-order/delivery-mode/check/{id}

订单修改业务接口是否允许销售订单修改配送方式检查接口 OperationId: updateForSaleOrderDeliveryModeCheck

调用方法

GET /api/order/update-sale-order/delivery-mode/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-refund-order/item/check/{id}

订单修改业务接口是否允许退货订单修改商品检查接口 OperationId: updateForRefundOrderItemCheck

调用方法

GET /api/order/update-refund-order/item/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/update-exchange-order/item/check/{id}

订单修改业务接口是否允许换货订单修改商品检查接口 OperationId: updateForExchangeOrderItemCheck

调用方法

GET /api/order/update-exchange-order/item/check/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/order/reconcile/{applyId}

订单对账业务接口对账申请ID搜索接口 OperationId: searchReconcileApply

调用方法

GET /api/order/reconcile/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ReconcileApplyDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyDetailVO	否

GET

/api/order/reconcile/page

订单对账业务接口对账申请分页搜索接口 OperationId: searchReconcileApply_1

调用方法

GET /api/order/reconcile/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
companyId	query	是	long	公司ID
year	query	否	int	年
month	query	否	int	月
code	query	否	string	编号
otherCode	query	否	string	客户对账单号
status	query	否	string	状态
customConfirm	query	否	boolean	客户是否已经确认	false
customer	query	否	string	客户	1
invoiceStatus	query	否	string	发票状态	"BE_INVOICED"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ReconcileApplyVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyVO	否

GET

/api/order/reconcile-print-data/{applyId}

订单对账业务接口获取对账单打印数据接口 OperationId: getReconcileApplyPrintData

调用方法

GET /api/order/reconcile-print-data/{applyId}

参数

名称	位置	必填	类型	说明	示例
applyId	path	是	integer(int64)	申请单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ReconcileApplyPrintDataVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyPrintDataVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyPrintDataVO	否

GET

/api/order-search/order-store/{id}

门店订单搜索业务接口门店订单ID搜索接口 OperationId: searchOrder

调用方法

GET /api/order-search/order-store/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-store/{companyId}/{code}

门店订单搜索业务接口门店订单编号搜索接口 OperationId: searchOrder_1

调用方法

GET /api/order-search/order-store/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	0
code	path	是	string	订单编号	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-store/page

门店订单搜索业务接口门店订单分页搜索接口 OperationId: searchOrder_2

调用方法

GET /api/order-search/order-store/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
companyId	query	是	long	门店ID
orderCode	query	否	long	订单编号
member	query	否	string	会员信息(编号/名称)
pos	query	否	string	机台(ID/编号)	1
restaurantTable	query	否	string	桌位(ID/编号)
orderTypeList	query	否	string	订单类型	[]
statusList	query	否	string	订单状态	[]
paymentStatusList	query	否	string	付款状态	[]
refundStatusList	query	否	string	退款状态	[]

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ListOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.business.order.mdoel.vo.ListOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mobile/{id}

移动端订单搜索业务接口移动端订单ID搜索接口 OperationId: searchOrderForMobile

调用方法

GET /api/order-search/order-mobile/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-mobile/{companyId}/{code}

移动端订单搜索业务接口移动端订单编号搜索接口 OperationId: searchOrderForMobile_1

调用方法

GET /api/order-search/order-mobile/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	0
code	path	是	string	订单编号	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-mobile/sale/page

移动端订单搜索业务接口移动端销售订单分页搜索接口 OperationId: searchOrderForMobile_2

调用方法

GET /api/order-search/order-mobile/sale/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
goods	query	否	string	商品关键字(商品/品牌名称)
orderTypeList	query	否	string	订单类型	[]
bePayment	query	否	boolean	待付款	false
beDelivery	query	否	boolean	待发货	false
beReceive	query	否	boolean	待收货	false
finish	query	否	boolean	已完成	false
cancel	query	否	boolean	已取消	false

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mobile/sale-invoice/page

移动端订单搜索业务接口移动端待开票销售订单分页搜索接口 OperationId: searchInvoiceSaleOrderForMall

调用方法

GET /api/order-search/order-mobile/sale-invoice/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
startDate	query	否	string	下单时间(开始)	"2020-10-11"
endDate	query	否	string	下单时间(结束)	"2020-10-11"

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mobile/after-service/page

移动端订单搜索业务接口移动端售后服务订单分页搜索接口 OperationId: searchOrderForMobile_3

调用方法

GET /api/order-search/order-mobile/after-service/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
goods	query	否	string	商品关键字(商品/品牌名称)
orderType	query	否	string	订单类型
process	query	否	boolean	处理中	false
finish	query	否	boolean	已完成	false
cancel	query	否	boolean	已取消	false

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mall/{id}

商城订单搜索业务接口商城订单ID搜索接口 OperationId: searchOrderForMall

调用方法

GET /api/order-search/order-mall/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-mall/{companyId}/{code}

商城订单搜索业务接口商城订单编号搜索接口 OperationId: searchOrderForMall_1

调用方法

GET /api/order-search/order-mall/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	0
code	path	是	string	订单编号	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-mall/sale/page

商城订单搜索业务接口商城销售订单分页搜索接口 OperationId: searchOrderForMall_2

调用方法

GET /api/order-search/order-mall/sale/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
goods	query	否	string	商品关键字(商品/品牌名称)
receiverAddress	query	否	string	收货地址
orderTypeList	query	否	string	订单类型	[]
bePayment	query	否	boolean	待付款	false
beDelivery	query	否	boolean	待发货	false
beReceive	query	否	boolean	待收货	false
finish	query	否	boolean	已完成	false
cancel	query	否	boolean	已取消	false
startDate	query	否	string	下单时间(开始)	"2020-10-11"
endDate	query	否	string	下单时间(结束)	"2020-10-11"
minAmount	query	否	string	订单金额(最小)	1
maxAmount	query	否	string	订单金额(最大)	100

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mall/sale-invoice/page

商城订单搜索业务接口商城待开票销售订单分页搜索接口 OperationId: searchInvoiceSaleOrderForMall_1

调用方法

GET /api/order-search/order-mall/sale-invoice/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
startDate	query	否	string	下单时间(开始)	"2020-10-11"
endDate	query	否	string	下单时间(结束)	"2020-10-11"

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-mall/after-service/page

商城订单搜索业务接口商城售后服务订单分页搜索接口 OperationId: searchOrderForMall_3

调用方法

GET /api/order-search/order-mall/after-service/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
memberId	query	是	long	会员ID
customerId	query	否	long	客户ID
orderCode	query	否	long	订单编号
goods	query	否	string	商品关键字(商品/品牌名称)
orderType	query	否	string	订单类型
process	query	否	boolean	处理中	false
finish	query	否	boolean	已完成	false
cancel	query	否	boolean	已取消	false

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/order-search/order-erp/{id}

ERP订单搜索业务接口 ERP订单ID搜索接口 OperationId: searchOrderForERP

调用方法

GET /api/order-search/order-erp/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	订单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-erp/{companyId}/{code}

ERP订单搜索业务接口 ERP订单编号搜索接口 OperationId: searchOrderForERP_1

调用方法

GET /api/order-search/order-erp/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	0
code	path	是	string	订单编号	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: DetailOrderVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

GET

/api/order-search/order-erp/page

ERP订单搜索业务接口 ERP订单分页搜索接口 OperationId: searchOrderForERP_2

调用方法

GET /api/order-search/order-erp/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	搜索页码	0
size	query	是	integer(int32)	搜索页行数	10
orderCode	query	否	long	订单编号
member	query	否	string	会员信息(编号/名称)
customer	query	否	string	客户信息(编号/名称)
customerPerson	query	否	string	联系人信息(编号/名称)
pos	query	否	string	机台(编号),ES方式才提供	1
restaurantTable	query	否	string	桌位(编号),ES方式才提供	1
goods	query	否	string	商品关键字(商品/品牌名称)
receiver	query	否	string	收货信息(收货人/收货人电话/收货地址)
resources	query	否	string	来源	"ONLINE_STORE"
channel	query	否	string	渠道	"ONLINE"
orderTypeList	query	否	string	订单类型	[]
statusList	query	否	string	订单状态	[]
paymentStatusList	query	否	string	付款状态	[]
refundStatusList	query	否	string	退款状态	[]
deliveryStatusList	query	否	string	发货状态	[]
returnStatusList	query	否	string	退货状态	[]
receivedStatusList	query	否	string	收货状态	[]
purchaseStatusList	query	否	string	采购状态	[]
verifyStatusList	query	否	string	审核状态	[]
invoiceStatusList	query	否	string	发票状态	[]
startDate	query	否	string	下单时间(开始)	"2020-10-11"
endDate	query	否	string	下单时间(结束)	"2020-10-11"
minAmount	query	否	string	订单金额(最小)	1
maxAmount	query	否	string	订单金额(最大)	100

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

GET

/api/online-order/sale-order/refund-inspection

线上订单管理接口销售订单退货商品校验接口 OperationId: refundInspection_2

调用方法

GET /api/online-order/sale-order/refund-inspection

参数

名称	位置	必填	类型	说明	示例
orderId	query	是	long	销售订单ID	1
itemIdList	query	是	list	商品ID集合

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

GET

/api/online-order/query/sale-order/item-surplus-refund-info/{merchantId}/{code}

线上订单管理接口查询销售商品剩余可退货数量/重量接口 OperationId: queryRefundOrderItemSurplusRefundInfo

调用方法

GET /api/online-order/query/sale-order/item-surplus-refund-info/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Double com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Double

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/online-order/query/sale-order/item-surplus-delivery-info/{merchantId}/{code}

线上订单管理接口查询销售订单商品剩余可发货数量/重量接口 OperationId: querySaleOrderItemSurplusDeliveryInfo

调用方法

GET /api/online-order/query/sale-order/item-surplus-delivery-info/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	单号	"0989681627412313123"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Double com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Double

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/online-order/query/sale-order/delivery

线上订单管理接口查询销售订单配送信息接口 OperationId: querySaleOrderDelivery

调用方法

GET /api/online-order/query/sale-order/delivery

参数

名称	位置	必填	类型	说明	示例
orderId	query	是	long	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderDelivery com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery[]	否	返回数据

GET

/api/online-order/query/refund-order/delivery

线上订单管理接口查询退货订单配送信息接口 OperationId: queryRefundOrderDelivery

调用方法

GET /api/online-order/query/refund-order/delivery

参数

名称	位置	必填	类型	说明	示例
orderId	query	是	long	订单ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmOrderDelivery com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery[]	否	返回数据

GET

/api/monitor/version

服务监控管理获取服务版本信息 OperationId: version

调用方法

GET /api/monitor/version

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/monitor/health

服务监控管理心跳检查 OperationId: health

调用方法

GET /api/monitor/health

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/trade-reason/remove/{id}

交易理由管理接口删除交易理由接口 OperationId: remove

物理删除

调用方法

DELETE /api/trade-reason/remove/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	交易理由ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

DELETE

/api/presale-order/del/{presaleOrderId}

预售单管理删除预购单 OperationId: del

调用方法

DELETE /api/presale-order/del/{presaleOrderId}

参数

名称	位置	必填	类型	说明	示例
presaleOrderId	path	是	integer(int64)	预售单ID	0

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/order/reconcile-delete-delivery

订单对账业务接口删除对账申请发货单数据接口 OperationId: deleteReconcileDelivery

调用方法

DELETE /api/order/reconcile-delete-delivery

参数

无

请求体

Content-Type: application/json 必填: 是 类型: DeleteReconcileDeliveryDTO com.leadwaycloud.rm.order.business.reconcile.dto.DeleteReconcileDeliveryDTO

名称	类型	必填	说明	示例
applyId	integer(int64)	是	对账申请ID
deleteDeliveryList	integer(int64)[]	否	需要删除的发货单

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/online-order/sale-order/cancel

线上订单管理接口销售订单取消接口 OperationId: cancelSaleOrder_1

调用方法

DELETE /api/online-order/sale-order/cancel

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CancelMallOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.CancelMallOrderDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

DELETE

/api/online-order/refund-order/cancel

线上订单管理接口退货订单取消接口 OperationId: cancelRefundOrder_1

调用方法

DELETE /api/online-order/refund-order/cancel

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CancelMallOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.CancelMallOrderDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

DELETE

/api/offline-order/cancel-order

线下订单管理接口取消订单接口 OperationId: cancelOrder_2

调用方法

DELETE /api/offline-order/cancel-order

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CancelStoreOrderDTO com.leadwaycloud.rm.order.business.history.model.DTO.order.store.CancelStoreOrderDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/error

main-site-error-handler - OperationId: handleError

调用方法

GET /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/error

main-site-error-handler - OperationId: handleError_1

调用方法

POST /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/error

main-site-error-handler - OperationId: handleError_2

调用方法

PUT /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/error

main-site-error-handler - OperationId: handleError_3

调用方法

DELETE /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PATCH

/error

main-site-error-handler - OperationId: handleError_4

调用方法

PATCH /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

OPTIONS

/error

main-site-error-handler - OperationId: handleError_6

调用方法

OPTIONS /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

HEAD

/error

main-site-error-handler - OperationId: handleError_5

调用方法

HEAD /error

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

模型定义

com.leadwaycloud.rm.order.business.history.model.DTO.reason.UpdateTradeReasonDTO

修改交易理由数据模版

名称	类型	必填	说明	示例
orderType	string	否	类型	"SALE"
reason	string	否	交易理由

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason	否

com.leadwaycloud.rm.common.model.po.entity.RmTradeReason

交易理由

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
orderType	string	是	类型	"SALE"
reason	string	是	交易理由

com.leadwaycloud.rm.order.business.reconcile.dto.UpdateReconcileApplyDTO

名称	类型	必填	说明	示例
otherCode	string	否	客户对账单号
receiveInvoiceAddress	string	否	收票地址	"xxx"
payMethod	string	否	付款方式	"xxx"
invoiceRequire	string	否	开票要求	"xxx"
contractOrder	boolean	否	是否合同订单	false
remark	string	否	备注	"xxx"

com.leadwaycloud.core.model.RJava.lang.Void

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.rm.order.business.kds.dto.ChangeCateringOrderKdsStatusDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1858875177140284
newStatus	string	是	新的订单状态【 BE_PRODUCED : 待制作 PRODUCTION : 制作中 BE_PICKED : 待取餐 PICKED : 已取餐】	"PRODUCTION"

com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryExpressUpdateDTO

名称	类型	必填	说明	示例
deliveryId	integer(int64)	是	发货单ID	3
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	是	快递单号	"SF42524252343"

com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryCodeUpdateDTO

名称	类型	必填	说明	示例
deliveryId	integer(int64)	是	发货单ID	3
code	string	否	发货单单号	"3"
reserved2	string	否	备用字段2(CRM发货单ID)
reserved3	string	否	备用字段3(SAP发货单号)
reserved4	string	否	备用字段4(SAP贷项凭证申请号)

com.leadwaycloud.rm.order.business.history.model.DTO.invoice.InvoiceBuyerInfo

名称	类型	必填
type	string	否
sendMethod	string	否
invoiceType	string	否
email	string	否
mobile	string	否
name	string	否
taxNumber	string	否
address	string	否
bank	string	否
account	string	否
phone	string	否

com.leadwaycloud.core.model.R

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.rm.order.business.history.model.DTO.reason.AddTradeReasonDTO

添加交易理由数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
orderType	string	是	类型	"SALE"
reason	string	是	交易理由

com.leadwaycloud.rm.order.business.history.model.DTO.order.AddPresaleOrderCustomerInfoDTO

添加预售单客户信息

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
assetId	integer(int64)	是	设备ID	1
posNo	string	是	pos号	"1"
transNo	string	是	交易号	"1"
receipt	string	是	小票	"1"
note	string	否	备注	"1"
activeId	integer(int64)	是	活动ID	1
customerName	string	是	客户名称	"1"
phone	string	是	电话	"1"
backupPhone	string	否	备用电话	"1"
receiveMode	string	是	提货方式【 STORE_SELF : 门店自提 SUPPLY_POINT_SELF : 供应商自提 HOME_DELIVERY : 送货上门】	"STORE_SELF"
address	string	否	地址	"1"

com.leadwaycloud.rm.order.business.history.model.DTO.pos.order.journal.AddRmPosOrderJournalDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	否	状态
orderInfo	string	否	交易信息
submitTime	string	否	提交时间	"2020-10-11 13:09:11"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPosOrderJournal	否

com.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

机台订单记录

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	状态
orderInfo	string	否	交易信息
submitTime	string	否	提交时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$CallbackDTO

名称	类型	必填	说明
merchantId	integer(int64)	否	商户ID
submitBy	string	否	当前审批人/操作人
businessTypeKey	string	是	业务唯一key
businessId	string	是	业务ID
taskId	string	否	节点实例任务ID
serviceName	string	否	回调服务名
function	string	是	具体执行方法（自定义配置，可缺省）
businessData	object	否	业务数据（发起时业务、审批中特有变量并集）
instanceState	string	是	实例状态（pass, reject, terminate）
terminationRemark	string	否	消息
body	object	否	自定义配置数据

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	WorkflowDTO$ReturnDTO	否

com.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO

返回数据

名称	类型	必填	说明	示例
globalMap	string	否	全局变量
localMap	string	否	局部变量

com.leadwaycloud.rm.order.business.verify.dto.OrderVerifyResultDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
businessKey	string	是	业务类型	"xxx"
pass	boolean	是	是否通过	false
notice	string	否	审核结果描述	"xxx"

com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleMemberResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID
customerId	integer(int64)	否	客户ID

com.leadwaycloud.rm.common.model.bo.AttachmentBO

附件

名称	类型	必填	说明	示例
name	string	是	文件名称	"xx"
type	string	是	文件类型	"xx"
fileId	string	是	文件服务的文件ID	"xxx"
userId	integer(int64)	否	上传的用户ID	1
userName	string	否	上传的用户名称	"1"
uploadTime	string	否	上传时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.order.business.create.dto.OrderCreateDeliveryModeDTO

订单配送方式(存在配送的订单时提供)

名称	类型	必填	说明	示例
deliveryMode	string	是	发货方式【 SELF : 自提/自送 EXPRESS : 快递】	"SELF"
fare	number(double)	否	运费	0
country	integer(int64)	否	国家	1
province	integer(int64)	否	省份	1
city	integer(int64)	否	城市	1
area	integer(int64)	否	区	1
street	integer(int64)	否	街道	1
detailAddress	string	否	详细地址	"..."
receiver	string	否	收货人
phone	string	否	电话
selfPickupOutletsId	integer(int64)	否	提/退货点ID	1
selfPickupDate	string	否	自提/自退货日期	"2020-10-11"
selfPickupStartTime	string	否	自提/自退时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提/自退时间区间(结束)	"08:00:00"
remark	string	否	备注

com.leadwaycloud.rm.order.business.create.dto.OrderCreateItemForSaleDTO

商品清单

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
itemId	integer(int64)	是	零售商品ID	1
itemBarcodeId	integer(int64)	是	零售商品条码ID	1
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
thirdpartyDelivery	boolean	否	是否第三方配送	false
thirdpartyPurchase	boolean	否	是否第三方采购(商城根据商品中的参数带入不可编辑，中台根据商品中的参数带入可编辑)	false
acceptThirdpartyDelivery	boolean	否	是否接受第三方配送(中台、商城在页面可调整,如果第三方采购=true默认带入true)	false
purchaseByOrder	boolean	否	是否按单采购(中台在页面可调整,默认false)	false
remark	string	否	备注	"1"

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForSaleItemResDTO$OrderUpdateForSaleItemDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemResDTO$OrderUpdateForSaleItemDTO

订单

名称	类型	必填	说明	示例
memberId	integer(int64)	否	会员ID	1
customerId	integer(int64)	否	客户ID	1
customerPersonId	integer(int64)	否	客户联系人ID	1
customerNote	string	否	客户备注
reason	string	否	交易理由
acceptSplittingDelivery	boolean	否	是否接受拆单发货
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemQtyResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
orderItemId	integer(int64)	是	订单商品ID	1
qty	integer(int32)	是	订单商品数量	1

com.leadwaycloud.rm.order.business.update.dto.OrderItemDeliveryForSaleDTO

订单商品第三方配送

名称	类型	必填	说明	示例
orderItemId	integer(int64)	是	订单商品ID	1
thirdpartyDelivery	boolean	是	是否第三方配送	false
thirdpartyPurchase	boolean	是	是否第三方采购(商城根据商品中的参数带入不可编辑，中台根据商品中的参数带入可编辑)	false
acceptThirdpartyDelivery	boolean	是	是否接受第三方配送(中台、商城在页面可调整,如果第三方采购=true默认带入true)	false
purchaseByOrder	boolean	是	是否按单采购(中台在页面可调整,默认false)	false

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleItemDeliveryResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
itemDeliveryList	OrderItemDeliveryForSaleDTO[]	是	订单商品第三方配送

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForSaleDeliveryModeResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
acceptSplittingDelivery	boolean	否	是否接受拆单发货
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

com.leadwaycloud.rm.order.business.create.dto.OrderCreateItemForRefundDTO

商品清单

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
itemId	integer(int64)	是	零售商品ID	1
itemBarcodeId	integer(int64)	是	零售商品条码ID	1
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
remark	string	否	备注

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForRefundItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForRefundItemResDTO$OrderUpdateForRefundItemDTO	否
orderItemList	OrderCreateItemForRefundDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForRefundItemResDTO$OrderUpdateForRefundItemDTO

订单

名称	类型	必填	说明
customerNote	string	否	客户备注
reason	string	否	交易理由
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateAppendMerchantNoteResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
note	string	是	备注	"xxx"

com.leadwaycloud.rm.order.business.create.dto.OrderCreateItemForExchangeDTO

商品清单

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
itemId	integer(int64)	是	零售商品ID	1
itemBarcodeId	integer(int64)	是	零售商品条码ID	1
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
remark	string	否	备注

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForExchangeItemResDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
order	OrderUpdateForExchangeItemResDTO$OrderUpdateForExchangeItemDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	商品清单
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

com.leadwaycloud.rm.order.business.update.dto.OrderUpdateForExchangeItemResDTO$OrderUpdateForExchangeItemDTO

订单

名称	类型	必填	说明
customerNote	string	否	客户备注
reason	string	否	交易理由
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.common.business.order.mdoel.dto.CacheOrderSearchDataReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	否	订单集合
companyId	integer(int64)	否	公司ID
startDate	string	否	交易开始日期	"2020-10-10"
endDate	string	否	交易结束日期	"2020-10-10"

com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderItem

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderItem[]	否	返回数据

com.leadwaycloud.rm.common.model.po.entity.RmOrderItem

订单商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
lineNo	integer(int32)	是	行号	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsTypeCode	string	是	商品类型编号	"1"
goodsTypeName	string	是	商品类型名称	"1"
brandId	integer(int64)	否	品牌ID	1
brandCode	string	否	品牌编号	"xxx"
brandName	string	否	品牌名称	"xxx"
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
packSymbol	string	否	包装	"瓶"
shortPack	string	否	包装	"瓶"
isoShortPack	string	否	包装	"瓶"
spec	string	否	规格
totalAmount	number(double)	是	总金额	35
promAmount	number(double)	是	商品优惠金额	0
amount	number(double)	是	商品金额	35
vatAmount	number(double)	是	商品税额	100
snapshot	string	否	商品快照(下单时商品的基本信息)
rmItemId	integer(int64)	是	零管商品ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
quotationCode	string	否	报价单编号
quotationOutsideCode	string	否	外部报价单编号
thirdpartyDelivery	boolean	否	是否第三方配送	false
thirdpartyPurchase	boolean	否	是否第三方采购(商城根据商品中的参数带入不可编辑，中台根据商品中的参数带入可编辑)	false
acceptThirdpartyDelivery	boolean	否	是否接受第三方配送(中台、商城在页面可调整,如果第三方采购=true默认带入true)	false
purchaseByOrder	boolean	否	是否按单采购(中台在页面可调整,默认false)	false
periodType	string	否	发货周期类型【 HOUR : 时 DAY : 天 WEEK : 周 MONTH : 月 YEAR : 年】	"1"
deliveryPeriod	integer(int32)	否	发货周期	1
remark	string	否	备注	"1"
reserved1	string	否	备用字段1(客户物料编码)
reserved2	string	否	备用字段2(客户物料规格)
reserved3	string	否	备用字段3

com.leadwaycloud.rm.order.business.history.model.DTO.order.RefundOrderVerifyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否通过	false
notice	string	否	原因	"xxx"

com.leadwaycloud.rm.order.business.reconcile.dto.SearchReconcileCustomerDTO

名称	类型	必填	说明
companyId	integer(int64)	是	公司ID
year	integer(int32)	是	年
month	integer(int32)	是	月

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileCustomerVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileCustomerVO[]	否	返回数据

com.leadwaycloud.rm.order.business.reconcile.vo.ReconcileCustomerVO

返回数据

名称	类型	必填	说明	示例
customerId	integer(int64)	是	客户ID
customerCode	string	是	客户编号
customerName	string	是	客户名称
reconciledCode	string	否	客户对账代码
credit	boolean	否	是否信用客户	false

com.leadwaycloud.rm.order.business.reconcile.dto.GenerateReconcileApplyDTO

名称	类型	必填	说明
customerId	integer(int64)	是	客户ID
year	integer(int32)	是	年
month	integer(int32)	是	月

com.leadwaycloud.rm.order.business.reconcile.dto.AddReconcileAttachmentDTO

名称	类型	必填	说明	示例
applyId	integer(int64)	是	对账申请ID
attachmentList	AttachmentBO[]	否	附件集合

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderReceiveDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	否	订单ID(三选一)	1
orderCode	string	否	订单编号(三选一)	"1"
orderDeliveryId	integer(int64)	否	订单配送ID(三选一),如果不传则默认对交易订单的所有订单配送进行收货操作	1

com.leadwaycloud.rm.order.business.push.dto.PushOrderDTO

名称	类型	必填	说明	示例
orderPushType	string	是	订单推送类型【 CREATE : 创建 CONFIRM : 确认 COMMIT : 提交 CANCEL : 取消 DELETE : 删除 PAYMENTED : 支付/退款完成 DELIVERY : 发货 RECEIVE : 收货 INVOICE : 开票 UPDATE_DELIVERY_MODEL : 修改配送信息 UPDATE_ITEM_DELIVERY_METHOD : 修改商品发货方式信息 REFUND_VERIFY_PASS : 退货订单审核通过 EXCHANGE_CONVERT_ORDER : 换货订单转换订单】	"CREATE"
orderId	integer(int64)	是	订单ID	1812404461173774

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SaleOrderPrintVO	否

com.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO

返回数据

名称	类型	必填	说明
orderInfo	SaleOrderPrintVO$OrderVO	否
customInfo	SaleOrderPrintVO$CustomVO	否
supplierInfo	SaleOrderPrintVO$SupplierVO	否
itemInfoList	SaleOrderPrintVO$ItemVO[]	否	货品信息

com.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO$CustomVO

需方信息

名称	类型	必填	说明	示例
companyName	string	否	公司名称	"xxx"
person	string	否	下单人	"xxx"
phone	string	否	联系电话	"1"
address	string	否	送货地址+收货人+收货人手机号

com.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO$ItemVO

货品信息

名称	类型	必填	说明	示例
lineNo	integer(int32)	否	序号	1
goodsName	string	否	产品名称	"微分头"
customSpec	string	否	规格型号(客户)	"EPD23"
spec	string	否	规格型号(怡合达)	"EPD23"
qty	integer(int32)	否	数量	1
weight	number(double)	否	重量	1
pack	string	否	包装	"瓶"
shortPack	string	否	包装	"瓶"
isoShortPack	string	否	包装	"瓶"
qtyDisc	number(double)	否	数量折扣	100
totalDisc	number(double)	否	总折扣	100
unTaxDiscPrice	number(double)	否	折扣单价(未税)	127.48
taxDiscPrice	number(double)	否	折扣单价(含税)	100
amount	number(double)	否	含税小计	288.1
deliveryDay	integer(int32)	否	发货天数(工作日)	1
customerGoodsCode	string	否	物料编码/备注说明	"客户物料编码（电商无）"
remark	string	否	怡合达备注

com.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO$OrderVO

订单信息

名称	类型	必填	说明	示例
orderCode	string	否	订单号	"1"
customOrderCode	string	否	客户订单号	"1"
orderTime	string	否	订单日期	"2020-10-11 00:00:00"
amount	number(double)	否	订单含税金额	100
vatAmount	number(double)	否	订单税额	13
itemCount	integer(int32)	否	商品项数量	5
tenderName	string	否	结算方式	"5"
deliveryMode	string	否	交货方式	"5"

com.leadwaycloud.rm.order.business.print.vo.SaleOrderPrintVO$SupplierVO

供方信息

名称	类型	必填	说明	示例
companyName	string	否	公司名称	"xxx"
person	string	否	联系人	"xxx"
business	string	否	业务代表	"1"
phone	string	否	联系电话	"1"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.RefundOrderListPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RefundOrderListPrintVO	否

com.leadwaycloud.rm.order.business.print.vo.RefundOrderListPrintVO

返回数据

名称	类型	必填	说明	示例
customInfo	RefundOrderListPrintVO$CustomVO	否
itemInfoList	RefundOrderListPrintVO$ItemVO[]	否	货品信息

com.leadwaycloud.rm.order.business.print.vo.RefundOrderListPrintVO$CustomVO

退货方信息

名称	类型	必填	说明	示例
companyName	string	否	公司名称	"xxx"
person	string	否	下单人	"xxx"
phone	string	否	联系电话	"1"

com.leadwaycloud.rm.order.business.print.vo.RefundOrderListPrintVO$ItemVO

货品信息

名称	类型	必填	说明	示例
lineNo	integer(int32)	否	序号	1
serverOrderCode	string	否	客诉订单号	"1"
spec	string	否	规格型号(怡合达)	"EPD23"
goodsName	string	否	产品名称	"微分头"
qty	integer(int32)	否	数量	1
weight	number(double)	否	重量	1
pack	string	否	包装	"瓶"
shortPack	string	否	包装	"瓶"
isoShortPack	string	否	包装	"瓶"
refundReason	string	否	退货原因

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RefundOrderPrintVO	否

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO

返回数据

名称	类型	必填	说明
orderInfo	RefundOrderPrintVO$OrderVO	否
customInfo	RefundOrderPrintVO$CustomVO	否
supplierInfo	RefundOrderPrintVO$SupplierVO	否
itemInfoList	RefundOrderPrintVO$ItemVO[]	否	货品信息
deliveryInfoList	RefundOrderPrintVO$DeliveryVO[]	否	发货信息

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO$CustomVO

需方信息

名称	类型	必填	说明	示例
companyName	string	否	公司名称	"xxx"
person	string	否	下单人	"xxx"
phone	string	否	联系电话	"1"
address	string	否	送货地址+收货人+收货人手机号

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO$DeliveryVO

发货信息

名称	类型	必填	说明	示例
expressName	string	否	快递公司名称
expressOrderCode	string	否	快递单号	"SF42524252343"

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO$ItemVO

货品信息

名称	类型	必填	说明	示例
lineNo	integer(int32)	否	序号	1
goodsName	string	否	产品名称	"微分头"
spec	string	否	规格型号(怡合达)	"EPD23"
qty	integer(int32)	否	数量	1
weight	number(double)	否	重量	1
pack	string	否	包装	"瓶"
shortPack	string	否	包装	"瓶"
isoShortPack	string	否	包装	"瓶"
qtyDisc	number(double)	否	数量折扣	100
totalDisc	number(double)	否	总折扣	100
unTaxDiscPrice	number(double)	否	折扣单价(未税)	127.48
taxDiscPrice	number(double)	否	折扣单价(含税)	100
amount	number(double)	否	含税小计	288.1
refundReason	string	否	退货原因

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO$OrderVO

订单信息

名称	类型	必填	说明	示例
orderCode	string	否	订单号	"1"
associateSaleOrderCode	string	否	关联销售订单号	"1"
serverOrderCode	string	否	客诉订单号	"1"
orderTime	string	否	订单时间	"2020-10-11 00:00:00"
amount	number(double)	否	订单含税金额	100
vatAmount	number(double)	否	订单税额	13

com.leadwaycloud.rm.order.business.print.vo.RefundOrderPrintVO$SupplierVO

供方信息

名称	类型	必填	说明	示例
companyName	string	否	公司名称	"xxx"
person	string	否	联系人	"xxx"
business	string	否	业务代表	"1"
phone	string	否	联系电话	"1"

com.leadwaycloud.rm.order.business.paymented.dto.OrderPaymentedReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.rm.order.business.invoice.dto.OrderInvoiceForSaleOrderReqDTO

名称	类型	必填	说明	示例
invoiceTitleId	integer(int64)	是	发票抬头ID	1
invoiceAddressId	integer(int64)	否	收票地址ID	1
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.rm.order.business.invoice.dto.OrderInvoiceForReconcileReqDTO

名称	类型	必填	说明	示例
invoiceTitleId	integer(int64)	是	发票抬头ID	1
invoiceAddressId	integer(int64)	否	收票地址ID	1
applyId	integer(int64)	是	对账单ID集合

com.leadwaycloud.rm.common.business.order.mdoel.dto.CacheOrderInfoReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	订单集合

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

com.leadwaycloud.rm.common.business.order.mdoel.bo.OrderMerchantNoteBO

订单商户备注数据模版

名称	类型	必填	说明	示例
note	string	是	参数名称	"折扣名称"
user	string	是	备注人	"张三"
time	string	否	备注时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderVO

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
itemCount	integer(int32)	否	商品条数
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAID : 部分付款 PAY_FINISH : 付款完成】	"PAID"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
purchaseStatus	string	否	采购状态【 BE_PROCURED : 待采购 ONGOING : 采购中 PURCHASED : 已采购】	"BE_PROCURED"
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
vatAmount	number(double)	是	订单税额	100
associateOrderId	integer(int64)	否	关联订单ID
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
endPaymentTime	string	否	付款截止时间	"2020-10-11 13:09:11"
customerNote	string	否	客户备注	"..."
merchantNote	OrderMerchantNoteBO[]	否	商户备注
reason	string	否	交易理由
verifyType	string	否	'审核类型' 【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
attachmentList	AttachmentBO[]	否	附件
memberId	integer(int64)	否	会员ID
memberName	string	否	会员名称	"张三"
memberBarcode	string	否	会员编号	"215252342234232145"
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
salesPersonCode	string	否	业务员编号	"xxx"
posId	integer(int64)	否	机台ID	1
restaurantTableId	integer(int64)	否	桌位ID
fee	number(double)	否	运费
acceptSplittingDelivery	boolean	否	是否接受拆单发货
createBy	string	否	创建人
updateBy	string	否	修改人
createTime	string	否	创建时间
updateTime	string	否	修改时间

com.leadwaycloud.rm.order.business.download.dto.OrderDownloadRequestDTO

无

com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryItemDTO

订单配送包含的商品

名称	类型	必填	说明	示例
goodsBarcodeId	integer(int64)	是	商品条码ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1
name	string	是	商品名称	"洗发水"
pack	string	是	包装	"瓶"
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
remark	string	否	备注

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderDeliveryDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	OrderDeliveryItemDTO[]	否	订单配送包含的商品
stockMoveId	integer(int64)	否	出库单ID	1
fare	number(double)	否	运费	0

com.leadwaycloud.rm.order.business.history.model.DTO.order.OnlineSelfOrderBatchDeliveryDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	销售订单ID集合	[]

com.leadwaycloud.rm.order.business.delivery.dto.OrderDeliveryReqDTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	OrderDeliveryItemDTO	否
stockMoveId	integer(int64)	否	出库单ID	1
unStockDelivery	boolean	否	无库存发货	false
remark	string	否	备注

com.leadwaycloud.rm.order.business.delivery.dto.OrderFullDeliveryReqDTO

名称	类型	必填	说明	示例
orderList	integer(int64)[]	是	销售订单ID集合	[]

com.leadwaycloud.rm.order.business.delete.dto.OrderDeleteReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
type	string	是	交易类型,rm_order_type表code栏位	"SALE"
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"STORE_POS"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
paid	boolean	否	是否已经支付	false
cancel	boolean	否	是否已经取消	false
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderHandmadeDiscountList	OrderHandmadeDiscountDTO[]	否	订单手工折扣
orderItemList	OrderItemDTO[]	否	订单商品
orderDeliveryMode	OrderDeliveryModeDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
associateOrderCode	string	否	关联订单单号,退款订单时提供
saveTime	integer(int32)	否	订单保留时间(小时),线上订单提供该数据时，会根据下单时间+saveTime来确定订单自动过期时间，如果没有传则默认12小时	1
thirdPartyId	integer(int64)	否	会员编号	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderDeliveryModeDTO

订单配送方式数据模版

名称	类型	必填	说明	示例
deliveryMode	string	是	发货方式【 SELF : 自提/自送 EXPRESS : 快递】	"SELF"
fare	number(double)	是	运费	0
country	integer(int64)	否	国家	1
province	integer(int64)	否	省份	1
city	integer(int64)	否	城市	1
area	integer(int64)	否	区	1
street	integer(int64)	否	街道	1
detailAddress	string	否	详细地址	"..."
receiver	string	否	收货人
phone	string	否	电话
selfPickupOutletsId	integer(int64)	否	自提点ID	1
selfPickupDate	string	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderHandmadeDiscountDTO

订单手工折扣

名称	类型	必填	说明	示例
cashierId	integer(int64)	否	授权收银员
type	string	否	折扣类型
lineNo	integer(int32)	否	行号(如果为null或者0则表示属于整个订单)	1
promAmount	number(double)	是	手工优惠金额	0

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderItemDTO

订单商品

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
brandId	integer(int64)	否	商品品牌ID	1
snapshot	string	否	商品快照
rmItemId	integer(int64)	是	零售商品ID	1
rmItemBarcodeId	integer(int64)	是	零售商品条码ID	1
orderOil	OrderOilDTO	否
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
thirdpartyDelivery	boolean	否	是否第三方配送	false
remark	string	否	备注	"1"
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
totalAmount	number(double)	是	商品总金额	35
promAmount	number(double)	是	商品优惠金额	0
amount	number(double)	是	商品金额	35

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderMemberDTO

订单会员数据模版

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
customerPartnerId	integer(int64)	否	客户关系ID	1
barcode	string	是	会员编号	"215252342234232145"
name	string	是	会员名称	"张三"
type	integer(int64)	是	会员类型	1
sex	string	否	性别	"1"
age	integer(int32)	否	年龄	22
birthday	string	否	生日	"1999-11-11"
tags	string[]	否	标签	"[健身]"

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderOilDTO

订单油品数据模版

名称	类型	必填	说明	示例
tank	string	是	油罐	"1"
pump	string	是	油泵	"1"
nozzle	string	是	油枪	"1"
pumpStartNumber	number(double)	是	起泵码	100
pumpEndNumber	number(double)	是	止泵码	150
machineOut	number(double)	是	油机付出	50
tradCode	string	是	交易号	"12345"
tradTime	string	是	交易时间	"2020-11-11 10:20:39"

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderPosDTO

订单机台数据模版

名称	类型	必填	说明	示例
posId	integer(int64)	是	机台ID	1
cashierId	integer(int64)	否	收银员ID	1
shiftNo	integer(int64)	否	班次号	1
shiftDate	string	否	班次日	"2020-10-11"
pkNo	integer(int64)	否	流水号	1
operator	string	否	操作员
cateringOrderType	string	否	机台餐饮订单类型【 DINE_IN : 堂食 DINE_OUT : 外带 TAKEOUT : 外卖】

com.leadwaycloud.rm.order.business.history.model.DTO.order.OrderRestaurantDTO

订单餐饮信息

名称	类型	必填	说明	示例
restaurantTableId	integer(int64)	是	桌位ID	1
consumerCount	integer(int32)	是	用餐人数	1
diningTime	string	是	用餐时间	"2020-10-11 13:09:11"
notes	string	否	备注

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

com.leadwaycloud.rm.common.model.po.entity.ResCompany

总部/区域总部/公司/门店

名称	类型	必填	说明	示例
id	integer(int64)	否
code	string	是	公司编号(仅允许字母和数字)	"CD01"
name	string	是	公司名称	"成都立威云"
otherCode	string	是	其他编号	"AAAA-01"
type	string	是	类型【 MERCHANT : 总部 EMPTY : 无任何管理功能 AREA : 区域总部 STORE : 门店】	"STORE"
status	string	是	状态【 IN_OPERATION : 营业中 TO_BE_OPENED : 待开业 PREPARATION : 筹备中 DELETE : 已删除】	"IN_OPERATION"
idChain	string	是	公司ID完整架构(上下级公司id用-连接)	"123-456"
slogan	string	否	公司标语	"努力工作就是为了不工作"
initConfig	string	是	公司配置是否初始化	"false"
merchantId	integer(int64)	是	商户ID	1
currencyId	integer(int64)	否	货币ID	1
image	string	否	图片
contact	ResContact	否
merchant	ResMerchant	是

com.leadwaycloud.rm.common.model.po.entity.ResContact

地址联系关系

名称	类型	必填	说明	示例
id	integer(int64)	否
countryId	integer(int64)	是	国家ID	1
stateId	integer(int64)	是	省、直辖市ID	1
cityId	integer(int64)	是	城市ID	1
areaId	integer(int64)	否	区、县ID	1
streetId	integer(int64)	否	街道ID	1
address	string	否	详细地址	"1"
postcode	string	否	邮编	"1"
phone	string	否	电话	"1"
mobile	string	否	手机	"1"
fax	string	否	传真	"1"
email	string	否	邮箱	"邮箱"
latLon	string	否	经纬度

com.leadwaycloud.rm.common.model.po.entity.ResMerchant

商户

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	是	商户代号	"lwc"
abbreviation	string	是	简称	"立威云"
fullName	string	是	全称	"成都立威云科技有限公司"
status	boolean	是	状态	false
industry	string	是	行业	"COMPLEX"
email	string	是	联系邮箱(用作初始化创建账号)	"sale@leadwaycloud.com"
phone	string	否	联系电话
address	string	否	联系地址
logo	string	否	图标

com.leadwaycloud.rm.common.model.po.entity.RmCashier

收银员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
account	string	是	账号	"131131"
password	string	是	密码	"111111"
status	string	是	状态【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除】	"ACTIVE"
type	string	是	类型【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员】	"CASHIER"
employeeId	integer(int64)	否	员工ID	1
image	string	否	头像/形象图片 URL	"https://cdn.example.com/cashier/001.png"

com.leadwaycloud.rm.common.model.po.entity.RmDevicePos_Simple

机台(简略)

名称	类型	必填	说明	示例
id	integer(int64)	否
companyId	integer(int64)	是	公司
code	string	是	编号	"POS001"
status	string	是	状态	"INACTIVATED"
description	string	否	描述
applicationVersion	string	否	应用版本
registerTime	string	否	激活时间	"2020-10-11 10:09:11"
deviceName	string	否	设备名称	"MacBook-Pro-zkl.local"
deviceOSType	string	否	设备操作系统类型	"macOS Catalina"
deviceOSVersion	string	否	设备操作系统版本	"10.15.7"
deviceMacAddress	string	否	设备MAC地址	"88:E9:FE:7B:DA:75"
deviceKey	string	否	设备唯一标识	"OJ0789I0UR290UR2393U82"
defStockWarehouseId	integer(int64)	否	非油商品默认扣减库存仓库ID	1
registrationCode	string	否	POS注册码(Windows激活码格式)	"ABCDE-FGHJK-LMNPR-STUVW-XY234"

com.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

商城自提点

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"银泰城永辉超市"
code	string	是	标识	"...."
type	string	是	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	是	联络人	"张三"
phone	string	是	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	是	是否可用	true
latLon	string	是	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

com.leadwaycloud.rm.common.model.po.entity.RmOrder

订单

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
itemCount	integer(int32)	否	商品条数
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAID : 部分付款 PAY_FINISH : 付款完成】	"PAID"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
purchaseStatus	string	否	采购状态【 BE_PROCURED : 待采购 ONGOING : 采购中 PURCHASED : 已采购】	"BE_PROCURED"
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
vatAmount	number(double)	是	订单税额	100
associateOrderId	integer(int64)	否	关联销售订单ID
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
endPaymentTime	string	否	付款截止时间	"2020-10-11 13:09:11"
customerNote	string	否	客户备注	"..."
merchantNote	OrderMerchantNoteBO[]	否	商户备注(仅仅在ERP上展示)	[{"note":"...","time":"2020-12-11 12:23:12"}]
reason	string	否	交易理由
verifyType	string	否	审核类型【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号,KDS叫号编号)
attachmentList	AttachmentBO[]	否	附件
memberId	integer(int64)	否	会员ID
memberName	string	否	会员名称	"张三"
memberBarcode	string	否	会员编号	"215252342234232145"
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
salesPersonCode	string	否	业务员代号	"xxx"
posId	integer(int64)	否	机台ID	1
restaurantTableId	integer(int64)	否	桌位ID
fee	number(double)	否	运费
acceptSplittingDelivery	boolean	否	是否接受拆单发货
thirdPartyId	integer(int64)	否	thirdPartyId
associateOrder	RmOrder	否
orderItemList	RmOrderItem[]	是	订单商品
orderMember	RmOrderMember	否
orderPos	RmOrderPos	否
orderHandmadeDiscountList	RmOrderHandmadeDiscount[]	否	订单手工折扣
orderDeliveryMode	RmOrderDeliveryMode	否
orderRestaurant	RmOrderRestaurant	否
orderOilList	RmOrderOil[]	否	订单油品
customerInfo	RmPresaleOrderCustomerInfo	否
company	ResCompany	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderDeliveryMode

订单配送方式

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
deliveryMode	string	是	发货方式【 SELF : 自提/自送 EXPRESS : 快递】	"SELF"
fare	number(double)	否	运费	0
countryId	integer(int64)	否	国家ID
provinceId	integer(int64)	否	省份ID
cityId	integer(int64)	否	城市ID
areaId	integer(int64)	否	区ID
streetId	integer(int64)	否	街道ID
detailAddress	string	否	详细地址
receiver	string	否	收货人
phone	string	否	电话
selfPickupOutletsId	integer(int64)	否	商城自提网点
selfPickupDate	string(date)	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"
remark	string	否	备注
country	SysCountry	否
province	SysProvince	否
city	SysCity	否
area	SysArea	否
street	SysStreet	否
selfPickupOutlets	RmMallSelfPickupOutlets	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderHandmadeDiscount

订单手工折扣

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
cashierId	integer(int64)	是	授权收银员ID
type	string	否	折扣类型
lineNo	integer(int32)	否	行号	1
promAmount	number(double)	是	手工优惠金额	0
cashier	RmCashier	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderMember

订单会员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
memberId	integer(int64)	否	会员ID	1
barcode	string	否	会员编号	"215252342234232145"
name	string	否	会员名称	"张三"
type	integer(int64)	否	会员类型	1
sex	string	否	会员性别	"1"
age	integer(int32)	否	会员年龄	22
birthday	string	否	会员生日	"1999-11-11"
tags	string[]	否	会员标签	["健身"]
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxx"
customerPersonName	string	否	客户联系人名称	"xxx"
customerPersonPhone	string	否	客户联系人手机号	"xxx"
businessUser	string	否	业务代表名称	"xxx"
businessPhone	string	否	业务代表手机号	"xxx"
member	SimpleCrmMember	是

com.leadwaycloud.rm.common.model.po.entity.RmOrderOil

订单油品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
shiftNo	integer(int64)	否	班次号	1
orderId	integer(int64)	是	订单ID
orderItemId	integer(int64)	是	订单品项ID	1
tank	string	是	油罐	"1"
pump	string	是	油泵	"1"
nozzle	string	是	油枪	"1"
pumpStartNumber	number(double)	是	起泵码	100
pumpEndNumber	number(double)	是	止泵码	150
machineOut	number(double)	是	油机付出	50
tradCode	string	是	交易号	"12345"
tradTime	string	是	交易时间	"2020-11-11 10:20:39"

com.leadwaycloud.rm.common.model.po.entity.RmOrderPos

订单机台

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
orderId	integer(int64)	是	订单ID
posId	integer(int64)	是	机台ID
cashierId	integer(int64)	否	收银员ID
shiftNo	integer(int64)	否	班次号	1
shiftDate	string	是	班次日	"2020-10-11"
pkNo	integer(int64)	否	流水号	1
operator	string	否	操作员
cateringOrderType	string	否	机台餐饮订单类型【 DINE_IN : 堂食 DINE_OUT : 外带 TAKEOUT : 外卖】
cateringOrderStatus	string	否	机台餐饮订单状态【 BE_PRODUCED : 待制作 PRODUCTION : 制作中 BE_PICKED : 待取餐 PICKED : 已取餐】
pos	RmDevicePos_Simple	是
cashier	RmCashier	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderRestaurant

订单桌位信息

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
restaurantTable	RmRestaurantTable	否
consumerCount	integer(int32)	是	用餐人数	1
diningTime	string	是	用餐时间	"2020-10-11 13:09:11"
notes	string	否	备注

com.leadwaycloud.rm.common.model.po.entity.RmPresaleOrderCustomerInfo

预购单客户信息

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
assetId	integer(int64)	是	设备ID	1
orderId	integer(int64)	否	预售单ID	1
posNo	string	是	pos号	"1"
transNo	string	是	交易号	"1"
receipt	string	是	小票	"1"
note	string	否	备注	"1"
activeId	integer(int64)	是	活动ID	1
customerName	string	是	客户名称	"1"
phone	string	是	电话	"1"
backupPhone	string	否	备用电话	"1"
receiveMode	string	否	提货方式【 STORE_SELF : 门店自提 SUPPLY_POINT_SELF : 供应商自提 HOME_DELIVERY : 送货上门】	"STORE_SELF"
address	string	否	地址	"1"
archive	boolean	否	是否归档	false

com.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

桌位

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
code	string	是	桌位号	"C001"
floor	integer(int32)	是	楼层	1
active	boolean	是	是否可用	true
info	string	否	桌位详细信息	"前端自定义json字符串"
externalId	string	否	外部系统ID

com.leadwaycloud.rm.common.model.po.entity.SimpleCrmMember

会员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
barcode	string	是	会员编号	"002391117577753472"
status	string	是	会员状态【 ACTIVE : 活跃的 LOCK : 锁定的】	"ACTIVE"
name	string	是	名称	"张三"
mobilePhone	string	是	手机号码	"张三"
realName	string	否	真实名称
otherBarcode	string	否	第三方条码
source	string	是	会员来源
typeId	string	是	会员类型
partnerId	integer(int64)	是	关系ID

com.leadwaycloud.rm.common.model.po.entity.SysArea

区/县

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	区/县代号
name	string	是	名称	"东城区"

com.leadwaycloud.rm.common.model.po.entity.SysCity

城市

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	城市代号
name	string	是	名称	"市辖区"

com.leadwaycloud.rm.common.model.po.entity.SysCountry

国家/地区

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	国际代码	"CN"
name	string	是	名称	"中国"

com.leadwaycloud.rm.common.model.po.entity.SysProvince

省/州/自治区/直辖市

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	省/州/自治区/直辖市代号
name	string	是	名称	"北京市"

com.leadwaycloud.rm.common.model.po.entity.SysStreet

街道/乡镇

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	街道/镇代号
name	string	是	名称	"东华门街道"

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForSaleDTO

订单

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
memberId	integer(int64)	否	会员ID	1
customerId	integer(int64)	否	客户ID	1
customerPersonId	integer(int64)	否	客户联系人ID	1
customerNote	string	否	客户备注
reason	string	否	交易理由
associateOrderId	integer(int64)	否	关联订单ID
acceptSplittingDelivery	boolean	否	是否接受拆单发货
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForSaleReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderHandmadeDiscList	OrderCreateHandmadeDiscForSaleDTO[]	否	订单手工折扣
orderPos	OrderCreatePosForSaleDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

com.leadwaycloud.rm.order.business.create.dto.OrderCreateHandmadeDiscForSaleDTO

订单手工折扣

名称	类型	必填	说明	示例
cashierId	integer(int64)	否	授权收银员
type	string	否	折扣类型
lineNo	integer(int32)	否	行号(如果为null或者0则表示属于整个订单)	1
promAmount	number(double)	是	手工优惠金额	0

com.leadwaycloud.rm.order.business.create.dto.OrderCreatePosForSaleDTO

订单机台

名称	类型	必填	说明	示例
posId	integer(int64)	是	机台ID	1
cashierId	integer(int64)	否	收银员ID	1
shiftNo	integer(int64)	否	班次号	1
shiftDate	string	否	班次日	"2020-10-11"
pkNo	integer(int64)	否	流水号	1
operator	string	否	操作员
cateringOrderType	string	否	机台餐饮订单类型【 DINE_IN : 堂食 DINE_OUT : 外带 TAKEOUT : 外卖】

com.leadwaycloud.rm.order.business.create.dto.OrderCreateRestaurantForSaleDTO

订单桌位

名称	类型	必填	说明	示例
restaurantTableId	integer(int64)	是	桌位ID	1
consumerCount	integer(int32)	是	用餐人数	1
diningTime	string	是	用餐时间	"2020-10-11 13:09:11"
notes	string	否	备注

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForRefundDTO

订单

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
associateOrderId	integer(int64)	是	关联订单ID
customerNote	string	否	客户备注
reason	string	否	交易理由
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForRefundReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForOtherDTO

订单

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
type	string	是	类型	"SALE"
associateOrderId	integer(int64)	否	关联订单ID
scale	integer(int32)	否	金额计算精度	2
vatAmount	number(double)	否	订单税额	100

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForOtherReqDTO

名称	类型	必填	说明
order	OrderCreateForOtherDTO	是
orderItemList	OrderCreateItemForOtherDTO[]	否	订单商品
orderPos	OrderCreatePosForOtherDTO	否

com.leadwaycloud.rm.order.business.create.dto.OrderCreateItemForOtherDTO

订单商品

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
itemId	integer(int64)	是	零售商品ID	1
itemBarcodeId	integer(int64)	是	零售商品条码ID	1
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	否	商品单价	35
totalAmount	number(double)	否	商品总金额	35
promAmount	number(double)	否	商品优惠金额	0
amount	number(double)	否	商品金额	35
vatAmount	number(double)	否	商品税额	100
remark	string	否	备注

com.leadwaycloud.rm.order.business.create.dto.OrderCreatePosForOtherDTO

机台

名称	类型	必填	说明	示例
posId	integer(int64)	是	机台ID	1
cashierId	integer(int64)	否	收银员ID	1
shiftNo	integer(int64)	否	班次号	1
shiftDate	string	否	班次日	"2020-10-11"
pkNo	integer(int64)	否	流水号	1
operator	string	否	操作员

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForExchangeDTO

订单

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
associateOrderId	integer(int64)	是	关联订单ID
customerNote	string	否	客户备注
reason	string	否	交易理由
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.business.create.dto.OrderCreateForExchangeReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

com.leadwaycloud.rm.order.business.confirm.dto.OrderConfirmReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1
customerNote	string	否	客户备注	"xxx"
merchantNote	string	否	商户备注	"xxx"

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForStoreReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderHandmadeDiscList	OrderCreateHandmadeDiscForSaleDTO[]	否	订单手工折扣
orderPos	OrderCreatePosForSaleDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderRestaurant	OrderCreateRestaurantForSaleDTO	否

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitSaleForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForSaleDTO	否
orderItemList	OrderCreateItemForSaleDTO[]	否	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	否

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForStoreReqDTO

名称	类型	必填	说明	示例
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitRefundForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForRefundDTO	是
orderItemList	OrderCreateItemForRefundDTO[]	是	订单商品
orderDeliveryMode	OrderCreateDeliveryModeDTO	是

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitExchangeForMobileReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

com.leadwaycloud.rm.order.business.commit.dto.OrderCommitExchangeForMallReqDTO

名称	类型	必填	说明
order	OrderCreateForExchangeDTO	是
orderDeliveryMode	OrderCreateDeliveryModeDTO	否
orderItemList	OrderCreateItemForExchangeDTO[]	是	订单商品

com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForSaleReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForRefundReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

com.leadwaycloud.rm.order.business.cancel.dto.OrderCancelForExchangeReqDTO

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
memberId	integer(int64)	否	会员ID	1

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderAmountVO	否

com.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO

返回数据

名称	类型	必填	说明	示例
orderAmountInfo	OrderAmountVO$OrderAmountInfoVO	是
orderItemAmountInfoList	OrderAmountVO$OrderItemAmountInfoVO[]	是	订单项金额明细

com.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO$OrderAmountInfoVO

订单金额明细

名称	类型	必填	说明	示例
scale	integer(int32)	否	金额计算精度	2
totalAmount	number(double)	否	总金额	100
promAmount	number(double)	否	交易优惠金额	0
fee	number(double)	否	运费
orderAmount	number(double)	否	订单金额	100
vatAmount	number(double)	否	订单税额	100

com.leadwaycloud.rm.order.business.calc.vo.OrderAmountVO$OrderItemAmountInfoVO

订单项金额明细

名称	类型	必填	说明	示例
lineNo	integer(int32)	是	行号	1
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
quotationCode	string	否	报价单编号
quotationOutsideCode	string	否	外部报价单编号
vatRatio	number(double)	否	商品税率	0.5
price	number(double)	否	商品单价	35
totalAmount	number(double)	否	商品总金额	35
promAmount	number(double)	否	商品优惠金额	0
amount	number(double)	否	商品金额	35
vatAmount	number(double)	否	商品税额	100

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.search.vo.ItemServiceQuotaVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ItemServiceQuotaVO[]	否	返回数据

com.leadwaycloud.rm.order.business.search.vo.ItemServiceQuotaVO

返回数据

名称	类型	必填	说明	示例
goodsBarcodeId	integer(int64)	是	商品条码ID	1
surplusQuota	number(double)	是	剩余可操作数量/重量	1

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.order.business.search.vo.ItemDeliveryQuotaVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ItemDeliveryQuotaVO[]	否	返回数据

com.leadwaycloud.rm.order.business.search.vo.ItemDeliveryQuotaVO

返回数据

名称	类型	必填	说明	示例
goodsBarcodeId	integer(int64)	是	商品条码ID	1
surplusQuota	number(double)	是	剩余可操作数量/重量	1
realSurplusQuota	number(double)	是	实际剩余可操作数量/重量	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.UnlockOrderStockDTO

解锁销售订单商品库存数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	公司ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.SubmitMallSaleOrderDTO

提交商城销售订单数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"WECHAT_MINI_APPS"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	是
orderItemList	OrderItemDTO[]	是	订单商品
orderDeliveryMode	OrderDeliveryModeDTO	是
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
saveTime	integer(int32)	否	订单保留时间(小时)。线上订单提供该数据时，会根据下单时间+saveTime来确定订单自动过期时间，如果没有传则默认12小时	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderDeliveryItemDTO

商城订单物流商品数据模版

名称	类型	必填	说明	示例
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
brandId	integer(int64)	否	品牌ID	1
snapshot	string	否	商品快照
amount	number(double)	否	商品金额	35
rmItemId	integer(int64)	是	零管商品ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReturnApplyDTO

商城订单退货申请数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	销售订单ID	1
orderDeliveryItemList	MallOrderDeliveryItemDTO[]	否	订单配送包含的商品
reason	string	否	交易理由

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReceiveDTO

商城订单收货数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	否	订单ID(参数三选一)	1
orderCode	string	否	订单编号(参数三选一)	"1"
orderDeliveryId	integer(int64)	否	订单配送ID(参数二选一,如果没有传则对订单所有配送记录进行收货)	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderPaymentFinishDTO

商城订单付款完成数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.LockOrderStockDTO

锁定销售订单商品库存数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderDeliveryDTO

商城订单发货数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
self	boolean	是	是否自提	false
expressId	integer(int64)	否	合作快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
orderDeliveryItemList	MallOrderDeliveryItemDTO[]	否	订单配送包含的商品
stockMoveId	integer(int64)	否	出库单ID	1
unStockDelivery	boolean	否	无库存发货	false

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderReturnDTO

商城订单退货数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1
self	boolean	是	是否自退	false
expressId	integer(int64)	否	合作的快递公司ID	3
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	自提点ID	1
fare	number(double)	否	运费	0
selfPickupDate	string	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderRefundFinishDTO

商城退货订单退款完成数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallReturnApplyProcessDTO

商城退货订单申请处理数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	退货订单ID	1
pass	boolean	是	是否通过	false

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.MallOrderAddMerchantNoteDTO

商城订单商户备注数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1
merchantNote	OrderMerchantNoteBO	是

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreSaleOrderDTO

提交门店销售订单数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO[]	是	订单商品
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否
orderHandmadeDiscountList	OrderHandmadeDiscountDTO[]	否	订单手工折扣

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreRefundOrderDTO

提交门店退款订单数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
orderAmount	number(double)	是	订单金额	100
associateOrderCode	string	是	关联订单单号
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreOtherTypeOrderDTO

提交门店其他类型订单数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
type	string	是	类型	"SALE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	优惠金额	0
orderAmount	number(double)	是	订单金额	100
associateOrderCode	string	否	关联订单单号
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO	否
customerNote	string	否	客户备注
reason	string	否	交易理由
orderRestaurant	OrderRestaurantDTO	否

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.SubmitStoreOrderDTO

提交门店订单数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
type	string	是	交易类型	"SALE"
code	string	是	编号	"0989681627412313123"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
paid	string	否	是否已经支付	"false"
orderMember	OrderMemberDTO	否
orderPos	OrderPosDTO	否
orderItemList	OrderItemDTO[]	否	订单商品
customerNote	string	否	客户备注
reason	string	否	交易理由
associateOrderCode	string	否	关联订单单号(退款交易时提供)
orderRestaurant	OrderRestaurantDTO	否

com.leadwaycloud.core.model.RJava.lang.Long

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.StoreOrderPaymentFinishDTO

门店订单付款完成数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmTradeReason[]	否	返回数据

com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Double

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery[]	否	返回数据

com.leadwaycloud.rm.common.model.po.entity.RmExpress

合作快递公司

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
express	SysExpress	是
active	boolean	是	是否开放	true
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

com.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

订单配送

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	否	编号	"1"
orderId	integer(int64)	是	订单ID
self	boolean	是	是否自提	true
expressId	integer(int64)	否	合作快递公司
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	商城自提网点ID
receive	boolean	否	是否已经收货	false
stockMoveId	integer(int64)	否	出库单ID	1
selfTakeCode	string	否	提货码
autoReceiveTime	string	否	自动收货时间	"2020-10-11 13:09:11"
receiveTime	string	否	收货时间	"2020-10-11 13:09:11"
amount	number(double)	是	金额	35
vatAmount	number(double)	是	税额	100
itemCount	integer(int32)	是	发货商品项	1
allowReconcile	boolean	否	是否允许对账	false
reconcileStatus	string	否	对账状态【 NONE : 未对账 ING : 进行中 CONFIRM : 已确认 INVOICE : 已开票】	"ING"
remark	string	否	备注
reserved1	string	否	备用字段1(发货地址)
reserved2	string	否	备用字段2(CRM发货单ID)
reserved3	string	否	备用字段3(SAP发货单号)
reserved4	string	否	备用字段4(SAP贷项凭证申请号)
order	RmOrder	是
express	RmExpress	否
selfPickupOutlets	RmMallSelfPickupOutlets	否
orderDeliveryItemList	RmOrderDeliveryItem[]	否	订单物流包含的商品

com.leadwaycloud.rm.common.model.po.entity.RmOrderDeliveryItem

订单配送商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
deliveryId	integer(int64)	是	发货单ID
orderItemId	integer(int64)	是	零管商品ID	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
brandId	integer(int64)	否	品牌ID	1
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
amount	number(double)	是	商品金额	35
vatAmount	number(double)	是	商品税额	100
remark	string	否	备注

com.leadwaycloud.rm.common.model.po.entity.SysExpress

系统快递公司

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	参数code	"ems"
name	string	是	名称	"EMS快递"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.SimpleRmOrder

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SimpleRmOrder[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.SimpleRmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SimpleRmOrder	否

com.leadwaycloud.rm.common.model.po.entity.OnlyRmOrder

关联订单

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
itemCount	integer(int32)	否	商品条数
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAID : 部分付款 PAY_FINISH : 付款完成】	"PAID"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
purchaseStatus	string	否	采购状态【 BE_PROCURED : 待采购 ONGOING : 采购中 PURCHASED : 已采购】	"BE_PROCURED"
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
vatAmount	number(double)	是	订单税额	100
associateOrderId	integer(int64)	否	关联销售订单ID
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
endPaymentTime	string	否	付款截止时间	"2020-10-11 13:09:11"
customerNote	string	否	客户备注	"..."
merchantNote	OrderMerchantNoteBO[]	否	商户备注(仅仅在ERP上展示)	[{"note":"...","time":"2020-12-11 12:23:12"}]
reason	string	否	交易理由
verifyType	string	否	审核类型【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号,KDS叫号编号)
attachmentList	AttachmentBO[]	否	附件
memberId	integer(int64)	否	会员ID
memberName	string	否	会员名称	"张三"
memberBarcode	string	否	会员编号	"215252342234232145"
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
salesPersonCode	string	否	业务员代号	"xxx"
posId	integer(int64)	否	机台ID	1
restaurantTableId	integer(int64)	否	桌位ID
fee	number(double)	否	运费
acceptSplittingDelivery	boolean	否	是否接受拆单发货
thirdPartyId	integer(int64)	否	thirdPartyId

com.leadwaycloud.rm.order.model.po.entity.SimpleRmOrder

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
itemCount	integer(int32)	否	商品条数
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAID : 部分付款 PAY_FINISH : 付款完成】	"PAID"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
purchaseStatus	string	否	采购状态【 BE_PROCURED : 待采购 ONGOING : 采购中 PURCHASED : 已采购】	"BE_PROCURED"
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
vatAmount	number(double)	是	订单税额	100
associateOrderId	integer(int64)	否	关联销售订单ID
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
endPaymentTime	string	否	付款截止时间	"2020-10-11 13:09:11"
customerNote	string	否	客户备注	"..."
merchantNote	OrderMerchantNoteBO[]	否	商户备注(仅仅在ERP上展示)	[{"note":"...","time":"2020-12-11 12:23:12"}]
reason	string	否	交易理由
verifyType	string	否	审核类型【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号,KDS叫号编号)
attachmentList	AttachmentBO[]	否	附件
memberId	integer(int64)	否	会员ID
memberName	string	否	会员名称	"张三"
memberBarcode	string	否	会员编号	"215252342234232145"
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
salesPersonCode	string	否	业务员代号	"xxx"
posId	integer(int64)	否	机台ID	1
restaurantTableId	integer(int64)	否	桌位ID
fee	number(double)	否	运费
acceptSplittingDelivery	boolean	否	是否接受拆单发货
thirdPartyId	integer(int64)	否	thirdPartyId
associateOrder	OnlyRmOrder	否
orderItemList	RmOrderItem[]	是	订单商品
orderMember	RmOrderMember	否
orderPos	RmOrderPos	否
orderDeliveryMode	RmOrderDeliveryMode	否
orderRestaurant	RmOrderRestaurant	否

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.history.model.VO.order.OrderVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	OrderVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.history.model.VO.order.OrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	OrderVO	否

com.leadwaycloud.rm.common.business.eps.model.bo.TenderConfigBO

支付方式扩展配置

名称	类型	必填	说明	示例
retalixCode	string	否	Retalix支付方式编号	"1"
epsCode	string	否	EPS支付方式编号	"1"
lpeCode	string	否	LPE支付方式编号	"1"
authCodePrefix	string[]	否	移动支付二维码前缀	1
discTender	boolean	否	是否属于折扣类支付方式	true
mappingTenderId	integer(int64)	否	折扣类支付方式,对应的支付方式ID	1
discType	string	否	discType	"油品折扣:OIL_DISC,非油折扣:NON_OIL_DISC "

com.leadwaycloud.rm.common.model.po.entity.CrmAccountType

CRM账户类型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
type	string	是	类型【 MEMBER : 会员 CUSTOM : 客户 SUPPLIER : 供应商 EMPLOYEE : 员工 FRANCHISEE : 加盟商 CARRIER : 承运商 AGENT : 代理商】	"MEMBER"
code	string	是	编号	"BALANCE"
name	string	是	名称	"余额账户"
changeValue	number(double)	否	兑换值(多少兑换值可换1元现金)	3

com.leadwaycloud.rm.common.model.po.entity.RmEpsOrder

EPS订单

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
code	string	是	EPS订单编号	"0989681627412313123"
type	string	是	EPS订单类型【 PAYMENT : 付款 REFUND : 退款】	"PAYMENT"
status	string	是	订单状态【 INVALID : 无效 ING : 处理中 BE_CONFIRM : 待确认 CONFIRM : 已确认 VALID : 有效】	"VALID"
orderCode	string	否	订单中心订单编号(手动退款时,没有订单中心订单编号(退款交易单号))	"1989681627412313123"
originalOrderCode	string	否	订单中心订单编号(退款订单时提供,原订单中心订单编号)	"1989681627412313123"
memberBarcode	string	否	会员编号	"002391117577753472"
tenderId	integer(int64)	是	支付方式ID
orderAmount	number(double)	否	订单金额	100
payTime	string	否	付款时间	"2020-10-11 13:09:11"
realPayAmount	number(double)	否	付款/退款金额（发起付款金额）	100
promAmount	number(double)	否	付款优惠金额	100
payAmount	number(double)	否	付款/退款金额(最终付款金额)	100
platformOrderCode	string	否	第三方支付平台订单编号	"2020072322001410740504760505"
remark	string	否	订单备注
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
verifyType	string	否	'审核类型' 【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(招行支付url)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3
tender	RmTender	是
finish	boolean	否	订单是否已经付款/退款完成	false

com.leadwaycloud.rm.common.model.po.entity.RmTender

支付方式

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
code	string	是	代号	"CASH"
name	string	是	名称	"现金"
otherName	string	否	别名	"钞票"
type	string	是	类型【 CASH : 现金 MOBILE : 移动支付 MEMBER_ACCOUNT : 会员账户 CREDIT : 信用支付 OFFLINE : 线下支付 BANK_CARD : 银行卡支付】	"CASH"
status	string	是	状态【 AVAILABLE : 可用的 STOP : 停用的 DELETE : 删除的】	"AVAILABLE"
image	string	否	图片
vat	boolean	否	是否可开发票	true
accountType	CrmAccountType	否
mobilePaymentType	string	否	移动支付类型【 WECHAT : 微信 ALIPAY : 支付宝 CMB : 招商B2B CMB_SCAN : 招商聚合支付 OTHER : 其他】	"WECHAT"
system	boolean	否	是否由系统默认	true
description	string	否	描述
financeTenderId	integer(int64)	是	财务付款方式ID	1
otherCode	string	否	其他编号	"CASH"
tenderConfig	TenderConfigBO	是
reserved1	string	否	备用字段1(收款人户名)
reserved2	string	否	备用字段2(银行账户)
reserved3	string	否	备用字段3(开户银行)

com.leadwaycloud.rm.order.business.history.model.VO.order.OrderVO

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAID : 部分付款 PAY_FINISH : 付款完成】	"PAID"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号)
orderItemList	RmOrderItem[]	是	订单商品
orderMember	RmOrderMember	否
orderPos	RmOrderPos	否
orderRestaurant	RmOrderRestaurant	否
epsOrderList	RmEpsOrder[]	否	支付信息
orderOilList	RmOrderOil[]	否	订单油品

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmOrderDelivery

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrderDelivery	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrder

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	RmOrder[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrder

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmOrder	否

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmPresaleOrderCustomerInfo

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	RmPresaleOrderCustomerInfo[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmPresaleOrderCustomerInfo

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPresaleOrderCustomerInfo	否

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	RmPosOrderJournal[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.model.po.entity.RmPosOrderJournal

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RmPosOrderJournal	否

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyDetailVO	否

com.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyDetailVO

返回数据

名称	类型	必填	说明	示例
reconcileApply	RmReconcileApply	否
reconcileApplyDetailList	RmReconcileApplyDetail[]	否	对账申请明细

com.leadwaycloud.rm.order.model.po.entity.RmReconcileApply

对账申请

名称	类型	必填	说明	示例
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
id	integer(int64)	是	ID	1
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司ID
year	integer(int32)	是	年
month	integer(int32)	是	月
code	string	是	编号
otherCode	string	否	客户对账单号
status	string	否	状态【 DRAFT : 草稿 CONFIRM : 已确认 FINISH : 已完成 VOID : 已作废】
customerConfirm	boolean	否	客户是否已经确认	false
customerId	integer(int64)	是	客户ID	1
customerCode	string	是	客户编号	"xxx"
customerReconciledCode	string	是	客户对账代码【 _0001 : 立即支付 ZCM0 : 月底结算 ZC30 : 月结30天 ZC60 : 月结60天 ZC90 : 月结90天】	"xxx"
customerName	string	是	客户名称	"xxx"
customerTaxCode	string	否	客户纳税号	"xxx"
customerAddress	string	否	客户地址	"xxx"
customerPhone	string	否	客户联系电话	"xxx"
customerBank	string	否	客户开户银行	"xxx"
customerBankAccount	string	否	客户开户银行帐号	"xxx"
contactPersonName	string	否	客户联系人	"xxx"
contactPersonPhone	string	否	客户联系人电话	"xxx"
receiveInvoiceAddress	string	否	收票地址	"xxx"
payMethod	string	否	付款方式	"xxx"
totalAmount	number(double)	是	货款总额
totalVatAmount	number(double)	是	货款总税额
invoiceRequire	string	否	开票要求	"xxx"
contractOrder	boolean	否	是否合同订单	false
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
remark	string	否	备注	"xxx"
attachmentList	AttachmentBO[]	否	附件

com.leadwaycloud.rm.order.model.po.entity.RmReconcileApplyDetail

对账申请明细

名称	类型	必填	说明	示例
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
id	integer(int64)	是	ID	1
applyId	integer(int64)	是	申请单ID
deliveryId	integer(int64)	是	发货单ID
lineNo	integer(int32)	是	行号
deliveryDate	string	是	发货日期	"2020-10-11"
deliveryCode	string	否	发货单号
orderId	integer(int64)	是	订单ID
orderCode	string	是	订单号
customerOrderCode	string	否	客户订单号
goodsName	string	是	商品名称
goodsSpec	string	否	商品规格
qty	integer(int32)	是	商品数量
weight	number(double)	否	商品重量
pack	string	否	商品单位
shortPack	string	否	商品单位
isoShortPack	string	否	商品单位
price	number(double)	是	商品单价
amount	number(double)	是	商品金额
vatAmount	number(double)	是	商品税额
vatRatio	number(double)	是	税率
remark	string	否	备注
reserved1	string	否	备用字段1(客户物料编码)
reserved2	string	否	备用字段2(客户物料规格)
reserved3	string	否	备用字段3(SAP发货单号、SAP贷项凭证申请号、SAP订单号)

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ReconcileApplyVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyVO	否

com.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyVO

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	是	ID
year	integer(int32)	是	年
month	integer(int32)	是	月
code	string	是	编号
otherCode	string	否	客户对账单号
status	string	否	状态【 DRAFT : 草稿 CONFIRM : 已确认 FINISH : 已完成 VOID : 已作废】
customerConfirm	boolean	否	客户是否已经确认	false
customerCode	string	是	客户编号	"xxx"
customerName	string	是	客户名称	"xxx"
customerPhone	string	否	客户联系电话	"xxx"
contactPersonName	string	是	客户联系人	"xxx"
contactPersonPhone	string	是	客户联系人电话	"xxx"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyPrintDataVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReconcileApplyPrintDataVO	否

com.leadwaycloud.rm.order.business.reconcile.vo.ReconcileApplyPrintDataVO

返回数据

名称	类型	必填	说明
totalAmount	number(double)	否	总额
confirmUser	string	否	经办人
businessSignet	string	否	业务专用章
reconcileApply	RmReconcileApply	否
reconcileApplyDetailList	RmReconcileApplyDetail[]	否	对账申请明细

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	DetailOrderVO	否

com.leadwaycloud.rm.common.business.order.mdoel.vo.DetailOrderVO

返回数据

名称	类型	必填	说明
orderInfo	OrderVO	是
orderPosInfo	OrderPosVO	否
orderMemberInfo	OrderMemberVO	否
orderItemInfoList	OrderItemVO[]	否	订单商品信息
orderDeliveryModeInfo	OrderDeliveryModeVO	否
orderAssociateOrderInfo	OrderAssociateOrderVO	否
orderDeliveryInfoList	OrderDeliveryVO[]	否	订单配送信息
orderPayInfoList	OrderPaymentVO[]	否	订单付款信息
orderRestaurantInfo	OrderRestaurantVO	否
orderHandmadeDiscInfoList	OrderHandmadeDiscountVO[]	否	订单手工折扣信息

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderAssociateOrderVO

关联订单信息

名称	类型	必填	说明	示例
parentAssociateOrderInfo	OrderAssociateOrderVO$ParentAssociateOrderVO	否
childAssociateOrderInfoList	OrderAssociateOrderVO$ChildAssociateOrderVO[]	否	子级关联订单	1

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderAssociateOrderVO$ChildAssociateOrderVO

子级关联订单

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
orderTime	string	是	订单时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderAssociateOrderVO$ParentAssociateOrderVO

父级关联订单

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
parentAssociateOrderInfo	OrderAssociateOrderVO$ParentAssociateOrderVO	否

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderDeliveryModeVO

订单配送方式信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID
deliveryMode	string	是	发货方式【 SELF : 自提/自送 EXPRESS : 快递】	"SELF"
fare	number(double)	否	运费	0
countryId	integer(int64)	否	国家ID
countryName	string	否	国家名称
provinceId	integer(int64)	否	省份ID
provinceName	string	否	省份名称
cityId	integer(int64)	否	城市ID
cityName	string	否	城市名称
areaId	integer(int64)	否	区ID
areaName	string	否	区名称
streetId	integer(int64)	否	街道ID
streetName	string	否	街道名称
detailAddress	string	否	详细地址
receiver	string	否	收货人
phone	string	否	电话
selfPickupOutletsId	integer(int64)	否	商城自提网点
selfPickupOutletsCode	string	否	商城自提网点编号
selfPickupOutletsName	string	否	商城自提网点称名称
selfPickupOutletsAddress	string	否	商城自提网点称地址
selfPickupDate	string(date)	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderDeliveryVO

订单配送信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	否	编号	"1"
orderId	integer(int64)	是	订单ID
self	boolean	是	是否自提	true
expressId	integer(int64)	否	合作快递公司ID
expressCode	string	否	合作快递公司编号
expressName	string	否	合作快递公司名称
expressOrderCode	string	否	快递单号	"SF42524252343"
selfPickupOutletsId	integer(int64)	否	商城自提网点ID
selfPickupOutletsCode	string	否	商城自提网点编号
selfPickupOutletsName	string	否	商城自提网点称名称
receive	boolean	否	是否已经收货	false
stockMoveId	integer(int64)	否	出库单ID	1
selfTakeCode	string	否	提货码
autoReceiveTime	string	否	自动收货时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderHandmadeDiscountVO

订单手工折扣信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID
cashierId	integer(int64)	是	授权收银员ID
cashierAccount	string	是	授权收银员帐号
type	string	否	折扣类型
lineNo	integer(int32)	否	行号	1
promAmount	number(double)	是	手工优惠金额	0

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderItemVO

订单商品信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID
lineNo	integer(int32)	是	行号	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsTypeCode	string	是	商品类型编号	"xxx"
goodsTypeName	string	是	商品类型名称	"xxx"
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
packSymbol	string	是	包装	"瓶"
shortPack	string	是	包装	"瓶"
isoShortPack	string	是	包装	"瓶"
spec	string	否	规格
totalAmount	number(double)	是	总金额	35
promAmount	number(double)	是	商品优惠金额	0
amount	number(double)	是	商品金额	35
vatAmount	number(double)	是	商品税额	100
brandId	integer(int64)	否	品牌ID	1
brandCode	string	否	品牌编号	"1"
brandName	string	否	品牌名称	"xxx"
snapshot	string	否	商品快照(下单时商品的基本信息)
rmItemId	integer(int64)	是	零管商品ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
quotationCode	string	否	报价单编号
quotationOutsideCode	string	否	外部报价单编号
thirdpartyDelivery	boolean	否	是否第三方配送	false
acceptThirdpartyDelivery	boolean	否	是否接受第三方配送	false
thirdpartyPurchase	boolean	否	是否第三方采购	false
purchaseByOrder	boolean	否	是否按单采购	false
periodType	string	否	发货周期类型【 HOUR : 时 DAY : 天 WEEK : 周 MONTH : 月 YEAR : 年】
deliveryPeriod	string	否	发货周期
remark	string	否	备注
reserved1	string	否	备用字段1(客户物料编码)
reserved2	string	否	备用字段2(客户物料规格)
reserved3	string	否	备用字段3

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderMemberVO

订单会员信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID
memberId	integer(int64)	否	会员ID	1
barcode	string	否	会员编号	"215252342234232145"
name	string	否	会员名称	"张三"
type	integer(int64)	否	会员类型	1
sex	string	否	会员性别	"1"
age	integer(int32)	否	会员年龄	22
birthday	string	否	会员生日	"1999-11-11"
tags	string[]	否	会员标签	["健身"]
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
customerPersonPhone	string	否	客户联系人手机号	"xxx"
businessUser	string	否	业务代表名称	"xxx"
businessPhone	string	否	业务代表手机号	"xxx"

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderPaymentVO

订单付款信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
code	string	是	EPS订单编号	"0989681627412313123"
type	string	是	EPS订单类型【 PAYMENT : 付款 REFUND : 退款】	"PAYMENT"
status	string	是	订单状态【 INVALID : 无效 ING : 处理中 BE_CONFIRM : 待确认 CONFIRM : 已确认 VALID : 有效】	"VALID"
orderCode	string	否	订单中心订单编号(手动退款时,没有订单中心订单编号(退款交易单号))	"1989681627412313123"
originalOrderCode	string	否	订单中心订单编号(退款订单时提供,原订单中心订单编号)	"1989681627412313123"
memberBarcode	string	否	会员编号	"002391117577753472"
orderAmount	number(double)	否	订单金额	100
payTime	string	否	付款时间	"2020-10-11 13:09:11"
realPayAmount	number(double)	否	付款/退款金额（顾客实付,大于或等于payAmount）	100
payAmount	number(double)	否	付款/退款金额	100
platformOrderCode	string	否	第三方支付平台订单编号	"2020072322001410740504760505"
remark	string	否	订单备注
tenderId	integer(int64)	是	支付方式ID
tenderCode	string	是	支付方式编号
tenderOtherCode	string	否	支付方式其他编号
tenderName	string	是	支付方式名称
tenderOtherName	string	否	支付方式别名
tenderType	string	是	支付方式类型【 CASH : 现金 MOBILE : 移动支付 MEMBER_ACCOUNT : 会员账户 CREDIT : 信用支付 OFFLINE : 线下支付 BANK_CARD : 银行卡支付】	"CASH"
tenderImage	string	否	支付方式图片
tenderVat	boolean	否	支付方式是否可开票
tenderMobilePaymentType	string	否	移动支付类型【 WECHAT : 微信 ALIPAY : 支付宝 CMB : 招商B2B CMB_SCAN : 招商聚合支付 OTHER : 其他】	"WECHAT"
accountTypeCode	string	否	账户类型编号
accountTypeName	string	否	账户类型名称
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
verifyType	string	否	'审核类型' 【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(招行支付url、微信wap支付表单、支付宝wap支付表单)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderPosVO

订单机台信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
orderId	integer(int64)	是	订单ID
posId	integer(int64)	是	机台ID
posCode	string	是	机台编号
cashierId	integer(int64)	否	收银员ID
cashierAccount	string	否	收银员帐号
shiftNo	integer(int32)	否	班次号	1
shiftDate	string	是	班次日	"2020-10-11"
pkNo	integer(int32)	否	流水号	1
operator	string	否	操作员
cateringOrderType	string	否	机台餐饮订单类型【 DINE_IN : 堂食 DINE_OUT : 外带 TAKEOUT : 外卖】
cateringOrderStatus	string	否	机台餐饮订单状态【 BE_PRODUCED : 待制作 PRODUCTION : 制作中 BE_PICKED : 待取餐 PICKED : 已取餐】

com.leadwaycloud.rm.common.business.order.mdoel.vo.OrderRestaurantVO

订单桌位信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID
consumerCount	integer(int32)	是	用餐人数	1
diningType	string	是	用餐类型【 DINE_IN : 堂食 TAKE_AWAY : 外带】	"TAKE_AWAY"
diningTime	string	是	用餐时间	"2020-10-11 13:09:11"
notes	string	否	备注
floor	integer(int32)	是	楼层	1
code	string	是	桌位号	"C001"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.business.order.mdoel.vo.ListOrderVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ListOrderVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.business.order.mdoel.vo.ListOrderVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ListOrderVO	否

com.leadwaycloud.rm.common.business.order.mdoel.vo.ListOrderVO

当前页数据

名称	类型	必填	说明
orderInfo	OrderVO	是
orderPosInfo	OrderPosVO	否
orderMemberInfo	OrderMemberVO	否
orderItemInfoList	OrderItemVO[]	否	订单商品信息
orderDeliveryModeInfo	OrderDeliveryModeVO	否

com.leadwaycloud.core.model.RJava.lang.Object

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.rm.order.business.reconcile.dto.DeleteReconcileDeliveryDTO

名称	类型	必填	说明	示例
applyId	integer(int64)	是	对账申请ID
deleteDeliveryList	integer(int64)[]	否	需要删除的发货单

com.leadwaycloud.rm.order.business.history.model.DTO.order.mall.CancelMallOrderDTO

取消商城订单数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1

com.leadwaycloud.rm.order.business.history.model.DTO.order.store.CancelStoreOrderDTO

取消门店订单数据模版

名称	类型	必填	说明	示例
orderId	integer(int64)	是	订单ID	1