返回 API 文档索引

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

product-rm-store 版本 2.0.2 173 个接口 26 个分组 209 个模型 来源: https://api.leadwaycloud.com/lwc-cloud-erp-rm-store/v3/api-docs

服务地址

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

接口详情

PUT

/api/store-trade-reason/update

交易理由业务接口 交易理由修改接口 OperationId: update

调用方法

PUT /api/store-trade-reason/update

参数

请求体

Content-Type: application/json 必填:类型: UpdateTradeReasonReqDTO com.leadwaycloud.rm.store.business.trade.reason.dto.UpdateTradeReasonReqDTO

名称类型必填说明示例
tradeReasonIdinteger(int64)交易理由ID1
orderTypestring类型"SALE"
reasonstring交易理由

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmTradeReason
PUT

/api/store-server/update/{id}

门店服务器参数管理接口 修改门店服务器接口 OperationId: update_1

调用方法

PUT /api/store-server/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)门店服务器ID1

请求体

Content-Type: application/json 必填:类型: UpdateStoreServerDTO com.leadwaycloud.rm.store.business.store.server.dto.UpdateStoreServerDTO

名称类型必填说明示例
typestring服务类型"FUEL_SERVER"
codestring服务编号"001"
configstring服务配置

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer
PUT

/api/store-restaurant/update/{id}

门店餐厅管理接口 修改门店餐厅接口 OperationId: update_2

调用方法

PUT /api/store-restaurant/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)餐厅ID1

请求体

Content-Type: application/json 必填:类型: UpdateRestaurantDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantDTO

名称类型必填说明示例
namestring餐厅名称"C001"
activeboolean是否可用true
descriptionstring描述
externalIdstring外部系统ID
menuTemplateIdinteger(int64)菜单定义模版1
tableLayoutIdstring餐厅桌位布局"1"
imagesstring餐厅图片

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant
PUT

/api/store-restaurant-table/update/{id}

门店餐厅桌位管理接口 修改门店餐厅桌位接口 OperationId: update_3

调用方法

PUT /api/store-restaurant-table/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位ID1

请求体

Content-Type: application/json 必填:类型: UpdateRestaurantTableDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableDTO

名称类型必填说明示例
floorinteger(int32)楼层1
infostring桌位详细信息"前端自定义json字符串"
externalIdstring外部系统ID

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable
PUT

/api/store-restaurant-table/recovery/{id}

门店餐厅桌位管理接口 回收门店餐厅桌位接口 OperationId: recovery

调用方法

PUT /api/store-restaurant-table/recovery/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/store-restaurant-table/enable/{id}

门店餐厅桌位管理接口 启用门店餐厅桌位接口 OperationId: enable

调用方法

PUT /api/store-restaurant-table/enable/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/store-restaurant-table/batch-recovery

门店餐厅桌位管理接口 批量回收门店餐厅桌位接口 OperationId: batchRecovery

调用方法

PUT /api/store-restaurant-table/batch-recovery

参数

请求体

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

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

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/store-restaurant-table/batch-enable

门店餐厅桌位管理接口 批量启用门店餐厅桌位接口 OperationId: batchEnable

调用方法

PUT /api/store-restaurant-table/batch-enable

参数

请求体

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

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

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/store-restaurant-table-layout/update/{id}

门店餐厅桌位布局管理接口 修改门店餐厅桌位布局 OperationId: update_4

调用方法

PUT /api/store-restaurant-table-layout/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位布局ID1

请求体

Content-Type: application/json 必填:类型: UpdateRestaurantTableLayoutDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableLayoutDTO

名称类型必填说明示例
namestring名称"C001"
layoutboolean是否可用true

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout
PUT

/api/store-layout/v1/templates/{id}/scene-graph

布局模板 更新模板 scene_graph OperationId: updateSceneGraph

用于内置模板初始化或管理员补全

调用方法

PUT /api/store-layout/v1/templates/{id}/scene-graph

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: object

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateDetailDto
GET

/api/store-layout/v1/layouts/{id}

布局 布局详情 OperationId: getById

含 scene_graph、区域、通道、货架、layout_goods_slot 排面槽位

调用方法

GET /api/store-layout/v1/layouts/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)布局 ID1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto
PUT

/api/store-layout/v1/layouts/{id}

布局 更新布局 OperationId: update_5

更新 scene_graph 时自动同步 layout_zone/aisle/shelf/goods_slot 关系表

调用方法

PUT /api/store-layout/v1/layouts/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateLayoutRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpdateLayoutRequest

名称类型必填说明示例
namestring
codestring
floorWidthnumber
floorDepthnumber
sceneGraphstring
statusstring

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto
GET

/api/store-layout/v1/asset-presets/{id}

资产预设 资产预设详情 OperationId: getById_1

调用方法

GET /api/store-layout/v1/asset-presets/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto
PUT

/api/store-layout/v1/asset-presets/{id}

资产预设 更新资产预设 OperationId: update_6

调用方法

PUT /api/store-layout/v1/asset-presets/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpsertAssetPresetRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpsertAssetPresetRequest

名称类型必填说明示例
codestring
namestring
descriptionstring
categorystring
nodeTypestring
presetJsonstring
thumbnailUrlstring
modelUrlstring
visualModestring
sortOrderinteger(int32)

响应

状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto
DELETE

/api/store-layout/v1/asset-presets/{id}

资产预设 归档资产预设 OperationId: archive

调用方法

DELETE /api/store-layout/v1/asset-presets/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/printer/update/{id}

打印机管理接口 修改打印机接口 OperationId: update_7

调用方法

PUT /api/printer/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机ID1

请求体

Content-Type: application/json 必填:类型: UpdatePrinterDTO com.leadwaycloud.rm.store.business.printer.dto.UpdatePrinterDTO

名称类型必填说明示例
codestring编号"P001"
typestring类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】"THERMAL_TICKET"
namestring名称"1号票据打印机"
descriptionstring描述
printerConfigDTOUpdatePrinterConfigDTO
printTemplateListinteger(int64)[]打印模版(变更时把模版重新提交)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
PUT

/api/printer/update-status/{id}

打印机管理接口 - OperationId: updatePrinterStatus

调用方法

PUT /api/printer/update-status/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: string

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
PUT

/api/printer-template/update/{id}

打印机模版管理接口 修改打印机模版接口 OperationId: update_8

调用方法

PUT /api/printer-template/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机模版ID1

请求体

Content-Type: application/json 必填:类型: UpdatePrintTemplateDTO com.leadwaycloud.rm.store.business.printer.dto.UpdatePrintTemplateDTO

名称类型必填说明示例
typestring模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】"TRAN_TICKET"
namestring打印模版名称"交易小票"
contentstring模版内容
usableCompanyinteger(int64)[]可用公司1

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate
PUT

/api/pos/update/{id}

机台管理接口 修改机台接口 OperationId: update_9

调用方法

PUT /api/pos/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

Content-Type: application/json 必填:类型: UpdatePosDTO com.leadwaycloud.rm.store.business.pos.dto.UpdatePosDTO

名称类型必填说明示例
codestring编号"POS001"
descriptionstring描述
defStockWarehouseIdinteger(int64)非油商品默认扣减库存仓库ID1
posGroupIdinteger(int64)POS分组1
modestring机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】"POS"
bindingsstring绑定主POS设备列表

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
PUT

/api/pos/reset/{id}

机台管理接口 重置机台接口 OperationId: register

仅重置机台信息,相关的班次/流水/打印机关系不会被重置

调用方法

PUT /api/pos/reset/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
PUT

/api/pos/register

机台管理接口 注册机台接口 OperationId: register_1

调用方法

PUT /api/pos/register

参数

请求体

Content-Type: application/json 必填:类型: RegisterPosDTO com.leadwaycloud.rm.store.business.pos.dto.RegisterPosDTO

名称类型必填说明示例
merchantCodestring商户号"lwc"
companyCodestring公司编号"CD01"
posCodestring机台编号"POS001"
applicationVersionstring应用版本
deviceNamestring设备名称"MacBook-Pro-zkl.local"
deviceOSTypestring设备操作系统类型"macOS Catalina"
deviceOSVersionstring设备操作系统版本"10.15.7"
deviceMacAddressstring设备MAC地址"88:E9:FE:7B:DA:75"
deviceKeystring设备唯一标识"OJ0789I0UR290UR2393U82"
registrationCodestringPOS注册码(Windows激活码格式)"ABCDE-FGHJK-LMNPR-STUVW-XY234"
modelstring模式 【 POS : POS机台 SCO : 自助大屏 】"SCO"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
PUT

/api/pos/pos-group/update/{id}

机台管理接口 修改机台分组接口 OperationId: updatePosGroup

调用方法

PUT /api/pos/pos-group/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台分组ID1

请求体

Content-Type: application/json 必填:类型: UpdatePosGroupDTO com.leadwaycloud.rm.store.business.pos.dto.UpdatePosGroupDTO

名称类型必填说明示例
codestring编号"POS001"
namestring名称
descriptionstring描述
configstring配置详情"{}"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup
PUT

/api/pos/generate-registration-code/{id}

机台管理接口 生成机台注册码接口 OperationId: generateRegistrationCode

为未激活机台生成或重新生成 Windows 风格注册码

调用方法

PUT /api/pos/generate-registration-code/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
PUT

/api/oil/tank/update/{id}

油罐管理接口 修改油罐 OperationId: update_10

调用方法

PUT /api/oil/tank/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateOilTankDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilTankDTO

名称类型必填说明示例
codestring
namestring
maxVolumenumber(double)
alarmVolumenumber(double)
goodsIdinteger(int64)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTank
PUT

/api/oil/tank/update/standard-info/{id}

油罐管理接口 修改油罐规格信息(按规格ID) OperationId: updateTankStandardInfo

调用方法

PUT /api/oil/tank/update/standard-info/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateEnergyOilTankStandardInfoDTO

名称类型必填说明示例
heightnumber(double)油罐高度
volumenumber(double)油罐体积(对应 tank_capacity)
seqinteger(int32)排序序号
highCapacityAlarmnumber(double)高液位报警
highCapacityWarningnumber(double)高液位预警
lowCapacityAlarmnumber(double)低液位报警
lowCapacityWarningnumber(double)低液位预警
highWaterWarningnumber(double)高水位预警
highWaterAlarmnumber(double)高水位报警
lowWaterAlarmnumber(double)低水位报警
gainRationumber(double)增益系数
lossRationumber(double)损耗系数
warningTemperaturenumber(double)预警温度

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
PUT

/api/oil/tank/update/standard-info/tank/{tankId}

油罐管理接口 修改油罐规格信息(按油罐ID,一罐一条) OperationId: updateTankStandardInfoByTank

调用方法

PUT /api/oil/tank/update/standard-info/tank/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateEnergyOilTankStandardInfoDTO

名称类型必填说明示例
heightnumber(double)油罐高度
volumenumber(double)油罐体积(对应 tank_capacity)
seqinteger(int32)排序序号
highCapacityAlarmnumber(double)高液位报警
highCapacityWarningnumber(double)高液位预警
lowCapacityAlarmnumber(double)低液位报警
lowCapacityWarningnumber(double)低液位预警
highWaterWarningnumber(double)高水位预警
highWaterAlarmnumber(double)高水位报警
lowWaterAlarmnumber(double)低水位报警
gainRationumber(double)增益系数
lossRationumber(double)损耗系数
warningTemperaturenumber(double)预警温度

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
PUT

/api/oil/tank/update/goods

油罐管理接口 更新油罐绑定油品 OperationId: updateTankGoods

调用方法

PUT /api/oil/tank/update/goods

参数

请求体

Content-Type: application/json 必填:类型: UpdateTankGoodsDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateTankGoodsDTO

名称类型必填说明示例
tankIdinteger(int64)油罐ID
goodsIdinteger(int64)绑定油品ID

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTankGoodsVO
PUT

/api/oil/pump/update/{id}

油泵管理接口 修改油泵 OperationId: update_11

调用方法

PUT /api/oil/pump/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateOilPumpDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilPumpDTO

名称类型必填说明示例
codestring
namestring
tankIdinteger(int64)
linkTanksinteger(int64)[]

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump
PUT

/api/oil/profit-loss/config/update/{merchantId}

油品损益配置 编辑配置 OperationId: update_12

调用方法

PUT /api/oil/profit-loss/config/update/{merchantId}

参数

名称位置必填类型说明示例
merchantIdpathinteger(int64)商户ID1

请求体

Content-Type: application/json 必填:类型: UpdateOilProfitLossConfigDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO

名称类型必填说明示例
oilProfitLossDTOListUpdateOilProfitLossConfigDTO$OilProfitLossDTO[]损益配置
oilTypeGoodsDTOListUpdateOilProfitLossConfigDTO$OilTypeGoodsDTO[]油品类型商品关联DTO

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/oil/nozzle/update/{id}

油枪管理接口 修改油枪 OperationId: update_13

调用方法

PUT /api/oil/nozzle/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateOilNozzleDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilNozzleDTO

名称类型必填说明示例
codestring编号"1"
namestring名称"1"
pumpIdinteger(int64)油泵ID1
tankIdinteger(int64)油罐ID1
maxValuenumber(double)最大走字1

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle
PUT

/api/oil/nozzle/update/group

油枪管理接口 变更油枪分组 OperationId: updateGroup

调用方法

PUT /api/oil/nozzle/update/group

参数

请求体

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

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

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle[]返回数据
PUT

/api/oil/fuel-server/update/{id}

Fuel服务管理接口 修改Fuel服务配置 OperationId: update_14

调用方法

PUT /api/oil/fuel-server/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpdateOilFuelServerConfigDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilFuelServerConfigDTO

名称类型必填说明示例
hoststring
serverPathstring

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilFuelServerConfig
PUT

/api/cashier/update/{id}

收银员管理接口 修改收银员接口 OperationId: updateCashierPassword

调用方法

PUT /api/cashier/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)收银员ID1

请求体

Content-Type: application/json 必填:类型: UpdateCashierDTO com.leadwaycloud.rm.store.business.cashier.dto.UpdateCashierDTO

名称类型必填说明示例
passwordstring密码"111111"
statusstring状态 【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除 】"ACTIVE"
typestring类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】"CASHIER"
employeeIdinteger(int64)员工ID1
imagestring头像/形象图片 URL"https://cdn.example.com/cashier/001.png"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
PUT

/api/cashier/change-password/{id}

收银员管理接口 收银员修改密码接口 OperationId: changePassword

调用方法

PUT /api/cashier/change-password/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)收银员ID1

请求体

Content-Type: application/json 必填:类型: ChangeCashierPasswordDTO com.leadwaycloud.rm.store.business.cashier.dto.ChangeCashierPasswordDTO

名称类型必填说明示例
oldPasswordstring原密码"111111"
newPasswordstring新密码"222222"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
POST

/api/store-trade-reason/add

交易理由业务接口 新增交易理由接口 OperationId: add

调用方法

POST /api/store-trade-reason/add

参数

请求体

Content-Type: application/json 必填:类型: TradeReasonAddReqDTO com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonAddReqDTO

名称类型必填说明示例
orderTypestring类型"SALE"
reasonstring交易理由

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmTradeReason
POST

/api/store-server/add

门店服务器参数管理接口 新增门店服务器配置 OperationId: add_1

调用方法

POST /api/store-server/add

参数

请求体

Content-Type: application/json 必填:类型: AddStoreServerDTO com.leadwaycloud.rm.store.business.store.server.dto.AddStoreServerDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
typestring服务类型"FUEL_SERVER"
codestring服务编号"001"
configstring服务配置

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer
POST

/api/store-restaurant/add

门店餐厅管理接口 添加门店餐厅接口 OperationId: add_2

调用方法

POST /api/store-restaurant/add

参数

请求体

Content-Type: application/json 必填:类型: AddRestaurantDTO com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring餐厅编号"C001"
namestring餐厅名称"C001"
descriptionstring描述
externalIdstring外部系统ID
menuTemplateIdinteger(int64)菜单定义模版1
tableLayoutIdstring餐厅桌位布局"1"
imagesstring餐厅图片

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant
POST

/api/store-restaurant-table/add

门店餐厅桌位管理接口 添加门店餐厅桌位接口 OperationId: add_3

调用方法

POST /api/store-restaurant-table/add

参数

请求体

Content-Type: application/json 必填:类型: AddRestaurantTableDTO com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantTableDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
restaurantIdinteger(int64)餐厅ID1
codestring桌位号"C001"
floorinteger(int32)楼层1
infostring桌位详细信息"前端自定义json字符串"
externalIdstring外部系统ID

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable
POST

/api/store-restaurant-table-layout/add

门店餐厅桌位布局管理接口 添加门店餐厅桌位布局 OperationId: add_4

调用方法

POST /api/store-restaurant-table-layout/add

参数

请求体

Content-Type: application/json 必填:类型: AddRestaurantTableLayoutDTO com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantTableLayoutDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"C001"
namestring名称"C001"
layoutstring布局"[]"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout
POST

/api/store-merchant-config/update

商户配置搜索接口 商户配置更新接口 OperationId: update_15

调用方法

POST /api/store-merchant-config/update

参数

请求体

Content-Type: application/json 必填:类型: MerchantConfigUpdateRequestDTO com.leadwaycloud.rm.store.business.merchant.config.dto.MerchantConfigUpdateRequestDTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
merchantConfigRmMerchantConfigBO

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmMerchantConfig
POST

/api/store-layout/v1/templates/{id}/apply

布局模板 应用模板到门店 OperationId: apply

创建新布局并复制模板 scene_graph

调用方法

POST /api/store-layout/v1/templates/{id}/apply

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ApplyLayoutTemplateRequest com.leadwaycloud.rm.store.business.storelayout.dto.ApplyLayoutTemplateRequest

名称类型必填说明示例
layoutNamestring
layoutCodestring
companyIdinteger(int64)
merchantIdinteger(int64)

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto
POST

/api/store-layout/v1/templates/from-layout/{layoutId}

布局模板 从布局保存为模板 OperationId: createFromLayout

调用方法

POST /api/store-layout/v1/templates/from-layout/{layoutId}

参数

名称位置必填类型说明示例
layoutIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: CreateTemplateFromLayoutRequest com.leadwaycloud.rm.store.business.storelayout.dto.CreateTemplateFromLayoutRequest

名称类型必填说明示例
namestring
codestring
descriptionstring
categorystring

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateDetailDto
GET

/api/store-layout/v1/layouts

布局 布局列表 OperationId: list

按公司查询布局;可选 warehouseId 过滤含该仓库 zone 的布局

调用方法

GET /api/store-layout/v1/layouts

参数

名称位置必填类型说明示例
companyIdqueryinteger(int64)公司 ID1
warehouseIdqueryinteger(int64)可选:按 zone 绑定的 ERP 仓库过滤1101

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutSummaryDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutSummaryDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutSummaryDto[]返回数据
POST

/api/store-layout/v1/layouts

布局 创建布局 OperationId: create

调用方法

POST /api/store-layout/v1/layouts

参数

请求体

Content-Type: application/json 必填:类型: CreateLayoutRequest com.leadwaycloud.rm.store.business.storelayout.dto.CreateLayoutRequest

名称类型必填说明示例
namestring
codestring
floorWidthnumber
floorDepthnumber
sceneGraphstring
companyIdinteger(int64)
merchantIdinteger(int64)

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto
POST

/api/store-layout/v1/layouts/{id}/publish

布局 发布布局 OperationId: publish

状态改为 PUBLISHED,版本号 +1,保存版本快照,并为未绑定库位的货架生成 LOCATION 编码

调用方法

POST /api/store-layout/v1/layouts/{id}/publish

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: PublishResultDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPublishResultDto
POST

/api/store-layout/v1/layouts/{id}/archive

布局 归档布局 OperationId: archive_1

状态改为 ARCHIVED,不再作为当前编辑方案

调用方法

POST /api/store-layout/v1/layouts/{id}/archive

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto
GET

/api/store-layout/v1/asset-presets

资产预设 资产预设列表 OperationId: list_1

按商户查询;可选 category=SHELF|FUEL|CANOPY|...

调用方法

GET /api/store-layout/v1/asset-presets

参数

名称位置必填类型说明示例
merchantIdqueryinteger(int64)
categoryquerystring

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto[]返回数据
POST

/api/store-layout/v1/asset-presets

资产预设 创建资产预设 OperationId: create_1

调用方法

POST /api/store-layout/v1/asset-presets

参数

名称位置必填类型说明示例
merchantIdqueryinteger(int64)

请求体

Content-Type: application/json 必填:类型: UpsertAssetPresetRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpsertAssetPresetRequest

名称类型必填说明示例
codestring
namestring
descriptionstring
categorystring
nodeTypestring
presetJsonstring
thumbnailUrlstring
modelUrlstring
visualModestring
sortOrderinteger(int32)

响应

状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto
GET

/api/store-layout/v1/asset-presets/{id}/model-file

资产预设 下载资产 3D 模型 OperationId: downloadModelFile

二进制流,不使用 R 包装

调用方法

GET /api/store-layout/v1/asset-presets/{id}/model-file

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: string(binary)

POST

/api/store-layout/v1/asset-presets/{id}/model-file

资产预设 上传资产 3D 模型 OperationId: uploadModelFile

GLB/glTF 存入资产库本地目录,modelUrl 自动指向本接口下载地址

调用方法

POST /api/store-layout/v1/asset-presets/{id}/model-file

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: multipart/form-data 必填:类型: object

名称类型必填说明示例
filestring(binary)

响应

状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto
POST

/api/store-end-day/{id}

门店日结 门店日结接口 OperationId: storeEndDay

自动进行门店日结对账,并根据对账结果与商户规则,发送消息通知门店机台进行营业日切换

调用方法

POST /api/store-end-day/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)公司ID948513515844539

请求体

Content-Type: application/json 必填:类型: EndDayRequest com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest

名称类型必填说明示例
cashierAccountstring收银员账号"131131"
posCodestring机台编号"10"
businessDatestring当前营业日"2026-07-22"

响应

状态码: 200 说明: OK Content-Type: */* 类型: EndDayResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEndDayResponse
POST

/api/store-end-day/reconciliation/{id}

门店日结 门店日结对账接口 OperationId: endDayReconciliation

进行门店日结对账,并返回对账结果

调用方法

POST /api/store-end-day/reconciliation/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)公司ID948513515844539

请求体

Content-Type: application/json 必填:类型: EndDayRequest com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest

名称类型必填说明示例
cashierAccountstring收银员账号"131131"
posCodestring机台编号"10"
businessDatestring当前营业日"2026-07-22"

响应

状态码: 200 说明: OK Content-Type: */* 类型: EndDayReconciliationResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEndDayReconciliationResponse
POST

/api/store-end-day/notice-pos/change/business-date/{id}/{newBusinessDate}

门店日结 通知门店所有机台切换营业日接口 OperationId: noticeStorePosChangeBusinessDate

调用方法

POST /api/store-end-day/notice-pos/change/business-date/{id}/{newBusinessDate}

参数

名称位置必填类型说明示例
idpathinteger(int64)公司ID948513515844539
newBusinessDatepathstring(date)新的营业日"2026-07-22"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/store-end-day/change/business-date/{id}/{businessDate}

门店日结 更新门店营业日接口 OperationId: changeBusinessDate

写入门店营业日切换记录与日志,并消息通知门店所有机台切换营业日

调用方法

POST /api/store-end-day/change/business-date/{id}/{businessDate}

参数

名称位置必填类型说明示例
idpathinteger(int64)公司ID948513515844539

请求体

Content-Type: application/json 必填:类型: CompanyBusinessDateChangeRequest com.leadwaycloud.rm.store.business.end.day.model.CompanyBusinessDateChangeRequest

名称类型必填说明示例
cashierAccountstring收银员账号"131131"
posCodestring机台编号"10"
businessDatestring当前营业日"2026-07-23"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/printer/untie/all-pos/{printerId}

打印机管理接口 解绑所有机台接口 OperationId: untieAllPos

调用方法

POST /api/printer/untie/all-pos/{printerId}

参数

名称位置必填类型说明示例
printerIdpathinteger(int64)打印机ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/printer/add

打印机管理接口 新增打印机接口 OperationId: add_5

调用方法

POST /api/printer/add

参数

请求体

Content-Type: application/json 必填:类型: AddPrinterDTO com.leadwaycloud.rm.store.business.printer.dto.AddPrinterDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"P001"
typestring类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】"THERMAL_TICKET"
namestring名称"1号票据打印机"
descriptionstring描述
printerConfigDTOAddPrinterConfigDTO
printTemplateListinteger(int64)[]打印模版

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
POST

/api/printer-template/add

打印机模版管理接口 新增打印机模版接口 OperationId: add_6

调用方法

POST /api/printer-template/add

参数

请求体

Content-Type: application/json 必填:类型: AddPrintTemplateDTO com.leadwaycloud.rm.store.business.printer.dto.AddPrintTemplateDTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
typestring模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】"TRAN_TICKET"
namestring打印模版名称"交易小票"
contentstring模版内容
usableCompanyinteger(int64)[]可用公司1

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate
POST

/api/pos/update-goods-callback/{id}

机台管理接口 机台更新商品回调接口 OperationId: callbackPosUpdateGoods

调用方法

POST /api/pos/update-goods-callback/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

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

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

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/pos/remove/pos-printer/{posId}/{printerId}

机台管理接口 机台解绑打印机接口 OperationId: posUntiePrinter

调用方法

POST /api/pos/remove/pos-printer/{posId}/{printerId}

参数

名称位置必填类型说明示例
posIdpathinteger(int64)机台ID1
printerIdpathinteger(int64)打印机ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/pos/pos-group/add

机台管理接口 新增机台分组接口 OperationId: addPosGroup

调用方法

POST /api/pos/pos-group/add

参数

请求体

Content-Type: application/json 必填:类型: AddPosGroupDTO com.leadwaycloud.rm.store.business.pos.dto.AddPosGroupDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"POS001"
namestring名称
descriptionstring描述
configobject配置{}

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup
POST

/api/pos/manual-notify/goods-update-goods/{goodsUpdateNotifyPosId}

机台管理接口 查询机台商品更新通知机台记录接口 OperationId: queryGoodsUpdateNotifyPosRecord

调用方法

POST /api/pos/manual-notify/goods-update-goods/{goodsUpdateNotifyPosId}

参数

名称位置必填类型说明示例
goodsUpdateNotifyPosIdpathinteger(int64)机台商品更新通知机台记录ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/pos/get/api-connection-token/{id}

机台管理接口 获取POS接口通讯Token接口 OperationId: getAPIConnectionToken

Token 一年有效

调用方法

POST /api/pos/get/api-connection-token/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datastring返回数据
POST

/api/pos/add

机台管理接口 新增机台接口 OperationId: add_7

调用方法

POST /api/pos/add

参数

请求体

Content-Type: application/json 必填:类型: AddPosDTO com.leadwaycloud.rm.store.business.pos.dto.AddPosDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"POS001"
descriptionstring描述
defStockWarehouseIdinteger(int64)非油商品默认扣减库存仓库ID1
posGroupIdinteger(int64)POS分组1
modestring机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】"POS"
bindingsstring绑定主POS设备列表

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
POST

/api/pos/add/pos-printer/{id}

机台管理接口 - OperationId: addPosPrinter

调用方法

POST /api/pos/add/pos-printer/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

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

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

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter[]返回数据
POST

/api/oil/tank/reading/add

油罐管理接口 添加油罐读数 OperationId: addReading

调用方法

POST /api/oil/tank/reading/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilTankReadingDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilTankReadingDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
tankIdinteger(int64)油罐ID1
goodsIdinteger(int64)油品ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
tankCodestring油罐编号"1"
temperaturenumber(double)温度1
gaugeLevelnumber(double)总深度1
gaugeVolumenumber(double)总体积1
gaugeTcVolumenumber(double)温度校正体积1
waterLevelnumber(double)水深度1
waterVolumenumber(double)水体积1
ullageVolumenumber(double)油罐空体积1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"FUEL_SERVER"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/tank/import/standard-info/tank/{tankId}

油罐管理接口 导入油罐规格信息(一罐一条,覆盖已有) OperationId: importTankStandardInfo

调用方法

POST /api/oil/tank/import/standard-info/tank/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: object

名称类型必填说明示例
filestring(binary)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/tank/import/standard-info/{tankId}

油罐管理接口 导入油罐规格信息(一罐一条,覆盖已有) OperationId: importTankStandardInfo_1

调用方法

POST /api/oil/tank/import/standard-info/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: object

名称类型必填说明示例
filestring(binary)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/tank/export/import-standard-info-template

油罐管理接口 下载油罐规格信息导入模版 OperationId: exportImportTankStandardInfoTemplate

调用方法

POST /api/oil/tank/export/import-standard-info-template

参数

请求体

响应

状态码: 200 说明: OK Content-Type: application/octet-stream 类型: string(byte)

POST

/api/oil/tank/add

油罐管理接口 添加油罐 OperationId: add_8

调用方法

POST /api/oil/tank/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilTankDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilTankDTO

名称类型必填说明示例
merchantIdinteger(int64)
companyIdinteger(int64)
codestring
namestring
maxVolumenumber(double)
alarmVolumenumber(double)
goodsIdinteger(int64)
stockWarehouseIdinteger(int64)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTank
POST

/api/oil/tank/add/standard-info/{tankId}

油罐管理接口 添加油罐规格信息(一罐一条) OperationId: addTankStandardInfo

调用方法

POST /api/oil/tank/add/standard-info/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: AddEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.AddEnergyOilTankStandardInfoDTO

名称类型必填说明示例
heightnumber(double)油罐高度
volumenumber(double)油罐体积(对应 tank_capacity)
seqinteger(int32)排序序号
highCapacityAlarmnumber(double)高液位报警
highCapacityWarningnumber(double)高液位预警
lowCapacityAlarmnumber(double)低液位报警
lowCapacityWarningnumber(double)低液位预警
highWaterWarningnumber(double)高水位预警
highWaterAlarmnumber(double)高水位报警
lowWaterAlarmnumber(double)低水位报警
gainRationumber(double)增益系数
lossRationumber(double)损耗系数
warningTemperaturenumber(double)预警温度

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
POST

/api/oil/shift-business/start-shift

班次业务管理接口 接班 OperationId: startShift

调用方法

POST /api/oil/shift-business/start-shift

参数

请求体

Content-Type: application/json 必填:类型: OilShiftDTO com.leadwaycloud.rm.store.business.oil.dto.OilShiftDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankNumberListTankNumberDTO[]
pumpNumberListPumpNumberDTO[]

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/shift-business/query-order

班次业务管理接口 查询油品交易订单 OperationId: queryOrder

调用方法

POST /api/oil/shift-business/query-order

参数

名称位置必填类型说明示例
pagequeryinteger(int32)
sizequeryinteger(int32)

请求体

Content-Type: application/json 必填:类型: QueryOilOrderDTO com.leadwaycloud.rm.store.business.oil.dto.QueryOilOrderDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
tankstring
pumpstring
nozzlestring
tradeCodestring
startTimestring(date-time)
endTimestring(date-time)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmOrderOil
POST

/api/oil/shift-business/oil-collection

班次业务管理接口 收油 OperationId: oilCollection

调用方法

POST /api/oil/shift-business/oil-collection

参数

请求体

Content-Type: application/json 必填:类型: OilCollectionDTO com.leadwaycloud.rm.store.business.oil.dto.OilCollectionDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankstring
startTimestring(date-time)
endTimestring(date-time)
startVolumenumber(double)
endVolumenumber(double)
saleVolumenumber(double)
inVolumenumber(double)
v20Volumenumber(double)
p20Densitynumber(double)
temperaturenumber(double)
observedDensitynumber(double)
observedVolumenumber(double)
fuelLevelnumber(double)
fuelVolumenumber(double)
waterLevelnumber(double)
waterVolumenumber(double)
ullagenumber(double)

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/shift-business/oil-back

班次业务管理接口 回罐 OperationId: oilBack

调用方法

POST /api/oil/shift-business/oil-back

参数

请求体

Content-Type: application/json 必填:类型: OilBackDTO com.leadwaycloud.rm.store.business.oil.dto.OilBackDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankstring
numbernumber(double)
reasonstring

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/shift-business/end-shift

班次业务管理接口 交班 OperationId: endShift

调用方法

POST /api/oil/shift-business/end-shift

参数

请求体

Content-Type: application/json 必填:类型: OilShiftDTO com.leadwaycloud.rm.store.business.oil.dto.OilShiftDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankNumberListTankNumberDTO[]
pumpNumberListPumpNumberDTO[]

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/pump/add

油泵管理接口 添加油泵 OperationId: add_9

调用方法

POST /api/oil/pump/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilPumpDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilPumpDTO

名称类型必填说明示例
companyIdinteger(int64)
codestring
namestring
tankIdinteger(int64)
linkTanksinteger(int64)[]

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump
POST

/api/oil/profit-loss/config/add

油品损益配置 添加配置 OperationId: add_10

调用方法

POST /api/oil/profit-loss/config/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilProfitLossConfigDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
oilProfitLossDTOListAddOilProfitLossConfigDTO$OilProfitLossDTO[]损益配置
oilTypeGoodsDTOListAddOilProfitLossConfigDTO$OilTypeGoodsDTO[]油品类型商品关联DTO

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/oil/nozzle/reading/add

油枪管理接口 添加油枪读数 OperationId: addReading_1

调用方法

POST /api/oil/nozzle/reading/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilNozzleReadingDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilNozzleReadingDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
nozzleIdinteger(int64)油枪ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
volumeTotalnumber(double)总出油量1
moneyTotalnumber(double)总出油金额1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"FUEL_SERVER"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/nozzle/add

油枪管理接口 添加油枪 OperationId: add_11

调用方法

POST /api/oil/nozzle/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilNozzleDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilNozzleDTO

名称类型必填说明示例
companyIdinteger(int64)门店ID1
codestring编号"1"
namestring名称"1"
pumpIdinteger(int64)油泵ID1
tankIdinteger(int64)油罐ID1
maxValuenumber(double)最大走字1

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle
POST

/api/oil/fuel-server/data/add

Fuel服务管理接口 添加数据(油枪读数、油罐读数等) OperationId: dataAdd

调用方法

POST /api/oil/fuel-server/data/add

参数

请求体

Content-Type: application/json 必填:类型: FuelServerDataAddDTO com.leadwaycloud.rm.store.business.oil.dto.FuelServerDataAddDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
typestring数据类型 【 TANK_READING : 油罐读数 NOZZLE_READING : 油枪读数 】
datastring数据

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
POST

/api/oil/fuel-server/add

Fuel服务管理接口 添加Fuel服务配置 OperationId: add_12

调用方法

POST /api/oil/fuel-server/add

参数

请求体

Content-Type: application/json 必填:类型: AddOilFuelServerConfigDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilFuelServerConfigDTO

名称类型必填说明示例
companyIdinteger(int64)
hoststring
serverPathstring

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilFuelServerConfig
POST

/api/cashier/add

收银员管理接口 新增收银员接口 OperationId: add_13

调用方法

POST /api/cashier/add

参数

请求体

Content-Type: application/json 必填:类型: AddCashierDTO com.leadwaycloud.rm.store.business.cashier.dto.AddCashierDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
accountstring账号"131131"
passwordstring密码"111111"
typestring类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】"CASHIER"
employeeIdinteger(int64)员工ID1
imagestring头像/形象图片 URL"https://cdn.example.com/cashier/001.png"

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
GET

/api/store-trade-reason/search/{id}

交易理由业务接口 交易理由ID搜索接口 OperationId: searchTradeReason

调用方法

GET /api/store-trade-reason/search/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)交易理由ID1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonRespVO
GET

/api/store-trade-reason/search-page

交易理由业务接口 交易理由分页搜索接口 OperationId: searchTradeReason_1

调用方法

GET /api/store-trade-reason/search-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)搜索页码0
sizequeryinteger(int32)搜索页行数10
merchantIdquerylong商户ID1
orderTypequerystring类型"SALE"
reasonquerystring交易理由

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonListRespVO
GET

/api/store-trade-reason/search-list

交易理由业务接口 交易理由列表搜索接口 OperationId: searchTradeReason_2

调用方法

GET /api/store-trade-reason/search-list

参数

名称位置必填类型说明示例
merchantIdquerylong商户ID1
orderTypequerystring类型"SALE"
reasonquerystring交易理由

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonListRespVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonListRespVO[]返回数据
GET

/api/store-server/types

门店服务器参数管理接口 门店服务器类型 OperationId: types

调用方法

GET /api/store-server/types

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/store-server/query/{id}

门店服务器参数管理接口 查询门店服务器(ID)接口 OperationId: query

调用方法

GET /api/store-server/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)门店服务器ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer
GET

/api/store-server/query/{companyId}/{type}/{code}

门店服务器参数管理接口 查询门店服务器配置(唯一索引)接口 OperationId: query_1

调用方法

GET /api/store-server/query/{companyId}/{type}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
typepathstring门店服务器类型"FUEL_SERVER"
codepathstring门店服务器编号"001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer
GET

/api/store-server/query-page

门店服务器参数管理接口 查询门店服务器配置(分页)接口 OperationId: query_2

调用方法

GET /api/store-server/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdquerylong公司ID1
typequerystring服务类型"FUEL_SERVER"
codequerystring服务编号"001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer
GET

/api/store-restaurant/query/{id}

门店餐厅管理接口 查询门店餐厅(ID)接口 OperationId: query_3

调用方法

GET /api/store-restaurant/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)餐厅ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant
GET

/api/store-restaurant/query/{companyId}/{code}

门店餐厅管理接口 查询门店餐厅(编号)接口 OperationId: query_4

调用方法

GET /api/store-restaurant/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
codepathstring餐厅编号"P001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant
GET

/api/store-restaurant/query-list/{companyId}

门店餐厅管理接口 查询门店餐厅(列表)接口 OperationId: queryList

调用方法

GET /api/store-restaurant/query-list/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant[]返回数据
GET

/api/store-restaurant-table/query/{id}

门店餐厅桌位管理接口 查询门店餐厅桌位(ID)接口 OperationId: query_5

调用方法

GET /api/store-restaurant-table/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable
GET

/api/store-restaurant-table/query/{companyId}/{restaurantId}/{code}

门店餐厅桌位管理接口 查询门店餐厅桌位(编号)接口 OperationId: query_6

调用方法

GET /api/store-restaurant-table/query/{companyId}/{restaurantId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
restaurantIdpathinteger(int64)餐厅ID1
codepathstring桌位编号"P001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable
GET

/api/store-restaurant-table/query-page/{companyId}/{restaurantId}

门店餐厅桌位管理接口 查询门店餐厅桌位(分页)接口 OperationId: queryPage

调用方法

GET /api/store-restaurant-table/query-page/{companyId}/{restaurantId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
restaurantIdpathinteger(int64)餐厅ID1
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
codequerystring桌位号"C001"
floorqueryint楼层1
activequeryboolean是否可用true

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable
GET

/api/store-restaurant-table-layout/query/{id}

门店餐厅桌位布局管理接口 查询门店餐厅桌位布局(ID)接口 OperationId: query_7

调用方法

GET /api/store-restaurant-table-layout/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)桌位布局ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout
GET

/api/store-restaurant-table-layout/query/{companyId}

门店餐厅桌位布局管理接口 查询门店餐厅桌位布局(编号)接口 OperationId: query_8

调用方法

GET /api/store-restaurant-table-layout/query/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
codequerystring编号"C001"
namequerystring名称1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTableLayout com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout
GET

/api/store-merchant-config/search/{id}

商户配置搜索接口 商户配置ID查询接口 OperationId: searchConfig

调用方法

GET /api/store-merchant-config/search/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)商户配置ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: MerchantConfigResponseVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataMerchantConfigResponseVO
GET

/api/store-merchant-config/search-merchant/{merchantId}

商户配置搜索接口 商户配置商户ID查询接口 OperationId: searchConfigByMerchantid

调用方法

GET /api/store-merchant-config/search-merchant/{merchantId}

参数

名称位置必填类型说明示例
merchantIdpathinteger(int64)商户ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: MerchantConfigResponseVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataMerchantConfigResponseVO
GET

/api/store-layout/v1/warehouses

仓库/库位 门店/仓库列表 OperationId: listStores

调用方法

GET /api/store-layout/v1/warehouses

参数

名称位置必填类型说明示例
companyIdqueryinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataWarehouseDto[]返回数据
GET

/api/store-layout/v1/warehouses/{id}

仓库/库位 仓库详情 OperationId: getById_2

调用方法

GET /api/store-layout/v1/warehouses/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataWarehouseDto
GET

/api/store-layout/v1/warehouses/{id}/locations

仓库/库位 库位列表 OperationId: listLocations

调用方法

GET /api/store-layout/v1/warehouses/{id}/locations

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataWarehouseDto[]返回数据
GET

/api/store-layout/v1/templates

布局模板 模板列表 OperationId: list_2

调用方法

GET /api/store-layout/v1/templates

参数

名称位置必填类型说明示例
companyIdqueryinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateSummaryDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateSummaryDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateSummaryDto[]返回数据
GET

/api/store-layout/v1/templates/{id}

布局模板 模板详情 OperationId: getById_3

调用方法

GET /api/store-layout/v1/templates/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateDetailDto
DELETE

/api/store-layout/v1/templates/{id}

布局模板 归档模板 OperationId: archive_2

调用方法

DELETE /api/store-layout/v1/templates/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/store-layout/v1/layouts/{layoutId}/planogram/validate

排面 Planogram 合规校验 OperationId: validate

检查排面三要素、件数一致性、货架溢出、品类相邻禁配、黄金视线层等

调用方法

GET /api/store-layout/v1/layouts/{layoutId}/planogram/validate

参数

名称位置必填类型说明示例
layoutIdpathinteger(int64)布局 ID1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: PlanogramValidationResultDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPlanogramValidationResultDto
GET

/api/store-layout/v1/goods/{id}

商品 按 ID 查询商品 OperationId: getById_4

调用方法

GET /api/store-layout/v1/goods/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: GoodsDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsDto
GET

/api/store-layout/v1/goods/code/{code}

商品 按货号查询商品 OperationId: getByCode

调用方法

GET /api/store-layout/v1/goods/code/{code}

参数

名称位置必填类型说明示例
merchantIdqueryinteger(int64)
codepathstring

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: GoodsDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsDto
GET

/api/store-layout/v1/goods/barcode/{barcode}

商品 按条码查询 OperationId: getByBarcode

调用方法

GET /api/store-layout/v1/goods/barcode/{barcode}

参数

名称位置必填类型说明示例
merchantIdqueryinteger(int64)
barcodepathstring

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: GoodsBarcodeDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsBarcodeDto
GET

/api/store-layout/v1/doc/schemas/store-layout

数据模型 rm_store_layout → RmStoreLayout OperationId: storeLayout

门店布局主表,含 scene_graph 与版本状态

调用方法

GET /api/store-layout/v1/doc/schemas/store-layout

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayout com.leadwaycloud.rm.store.model.po.entity.RmStoreLayout

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring布局业务编码,公司内唯一"LAYOUT-001"
namestring布局名称"春熙路店默认布局"
versionNointeger(int32)版本号;每次发布递增1
statusstring布局生命周期状态
floorWidthnumber卖场平面宽度(米)30
floorDepthnumber卖场平面深度(米)20
sceneGraphstringPascal Editor 完整场景 JSON(节点字典),用于 3D 渲染与撤销/重做
merchantIdinteger(int64)商户 ID(多租户隔离)1
companyIdinteger(int64)公司 ID(多租户隔离)1
GET

/api/store-layout/v1/doc/schemas/store-asset-preset

数据模型 rm_store_layout_asset_preset → RmStoreLayoutAssetPreset OperationId: storeAssetPreset

3D 资产预设

调用方法

GET /api/store-layout/v1/doc/schemas/store-asset-preset

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutAssetPreset com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAssetPreset

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户 ID(资产库按商户共享,非单门店)1
codestring预设编码,商户内唯一"FUEL-DISPENSER-01"
namestring预设显示名称"加油机标准型"
descriptionstring预设说明
categorystring资产预设业务分类
nodeTypestringPascal 节点类型:store-shelf / store-zone / scan / spawn 等"store-shelf"
presetJsonstring合并进节点 schema 的 JSON 默认字段(尺寸、材质、metadata 等)
thumbnailUrlstring缩略图 URL
modelUrlstringGLB/GLTF 模型访问 URL;visualMode=MODEL 时指向下载 API
modelDatastring(byte)GLB/glTF 模型二进制(visualMode=MODEL 时存库)
modelContentTypestring模型 MIME 类型,如 model/gltf-binary
modelFileNamestring上传时的原始文件名(Content-Disposition,非磁盘路径)
visualModestring渲染模式:PARAMETRIC 程序几何 / MODEL 外部 GLB 模型"PARAMETRIC"
sortOrderinteger(int32)列表排序序号0
statusstring资产预设状态
GET

/api/store-layout/v1/doc/schemas/stock-warehouse

数据模型 stock_warehouse → StockWarehouse OperationId: stockWarehouse

ERP 仓库/库位(只读)

调用方法

GET /api/store-layout/v1/doc/schemas/stock-warehouse

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: StockWarehouse com.leadwaycloud.rm.common.model.po.entity.StockWarehouse

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring编号(仅允许字母和数字)"W01"
namestring名称"默认仓库"
idChainstring仓库ID完整架构(上下级仓库id用-连接)"123-456"
systemstring是否是系统默认分组(系统默认角色(不可修改/删除))"false"
parentIdstring上一级仓库"1"
imagesstring图片
typestring类型 【 WAREHOUSE : 仓库 LOCATION : 库位 LOCATION_OIL : 油库 】"WAREHOUSE"
statusstring状态
merchantIdinteger(int64)商户ID1
companyIdinteger(int64)公司ID1
GET

/api/store-layout/v1/doc/schemas/stock-goods

数据模型 stock_goods → StockGoods OperationId: stockGoods

ERP 商品(只读)

调用方法

GET /api/store-layout/v1/doc/schemas/stock-goods

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: StockGoods com.leadwaycloud.rm.common.model.po.entity.StockGoods

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
namestring名称"抽纸"
codestring货号"KDED24123123"
virtualboolean是否是虚拟产品true
imagesstring图片"..."
originstring来源"..."
descriptionstring描述"..."
otherNamestring别名"..."
markstring标记"ENERGY"
placestring产地
gradestring等级
externalCodestring外部编号
weightboolean非标售卖商品true
fuelboolean油品true
makeboolean自制品true
barcodeSettlementboolean商品结算方式 false(商品结算,默认) true(条码结算)
carwashboolean洗车商品true
goodsCategoryIdinteger(int64)分类ID
goodsBrandIdinteger(int64)品牌ID
specstring规格
uomIdstring计量单位ID
saleUomIdstring销售单位ID
goodsCategoryStockGoodsCategory
uomSysUom
saleUomSysUom
goodsBrandStockGoodsBrand
goodsEnergyStockGoodsEnergy
GET

/api/store-layout/v1/doc/schemas/stock-goods-barcode

数据模型 stock_goods_barcode → StockGoodsBarcode OperationId: stockGoodsBarcode

ERP 商品条码(只读)

调用方法

GET /api/store-layout/v1/doc/schemas/stock-goods-barcode

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: StockGoodsBarcode com.leadwaycloud.rm.common.model.po.entity.StockGoodsBarcode

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
goodsIdinteger(int64)商品ID
barcodestring条码"6914068029184"
typestring条码类型"EN13"
otherBarcodestring其他条码"6914068029184"
defSettlementboolean是否是结算默认条码
imagesstring图片
specstring规格
GET

/api/store-layout/v1/doc/schemas/layout-zone

数据模型 rm_store_layout_zone → RmStoreLayoutZone OperationId: layoutZone

销售区域/形状

调用方法

GET /api/store-layout/v1/doc/schemas/layout-zone

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutZone com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutZone

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
warehouseIdinteger(int64)绑定的 ERP 仓库/门店 ID(stock_warehouse.id,type=WAREHOUSE)1101
codestring区域编码"ZONE-A"
namestring区域名称"饮料区"
zoneTypestring布局销售区域类型
shapeTypestring区域形状类型
polygonJsonstring多边形顶点 JSON,格式 [[x,z],...](米,XZ 平面)
positionXnumber矩形/多边形锚点 X 坐标(米)0
positionZnumber矩形/多边形锚点 Z 坐标(米)0
widthnumber矩形宽度(米)10
depthnumber矩形深度(米)8
rotationnumber绕 Y 轴旋转角(弧度)0
colorstring2D/3D 显示颜色 HEX"#4A90D9"
sortOrderinteger(int32)列表排序序号,越小越靠前0
sceneNodeIdstringPascal Editor 场景节点 ID"store-zone_abc123"
GET

/api/store-layout/v1/doc/schemas/layout-template

数据模型 rm_store_layout_template → RmStoreLayoutTemplate OperationId: layoutTemplate

布局模板

调用方法

GET /api/store-layout/v1/doc/schemas/layout-template

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutTemplate com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutTemplate

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司 ID1
codestring模板编码"TPL-GS-001"
namestring模板名称"加油站标准模板"
descriptionstring模板说明
categorystring布局模板业态分类
statusstring布局模板状态
sourceLayoutIdinteger(int64)来源布局 ID(从哪份布局保存而来)2
thumbnailUrlstring缩略图 URL
sceneGraphstringPascal Editor 场景 JSON 快照
floorWidthnumber模板默认卖场宽度(米)30
floorDepthnumber模板默认卖场深度(米)20
GET

/api/store-layout/v1/doc/schemas/layout-shelf

数据模型 rm_store_layout_shelf → RmStoreLayoutShelf OperationId: layoutShelf

门店货架

调用方法

GET /api/store-layout/v1/doc/schemas/layout-shelf

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutShelf com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelf

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
zoneIdinteger(int64)所属销售区域 ID101
aisleIdinteger(int64)所属通道 ID201
warehouseLocationIdinteger(int64)绑定的 ERP 库位 ID(整架或主库位)2001
codestring货架编码,发布时可生成 ERP 库位"S001"
namestring货架名称"饮料货架 A"
shelfTypestring货架类型
positionXnumber世界坐标 X(米)5
positionYnumber世界坐标 Y(米,离地高度)0
positionZnumber世界坐标 Z(米)3
rotationYnumber绕 Y 轴旋转(弧度)0
widthnumber货架宽度(米)1.2
heightnumber货架总高度(米)2
depthnumber货架深度(米)0.4
layerCountinteger(int32)层数(与 layout_shelf_layer 记录数一致)4
sceneNodeIdstringPascal Editor 场景节点 ID"store-shelf_abc123"
GET

/api/store-layout/v1/doc/schemas/layout-shelf-layer

数据模型 rm_store_layout_shelf_layer → RmStoreLayoutShelfLayer OperationId: layoutShelfLayer

货架层

调用方法

GET /api/store-layout/v1/doc/schemas/layout-shelf-layer

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutShelfLayer com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelfLayer

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
shelfIdinteger(int64)所属货架 ID501
layerNointeger(int32)层号,从 1 起自下而上2
heightnumber层板距地面高度(米)1.2
maxWeightnumber层板最大承重(千克)50
maxItemsinteger(int32)本层最大 SKU 数12
sceneNodeIdstringPascal Editor 场景节点 ID"shelf-layer_abc123"
pickPriorityinteger(int32)WMS 拣货优先级,数值越小越优先拣货100
GET

/api/store-layout/v1/doc/schemas/layout-goods-slot

数据模型 rm_store_layout_goods_slot → RmStoreLayoutGoodsSlot OperationId: layoutGoodsSlot

排面槽位(Planogram 单元)

调用方法

GET /api/store-layout/v1/doc/schemas/layout-goods-slot

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutGoodsSlot com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutGoodsSlot

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
shelfLayerIdinteger(int64)所属货架层 ID5001
goodsIdinteger(int64)ERP 商品 ID(stock_goods.id)3001
barcodeIdinteger(int64)ERP 结算条码 ID(stock_goods_barcode.id)4001
goodsCodestring冗余货号(stock_goods.code),便于列表展示"GD-001"
slotIndexinteger(int32)层内从左到右序号,从 0 开始0
facingsinteger(int32)横向排面列数(顾客可见正面数)4
depthFacingsinteger(int32)纵深陈列深度(向货架内延伸的列数)2
stackLayersinteger(int32)垂直堆叠层数1
facingstring商品朝向"FRONT"
quantityinteger(int32)陈列总件数,通常 = facings × depthFacings × stackLayers8
displayTypestring陈列类型"STANDARD"
positionOffsetnumber层内水平偏移(米)0
sceneNodeIdstringPascal Editor 场景节点 ID"goods-slot_abc123"
packWidthMminteger(int32)单品包装宽度(毫米),用于 3D 占宽与溢出校验65
packHeightMminteger(int32)单品包装高度(毫米)200
packDepthMminteger(int32)单品包装深度(毫米)65
GET

/api/store-layout/v1/doc/schemas/layout-aisle

数据模型 rm_store_layout_aisle → RmStoreLayoutAisle OperationId: layoutAisle

门店通道

调用方法

GET /api/store-layout/v1/doc/schemas/layout-aisle

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreLayoutAisle com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAisle

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
zoneIdinteger(int64)所属销售区域 ID(layout_zone.id)101
codestring通道编码"AISLE-01"
namestring通道名称"主通道"
startXnumber起点 X 坐标(米)0
startZnumber起点 Z 坐标(米)0
endXnumber终点 X 坐标(米)10
endZnumber终点 Z 坐标(米)0
widthnumber通道有效宽度(米)1.2
directionstring方向:HORIZONTAL 水平 / VERTICAL 垂直 / CUSTOM 自定义"CUSTOM"
sceneNodeIdstringPascal Editor 场景节点 ID"store-aisle_abc123"
GET

/api/store-layout/v1/doc/schemas/audit-log

数据模型 rm_store_layout_audit_log → RmStoreAuditLog OperationId: auditLog

操作审计日志

调用方法

GET /api/store-layout/v1/doc/schemas/audit-log

参数

请求体

响应

状态码: 204 说明: No Content Content-Type: */* 类型: RmStoreAuditLog com.leadwaycloud.rm.store.model.po.entity.RmStoreAuditLog

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司 ID1
userIdinteger(int64)操作用户 ID100
actionstring动作编码,如 PUBLISH_LAYOUT / APPLY_TEMPLATE / PLANogram_AUDIT"PUBLISH_LAYOUT"
resourceTypestring资源类型:LAYOUT / TEMPLATE / ASSET_PRESET 等"LAYOUT"
resourceIdinteger(int64)资源主键 ID1
detailstring操作详情 JSON 或文本
createTimestring(date-time)创建时间
GET

/api/printer/query/{id}

打印机管理接口 查询打印机(ID)接口 OperationId: query_9

调用方法

GET /api/printer/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
GET

/api/printer/query/{companyId}/{code}

打印机管理接口 查询打印机(编号)接口 OperationId: query_10

调用方法

GET /api/printer/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
codepathstring打印机编号"D001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
GET

/api/printer/query/use-printer-pos/{id}

打印机管理接口 查询使用打印机的机台接口 OperationId: queryUsePrinterPos

调用方法

GET /api/printer/query/use-printer-pos/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos[]返回数据
GET

/api/printer/query-page

打印机管理接口 查询打印机(分页)接口 OperationId: query_11

调用方法

GET /api/printer/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdquerylong公司ID1
codequerystring编号"P001"
typequerystring类型"THERMAL_TICKET"
statusquerystring状态"IDLE"
connectionTypequerystring连接类型"SERIAL"
deviceCommandIdquerylong设备指令集ID1
printTemplateIdquerylong打印模版ID1
printTemplateNamequerystring打印模版名称"交易小票"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter
GET

/api/printer-template/query/{id}

打印机模版管理接口 查询打印机模版(ID)接口 OperationId: query_12

调用方法

GET /api/printer-template/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机模版ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate
GET

/api/printer-template/query-page

打印机模版管理接口 查询打印机模版(分页)接口 OperationId: query_13

调用方法

GET /api/printer-template/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
merchantIdquerylong商户ID1
typeListquerystring模版类型["TRAN_TICKET"]
namequerystring打印模版名称"交易小票"
companyIdListquerylong门店id集合

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate
GET

/api/pos/query/{id}

机台管理接口 查询机台(ID)接口 OperationId: query_14

调用方法

GET /api/pos/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
GET

/api/pos/query/{companyId}/{code}

机台管理接口 查询机台(编号)接口 OperationId: query_15

调用方法

GET /api/pos/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
codepathstring机台编号"POS001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
GET

/api/pos/query/goods-update-notify-pos-record/{id}

机台管理接口 查询机台商品更新通知机台记录接口 OperationId: queryGoodsUpdateNotifyPosRecord_1

调用方法

GET /api/pos/query/goods-update-notify-pos-record/{id}

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmGoodsUpdateNotifyPos
GET

/api/pos/query/business-info/{id}

机台管理接口 查询机台(ID)接口 OperationId: queryPosBusinessInfo

调用方法

GET /api/pos/query/business-info/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: PosBusinessInfoResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPosBusinessInfoResponse
GET

/api/pos/query-page

机台管理接口 查询机台(分页)接口 OperationId: query_16

调用方法

GET /api/pos/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdquerylong公司ID1
codequerystring编号"POS001"
statusquerystring状态"INACTIVATED"
modequerystring应用模式"POS"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos
GET

/api/pos/pos-group/{id}

机台管理接口 查询机台分组(ID)接口 OperationId: groupQuery

调用方法

GET /api/pos/pos-group/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台分组ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup
GET

/api/pos/pos-group/{companyId}/{code}

机台管理接口 查询机台分组(编号)接口 OperationId: groupQuery_1

调用方法

GET /api/pos/pos-group/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
codepathstring机台编号"POS001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup[]返回数据
GET

/api/pos/pos-group/query-page

机台管理接口 查询机台组(分页)接口 OperationId: groupQuery_2

调用方法

GET /api/pos/pos-group/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdquerylong公司ID1
codequerystring编号"GROUP-001"
namequerystring名称"Group 001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup
GET

/api/oil/tank/reading/page

油罐管理接口 查询油罐读数 OperationId: readingPage

调用方法

GET /api/oil/tank/reading/page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
tankIdquerylong油罐ID1
companyIdquerylong公司ID1
sourcequerystring来源(MANUAL:手动、POS、FUEL_MACHINE:油机)"FUEL_MACHINE"
businessDatequeryLocalDate营业日"2026-06-01"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankReading
GET

/api/oil/tank/query/{id}

油罐管理接口 查询油罐(ID) OperationId: query_17

调用方法

GET /api/oil/tank/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTank
GET

/api/oil/tank/query/{companyId}/{code}

油罐管理接口 查询油罐(编号) OperationId: queryByCode

调用方法

GET /api/oil/tank/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)
codepathstring

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTank
GET

/api/oil/tank/query/standard-info/{id}

油罐管理接口 查询油罐规格信息(按规格ID) OperationId: queryTankStandardInfo

调用方法

GET /api/oil/tank/query/standard-info/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
GET

/api/oil/tank/query/standard-info/tank/{tankId}

油罐管理接口 查询油罐规格信息(按油罐ID,一罐一条) OperationId: queryTankStandardInfoByTank

调用方法

GET /api/oil/tank/query/standard-info/tank/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
GET

/api/oil/tank/query/list/{companyId}

油罐管理接口 查询油罐列表(含规格属性) OperationId: queryList_1

调用方法

GET /api/oil/tank/query/list/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataOilTankListVO[]返回数据
GET

/api/oil/tank/query/goods/{tankId}

油罐管理接口 查询油罐绑定油品(一罐一条) OperationId: queryTankGoods

调用方法

GET /api/oil/tank/query/goods/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTankGoodsVO
GET

/api/oil/tank/query/goods/list/{companyId}

油罐管理接口 查询门店所有油罐绑定油品 OperationId: queryTankGoodsList

调用方法

GET /api/oil/tank/query/goods/list/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTankGoodsVO[]返回数据
GET

/api/oil/tank/query-page/standard-info/{tankId}

油罐管理接口 查询油罐规格信息(按油罐ID,兼容旧路径) OperationId: pageQueryTankStandardInfo

调用方法

GET /api/oil/tank/query-page/standard-info/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification
GET

/api/oil/pump/query/{id}

油泵管理接口 查询油泵(ID) OperationId: query_18

调用方法

GET /api/oil/pump/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump
GET

/api/oil/pump/query/{companyId}/{code}

油泵管理接口 查询油泵(编号) OperationId: queryByCode_1

调用方法

GET /api/oil/pump/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)
codepathstring

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump
GET

/api/oil/pump/query/list/{companyId}

油泵管理接口 查询油泵列表 OperationId: queryList_2

调用方法

GET /api/oil/pump/query/list/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump[]返回数据
GET

/api/oil/profit-loss/config/query

油品损益配置 查询配置 OperationId: query_19

调用方法

GET /api/oil/profit-loss/config/query

参数

名称位置必填类型说明示例
merchantIdqueryinteger(int64)商户ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataOilProfitLossConfigVO
GET

/api/oil/nozzle/reading/page

油枪管理接口 查询油枪读数 OperationId: readingPage_1

调用方法

GET /api/oil/nozzle/reading/page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
nozzleIdquerylong油枪ID1
companyIdquerylong公司ID1
sourcequerystring来源(MANUAL:手动、POS、FUEL_MACHINE:油机)"FUEL_MACHINE"
businessDatequeryLocalDate营业日"2026-06-01"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzleReading
GET

/api/oil/nozzle/query/{id}

油枪管理接口 查询油枪(ID) OperationId: query_20

调用方法

GET /api/oil/nozzle/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle
GET

/api/oil/nozzle/query/{companyId}/{code}

油枪管理接口 查询油枪(编号) OperationId: queryByCode_2

调用方法

GET /api/oil/nozzle/query/{companyId}/{code}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)
codepathstring

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle
GET

/api/oil/nozzle/query/list/{companyId}

油枪管理接口 查询油枪列表 OperationId: queryList_3

调用方法

GET /api/oil/nozzle/query/list/{companyId}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle[]返回数据
GET

/api/oil/fuel-server/query/{id}

Fuel服务管理接口 查询Fuel服务配置(ID) OperationId: query_21

调用方法

GET /api/oil/fuel-server/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilFuelServerConfig
GET

/api/monitor/version

服务监控管理 获取服务版本信息 OperationId: version

调用方法

GET /api/monitor/version

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/monitor/health

服务监控管理 心跳检查 OperationId: health

调用方法

GET /api/monitor/health

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/cashier/query/{id}

收银员管理接口 查询收银员(ID)接口 OperationId: query_22

调用方法

GET /api/cashier/query/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
GET

/api/cashier/query/{companyId}/{account}

收银员管理接口 查询收银员(账号)接口 OperationId: query_23

调用方法

GET /api/cashier/query/{companyId}/{account}

参数

名称位置必填类型说明示例
companyIdpathinteger(int64)公司ID1
accountpathstring收银员账号"C001"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
GET

/api/cashier/query-page

收银员管理接口 查询收银员(分页)接口 OperationId: query_24

调用方法

GET /api/cashier/query-page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdquerylong公司ID1
statusquerystring状态"ACTIVE"
typequerystring类型"CASHIER"

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier
DELETE

/api/store-trade-reason/delete

交易理由业务接口 交易理由删除接口 OperationId: remove

调用方法

DELETE /api/store-trade-reason/delete

参数

请求体

Content-Type: application/json 必填:类型: TradeReasonDeleteReqDTO com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonDeleteReqDTO

名称类型必填说明示例
tradeReasonListinteger(int64)[]需要删除的交易理由,不传则删除商户下所有[]

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/store-server/remove/{id}

门店服务器参数管理接口 删除门店服务器接口 OperationId: remove_1

物理删除

调用方法

DELETE /api/store-server/remove/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)门店服务器ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/printer-template/remove/{id}

打印机模版管理接口 删除打印模版接口 OperationId: remove_2

物理删除

调用方法

DELETE /api/printer-template/remove/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)打印机ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/pos/delete/{id}

机台管理接口 删除机台接口 OperationId: delete

调用方法

DELETE /api/pos/delete/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)机台ID1

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/oil/tank/remove/standard-info/{tankId}

油罐管理接口 清除油罐规格信息(按油罐ID) OperationId: clearTankStandardInfo

调用方法

DELETE /api/oil/tank/remove/standard-info/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/oil/tank/remove/standard-info/tank/{tankId}

油罐管理接口 清除油罐规格信息(按油罐ID) OperationId: clearTankStandardInfo_1

调用方法

DELETE /api/oil/tank/remove/standard-info/tank/{tankId}

参数

名称位置必填类型说明示例
tankIdpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
DELETE

/api/oil/tank/delete/standard-info/{id}

油罐管理接口 删除油罐规格信息(按规格ID) OperationId: deleteTankStandardInfo

调用方法

DELETE /api/oil/tank/delete/standard-info/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据
GET

/error

main-site-error-handler - OperationId: handleError

调用方法

GET /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/error

main-site-error-handler - OperationId: handleError_1

调用方法

POST /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/error

main-site-error-handler - OperationId: handleError_2

调用方法

PUT /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
DELETE

/error

main-site-error-handler - OperationId: handleError_3

调用方法

DELETE /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PATCH

/error

main-site-error-handler - OperationId: handleError_4

调用方法

PATCH /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
OPTIONS

/error

main-site-error-handler - OperationId: handleError_6

调用方法

OPTIONS /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
HEAD

/error

main-site-error-handler - OperationId: handleError_5

调用方法

HEAD /error

参数

请求体

响应

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

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

模型定义

com.leadwaycloud.rm.store.business.trade.reason.dto.UpdateTradeReasonReqDTO

名称类型必填说明示例
tradeReasonIdinteger(int64)交易理由ID1
orderTypestring类型"SALE"
reasonstring交易理由

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmTradeReason

com.leadwaycloud.rm.common.model.po.entity.RmTradeReason

交易理由

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
orderTypestring类型"SALE"
reasonstring交易理由

com.leadwaycloud.rm.store.business.store.server.dto.UpdateStoreServerDTO

修改门店服务器数据模版

名称类型必填说明示例
typestring服务类型"FUEL_SERVER"
codestring服务编号"001"
configstring服务配置

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer

com.leadwaycloud.rm.store.model.po.entity.RmStoreServer

门店服务器

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
typestring服务类型"FUEL_SERVER"
codestring服务编号"001"
configstring服务配置

com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantDTO

名称类型必填说明示例
namestring餐厅名称"C001"
activeboolean是否可用true
descriptionstring描述
externalIdstring外部系统ID
menuTemplateIdinteger(int64)菜单定义模版1
tableLayoutIdstring餐厅桌位布局"1"
imagesstring餐厅图片

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant

com.leadwaycloud.rm.store.model.po.entity.RmRestaurant

餐厅

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
codestring餐厅编号"C001"
namestring餐厅名称"C001"
activeboolean是否可用true
descriptionstring描述
externalIdstring外部系统ID
menuTemplateIdinteger(int64)菜单模版1
tableLayoutIdinteger(int64)餐厅桌位布局1
imagesstring餐厅图片

com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableDTO

名称类型必填说明示例
floorinteger(int32)楼层1
infostring桌位详细信息"前端自定义json字符串"
externalIdstring外部系统ID

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable

com.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

返回数据

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
codestring桌位号"C001"
floorinteger(int32)楼层1
activeboolean是否可用true
infostring桌位详细信息"前端自定义json字符串"
externalIdstring外部系统ID

com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableLayoutDTO

名称类型必填说明示例
namestring名称"C001"
layoutboolean是否可用true

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout

com.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

返回数据

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
codestring编码"C001"
namestring名称说明"1"
layoutobject[]桌位详细信息"前端自定义json字符串"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateDetailDto

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

布局模板详情(含 scene_graph)

名称类型必填说明示例
idinteger(int64)
codestring
namestring
descriptionstring
categorystring
statusstring
floorWidthnumber
floorDepthnumber
sourceLayoutIdinteger(int64)
thumbnailUrlstring
sceneGraphstring
updateTimestring(date-time)

com.leadwaycloud.rm.store.business.storelayout.dto.UpdateLayoutRequest

名称类型必填说明示例
namestring
codestring
floorWidthnumber
floorDepthnumber
sceneGraphstring
statusstring

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutDetailDto

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

门店布局详情,含场景 JSON 与结构化区域/通道/货架/排面数据

名称类型必填说明示例
idinteger(int64)布局 ID1
codestring布局编码"LAYOUT-001"
namestring布局名称"春熙路店默认布局"
versionNointeger(int32)版本号,发布时递增1
statusstring布局生命周期状态
floorWidthnumber卖场宽度(米)30
floorDepthnumber卖场深度(米)20
sceneGraphstringPascal Editor 场景 JSON 字符串
companyIdinteger(int64)公司 ID1
updateTimestring(date-time)最后更新时间
zonesLayoutDetailDto$ZoneDto[]销售区域列表
aislesLayoutDetailDto$AisleDto[]通道列表
shelvesLayoutDetailDto$ShelfDto[]货架列表(含层与排面槽位)

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$AisleDto

门店通道

名称类型必填说明示例
idinteger(int64)通道 ID
codestring通道编码
namestring通道名称
startXnumber起点 X(米)
startZnumber起点 Z(米)
endXnumber终点 X(米)
endZnumber终点 Z(米)
widthnumber通道宽度(米)
directionstring方向:HORIZONTAL|VERTICAL|CUSTOM
sceneNodeIdstring场景节点 ID

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$GoodsSlotDto

商品排面槽位(Planogram 单元格)

名称类型必填说明示例
idinteger(int64)槽位 ID
slotIndexinteger(int32)层内序号,从 0 起
goodsIdinteger(int64)ERP 商品 ID(stock_goods.id)3001
barcodeIdinteger(int64)结算条码 ID(stock_goods_barcode.id)4001
goodsCodestring货号(stock_goods.code)"GD-001"
facingsinteger(int32)横向排面列数4
depthFacingsinteger(int32)纵深陈列深度2
stackLayersinteger(int32)垂直堆叠层数1
facingstring朝向 FRONT|SIDE|TOP"FRONT"
quantityinteger(int32)陈列总件数8
displayTypestring陈列类型 STANDARD|PDQ|CLIP|HANGING|PALLET"STANDARD"
sceneNodeIdstring场景节点 ID
packWidthMminteger(int32)包装宽度(毫米)65
packHeightMminteger(int32)包装高度(毫米)200
packDepthMminteger(int32)包装深度(毫米)65

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ShelfDto

门店货架

名称类型必填说明示例
idinteger(int64)货架 ID
codestring货架编码
namestring货架名称
shelfTypestring货架类型
positionXnumberX 坐标(米)
positionYnumberY 坐标(米)
positionZnumberZ 坐标(米)
rotationYnumberY 轴旋转(弧度)
widthnumber货架宽度(米)
heightnumber货架高度(米)
depthnumber货架深度(米)
layerCountinteger(int32)层数
warehouseLocationIdinteger(int64)绑定的 ERP 库位 ID
sceneNodeIdstring场景节点 ID
layersLayoutDetailDto$ShelfLayerDto[]货架层列表

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ShelfLayerDto

货架层

名称类型必填说明示例
idinteger(int64)层 ID
layerNointeger(int32)层号,从 1 起
heightnumber层板高度(米)
maxItemsinteger(int32)最大 SKU 数
pickPriorityinteger(int32)WMS 拣货优先级,越小越先拣100
sceneNodeIdstring场景节点 ID
slotsLayoutDetailDto$GoodsSlotDto[]本层排面槽位列表

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ZoneDto

布局销售区域/形状

名称类型必填说明示例
idinteger(int64)区域 ID
codestring区域编码
namestring区域名称
zoneTypestring布局销售区域类型
shapeTypestring区域形状类型
polygonJsonstring多边形顶点 JSON:[[x,z],...]
positionXnumberX 坐标(米)
positionZnumberZ 坐标(米)
widthnumber宽度(米)
depthnumber深度(米)
rotationnumber旋转角(弧度)
colorstring显示颜色 HEX
warehouseIdinteger(int64)绑定的 ERP 仓库/门店 ID
sceneNodeIdstring场景节点 ID

com.leadwaycloud.rm.store.business.storelayout.dto.UpsertAssetPresetRequest

创建/更新资产预设

名称类型必填说明示例
codestring
namestring
descriptionstring
categorystring
nodeTypestring
presetJsonstring
thumbnailUrlstring
modelUrlstring
visualModestring
sortOrderinteger(int32)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto

com.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

门店 3D 资产预设

名称类型必填说明示例
idinteger(int64)
merchantIdinteger(int64)
codestring
namestring
descriptionstring
categorystring
nodeTypestring
presetJsonstring
thumbnailUrlstring
modelUrlstring
visualModestring
sortOrderinteger(int32)
statusstring
updateTimestring(date-time)

com.leadwaycloud.rm.store.business.printer.dto.UpdatePrinterConfigDTO

修改打印机配置数据模版

名称类型必填说明示例
connectionTypestring连接类型 【 NETWORK : 网络 SERIAL : 串口 USBSERIAL : USB串口 USB : USB BLUETOOTH : 蓝牙 】"SERIAL"
networkHoststring网络地址"192.168.2.11"
networkPortstring网络端口"9100"
serialPortstring串口地址"/etc/ttyS01"
serialBandRatestring串口波特率"19200"
serialDataBitsstring串口数据位"8"
serialStopBitsstring串口停止位"0"
serialParitystring串口奇偶校验位"0"
deviceCommandIdinteger(int64)设备指令集ID1

com.leadwaycloud.rm.store.business.printer.dto.UpdatePrinterDTO

修改打印机数据模版

名称类型必填说明示例
codestring编号"P001"
typestring类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】"THERMAL_TICKET"
namestring名称"1号票据打印机"
descriptionstring描述
printerConfigDTOUpdatePrinterConfigDTO
printTemplateListinteger(int64)[]打印模版(变更时把模版重新提交)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter

com.leadwaycloud.rm.common.model.po.entity.ResCompany

总部/区域总部/公司/门店

名称类型必填说明示例
idinteger(int64)
codestring公司编号(仅允许字母和数字)"CD01"
namestring公司名称"成都立威云"
otherCodestring其他编号"AAAA-01"
typestring类型 【 MERCHANT : 总部 EMPTY : 无任何管理功能 AREA : 区域总部 STORE : 门店 】"STORE"
statusstring状态 【 IN_OPERATION : 营业中 TO_BE_OPENED : 待开业 PREPARATION : 筹备中 DELETE : 已删除 】"IN_OPERATION"
idChainstring公司ID完整架构(上下级公司id用-连接)"123-456"
sloganstring公司标语"努力工作就是为了不工作"
initConfigstring公司配置是否初始化"false"
merchantIdinteger(int64)商户ID1
currencyIdinteger(int64)货币ID1
imagestring图片
contactResContact
merchantResMerchant

com.leadwaycloud.rm.common.model.po.entity.ResContact

地址联系关系

名称类型必填说明示例
idinteger(int64)
countryIdinteger(int64)国家ID1
stateIdinteger(int64)省、直辖市ID1
cityIdinteger(int64)城市ID1
areaIdinteger(int64)区、县ID1
streetIdinteger(int64)街道ID1
addressstring详细地址"1"
postcodestring邮编"1"
phonestring电话"1"
mobilestring手机"1"
faxstring传真"1"
emailstring邮箱"邮箱"
latLonstring经纬度

com.leadwaycloud.rm.common.model.po.entity.ResMerchant

商户

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring商户代号"lwc"
abbreviationstring简称"立威云"
fullNamestring全称"成都立威云科技有限公司"
statusboolean状态false
industrystring行业"COMPLEX"
emailstring联系邮箱(用作初始化创建账号)"sale@leadwaycloud.com"
phonestring联系电话
addressstring联系地址
logostring图标

com.leadwaycloud.rm.store.model.bo.DeviceCommandBO

设备指令集数据模版

名称类型必填说明示例
namestring指令名称"切纸"
codestring指令Code"PARTIAL_CUT"
commandstring指令"0x1D,0x56,0x00"
descriptionstring指令描述"用作执行打印切纸动作"

com.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

打印模版

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
typestring模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】"TRAN_TICKET"
namestring打印模版名称"交易小票"
contentstring模版内容
usableCompanyinteger(int64)[]可用公司1
usableCompanyStrstring可用公司
usableCompanyListResCompany[]可用公司集合

com.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

打印机

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
codestring编号"P001"
typestring类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】"THERMAL_TICKET"
statusstring状态 【 NORMAL : 正常 FAULT : 故障 DAMAGE : 损坏 MAINTAIN : 维修 】"NORMAL"
namestring名称"1号票据打印机"
descriptionstring描述
devicePrinterConfigRmDevicePrinterConfig
printTemplateListRmDevicePrintTemplate[]打印模板

com.leadwaycloud.rm.store.model.po.entity.RmDevicePrinterConfig

打印机配置

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
connectionTypestring连接类型"SERIAL"
networkHoststring网络地址"192.168.2.11"
networkPortstring网络端口"1900"
serialPortstring串口地址"/etc/ttyS01"
serialBandRatestring串口波特率"19200"
serialDataBitsstring串口数据位"8"
serialStopBitsstring串口停止位"0"
serialParitystring串口奇偶校验位"0"
deviceCommandSysDeviceCommand

com.leadwaycloud.rm.store.model.po.entity.SysDeviceCommand

设备指令

名称类型必填说明示例
idinteger(int64)ID1
brandstring品牌"EPSON"
modelstring型号"TM-T70"
typestring设备类型 【 PRINTER : 打印机 】"PRINTER"
commandDeviceCommandBO[]指令集[{"name":"切纸","code":"PARTIAL_CUT","command":"0x1D,0x56,0x00","description":"用作执行打印切纸动作"}]

com.leadwaycloud.rm.store.business.printer.dto.UpdatePrintTemplateDTO

修改打印模版数据模版

名称类型必填说明示例
typestring模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】"TRAN_TICKET"
namestring打印模版名称"交易小票"
contentstring模版内容
usableCompanyinteger(int64)[]可用公司1

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate

com.leadwaycloud.rm.store.business.pos.dto.UpdatePosDTO

分页查询机台数据模版

名称类型必填说明示例
codestring编号"POS001"
descriptionstring描述
defStockWarehouseIdinteger(int64)非油商品默认扣减库存仓库ID1
posGroupIdinteger(int64)POS分组1
modestring机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】"POS"
bindingsstring绑定主POS设备列表

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos

com.leadwaycloud.rm.store.model.po.entity.RmDevicePos

机台

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
codestring编号"POS001"
statusstring状态"INACTIVATED"
descriptionstring描述
applicationVersionstring应用版本
registerTimestring激活时间"2020-10-11 10:09:11"
deviceNamestring设备名称"MacBook-Pro-zkl.local"
deviceOSTypestring设备操作系统类型"macOS Catalina"
deviceOSVersionstring设备操作系统版本"10.15.7"
deviceMacAddressstring设备MAC地址"88:E9:FE:7B:DA:75"
deviceKeystring设备唯一标识"OJ0789I0UR290UR2393U82"
defStockWarehouseIdinteger(int64)非油商品默认扣减库存仓库ID1
modestring应用模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】"POS"
bindingsstring绑定主POS设备列表
registrationCodestringPOS注册码(Windows激活码格式)"ABCDE-FGHJK-LMNPR-STUVW-XY234"
companyResCompany
posGroupRmDevicePosGroup
posPrinterListRmDevicePrinter[]机台关联的打印机

com.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

机台分组

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司
codestring分组编号"GROUP-001"
namestring分组名称"Group 001"
descriptionstring描述
configobject分组通用配置{}

com.leadwaycloud.rm.store.business.pos.dto.RegisterPosDTO

注册机台数据模版

名称类型必填说明示例
merchantCodestring商户号"lwc"
companyCodestring公司编号"CD01"
posCodestring机台编号"POS001"
applicationVersionstring应用版本
deviceNamestring设备名称"MacBook-Pro-zkl.local"
deviceOSTypestring设备操作系统类型"macOS Catalina"
deviceOSVersionstring设备操作系统版本"10.15.7"
deviceMacAddressstring设备MAC地址"88:E9:FE:7B:DA:75"
deviceKeystring设备唯一标识"OJ0789I0UR290UR2393U82"
registrationCodestringPOS注册码(Windows激活码格式)"ABCDE-FGHJK-LMNPR-STUVW-XY234"
modelstring模式 【 POS : POS机台 SCO : 自助大屏 】"SCO"

com.leadwaycloud.rm.store.business.pos.dto.UpdatePosGroupDTO

分页查询机台分组数据模版

名称类型必填说明示例
codestring编号"POS001"
namestring名称
descriptionstring描述
configstring配置详情"{}"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilTankDTO

名称类型必填说明示例
codestring
namestring
maxVolumenumber(double)
alarmVolumenumber(double)
goodsIdinteger(int64)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTank

com.leadwaycloud.rm.store.model.po.entity.EnergyOilTank

石油-油罐

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司ID1
codestring油罐编号"1"
namestring油罐名称"#1号油罐"
stockWarehouseIdinteger(int64)仓库ID1
goodsIdinteger(int64)绑定油品ID(换罐/换油后直接更新此字段)1
maxVolumenumber(double)最大体积
alarmVolumenumber(double)警戒体积

com.leadwaycloud.rm.store.business.oil.dto.UpdateEnergyOilTankStandardInfoDTO

修改油罐规格属性

名称类型必填说明示例
heightnumber(double)油罐高度
volumenumber(double)油罐体积(对应 tank_capacity)
seqinteger(int32)排序序号
highCapacityAlarmnumber(double)高液位报警
highCapacityWarningnumber(double)高液位预警
lowCapacityAlarmnumber(double)低液位报警
lowCapacityWarningnumber(double)低液位预警
highWaterWarningnumber(double)高水位预警
highWaterAlarmnumber(double)高水位报警
lowWaterAlarmnumber(double)低水位报警
gainRationumber(double)增益系数
lossRationumber(double)损耗系数
warningTemperaturenumber(double)预警温度

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankSpecification

com.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification

返回数据

名称类型必填说明示例
idinteger(int64)
tankIdinteger(int64)
heightnumber(double)
tankCapacitynumber(double)
seqinteger(int32)
highCapacityAlarmnumber(double)
highCapacityWarningnumber(double)
lowCapacityAlarmnumber(double)
lowCapacityWarningnumber(double)
highWaterWarningnumber(double)
highWaterAlarmnumber(double)
lowWaterAlarmnumber(double)
gainRationumber(double)
lossRationumber(double)
warningTemperaturenumber(double)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)

com.leadwaycloud.rm.store.business.oil.dto.UpdateTankGoodsDTO

更新油罐绑定油品

名称类型必填说明示例
tankIdinteger(int64)油罐ID
goodsIdinteger(int64)绑定油品ID

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTankGoodsVO

com.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO

油罐绑定油品信息

名称类型必填说明示例
companyIdinteger(int64)公司ID
tankIdinteger(int64)油罐ID
tankCodestring油罐编号
tankNamestring油罐名称
stockWarehouseIdinteger(int64)油库仓库ID
goodsIdinteger(int64)绑定油品ID
goodsCodestring油品编码
goodsNamestring油品名称
energyGoodsTypestring能源商品类型

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilPumpDTO

名称类型必填说明示例
codestring
namestring
tankIdinteger(int64)
linkTanksinteger(int64)[]

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump

com.leadwaycloud.rm.store.model.po.entity.EnergyOilPump

石油-油泵

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司ID1
codestring油泵编号"1"
namestring油泵名称"#1号油泵"
oilTankEnergyOilTank
linkTankListEnergyOilTank[]可连接的油罐列表

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO

编辑油品损益配置DTO

名称类型必填说明示例
oilProfitLossDTOListUpdateOilProfitLossConfigDTO$OilProfitLossDTO[]损益配置
oilTypeGoodsDTOListUpdateOilProfitLossConfigDTO$OilTypeGoodsDTO[]油品类型商品关联DTO

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO$OilProfitLossDTO

损益配置

名称类型必填说明示例
idinteger(int64)ID1
profitLossRatioUppernumber(double)损益率上限1
profitLossRatioLowernumber(double)损益率下限1
profitLossUppernumber(double)损益上限1
profitLossLowernumber(double)损益下限1

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO$OilTypeGoodsDTO

油品类型商品关联DTO

名称类型必填说明示例
idinteger(int64)ID1
dilatationCoefficientnumber(double)膨胀系数1
goodsstring关联商品"1"

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilNozzleDTO

名称类型必填说明示例
codestring编号"1"
namestring名称"1"
pumpIdinteger(int64)油泵ID1
tankIdinteger(int64)油罐ID1
maxValuenumber(double)最大走字1

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle

com.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle

石油-油枪

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司ID1
codestring油枪编号"1"
namestring油枪名称"#1号油枪"
maxValuenumber(double)最大走字1
oilPumpEnergyOilPump
oilTankEnergyOilTank
groupstring分组"UUID"

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzle[]返回数据

com.leadwaycloud.rm.store.business.oil.dto.UpdateOilFuelServerConfigDTO

名称类型必填说明示例
hoststring
serverPathstring

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilFuelServerConfig

com.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig

返回数据

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)
hoststring
serverPathstring

com.leadwaycloud.rm.store.business.cashier.dto.UpdateCashierDTO

修改收银员数据模版

名称类型必填说明示例
passwordstring密码"111111"
statusstring状态 【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除 】"ACTIVE"
typestring类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】"CASHIER"
employeeIdinteger(int64)员工ID1
imagestring头像/形象图片 URL"https://cdn.example.com/cashier/001.png"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier

com.leadwaycloud.rm.common.model.po.entity.RmCashier

收银员

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
accountstring账号"131131"
passwordstring密码"111111"
statusstring状态 【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除 】"ACTIVE"
typestring类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】"CASHIER"
employeeIdinteger(int64)员工ID1
imagestring头像/形象图片 URL"https://cdn.example.com/cashier/001.png"

com.leadwaycloud.rm.store.business.cashier.dto.ChangeCashierPasswordDTO

收银员修改密码数据模版

名称类型必填说明示例
oldPasswordstring原密码"111111"
newPasswordstring新密码"222222"

com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonAddReqDTO

名称类型必填说明示例
orderTypestring类型"SALE"
reasonstring交易理由

com.leadwaycloud.rm.store.business.store.server.dto.AddStoreServerDTO

增加门店服务器数据模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
typestring服务类型"FUEL_SERVER"
codestring服务编号"001"
configstring服务配置

com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring餐厅编号"C001"
namestring餐厅名称"C001"
descriptionstring描述
externalIdstring外部系统ID
menuTemplateIdinteger(int64)菜单定义模版1
tableLayoutIdstring餐厅桌位布局"1"
imagesstring餐厅图片

com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantTableDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
restaurantIdinteger(int64)餐厅ID1
codestring桌位号"C001"
floorinteger(int32)楼层1
infostring桌位详细信息"前端自定义json字符串"
externalIdstring外部系统ID

com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantTableLayoutDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"C001"
namestring名称"C001"
layoutstring布局"[]"

com.leadwaycloud.rm.common.business.store.model.RmMerchantConfigBO

商户配置

名称类型必填说明示例
maxCollectItemCountinteger(int32)收藏夹最大可收藏商品项15
maxShoppingCartItemCountinteger(int32)购物车最大可添加商品项15
autoReceiveDayinteger(int32)物流发出后默认收货天数15
refundMaxDelayDayinteger(int32)退货最大延迟天数7
useGoodsBarcodePriceListboolean是否使用价目表价格true
onlineSelfOrderAutoDeliveryboolean在线自提销售订单是否自动发货true
mallShowBrandboolean商城展示品牌板块
serviceUserListinteger(int64)[]客服人员[]
serviceQrCodestring客服二维码
businessSignetstring业务专用章
saveTimeinteger(int32)商城订单提交后保留时间(分钟)。默认720分钟(12小时)720
customerServiceWindowNoticestring客服窗口提示文本
helpdeskUrlstring帮助中心链接
registerProtocolUrlstring怡合达工品服务协议链接
privacyProtocolUrlstring怡合达工品用户隐私协议链接
certificationLetterUrlstring怡合达工品电商平台认证企业申请函链接
userWriteOffUrlstring怡合达工品账号注销重要提醒链接

com.leadwaycloud.rm.store.business.merchant.config.dto.MerchantConfigUpdateRequestDTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
merchantConfigRmMerchantConfigBO

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMerchantConfig

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmMerchantConfig

com.leadwaycloud.rm.common.model.po.entity.RmMerchantConfig

返回数据

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
configstring商户零管配置

com.leadwaycloud.rm.store.business.storelayout.dto.ApplyLayoutTemplateRequest

应用布局模板创建新布局

名称类型必填说明示例
layoutNamestring
layoutCodestring
companyIdinteger(int64)
merchantIdinteger(int64)

com.leadwaycloud.rm.store.business.storelayout.dto.CreateTemplateFromLayoutRequest

从布局保存为模板

名称类型必填说明示例
namestring
codestring
descriptionstring
categorystring

com.leadwaycloud.rm.store.business.storelayout.dto.CreateLayoutRequest

名称类型必填说明示例
namestring
codestring
floorWidthnumber
floorDepthnumber
sceneGraphstring
companyIdinteger(int64)
merchantIdinteger(int64)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPublishResultDto

com.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto

布局发布结果

名称类型必填说明示例
layoutIdinteger(int64)布局 ID1
versionNointeger(int32)发布后版本号2
generatedLocationCodesstring[]本次自动生成的库位编码列表["STORE-001-S001","STORE-001-S002"]

com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest

名称类型必填说明示例
cashierAccountstring收银员账号"131131"
posCodestring机台编号"10"
businessDatestring当前营业日"2026-07-22"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEndDayResponse

com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse

日结对账结果

名称类型必填说明示例
successboolean是否成功true
differenceListEndDayReconciliationResponse$DifferenceInfo[]对账差异

com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse$Detail

其他系统数据

名称类型必填说明示例
posNostring对账机台号"1"
orderCodestring订单编号"xxx"
pkNointeger(int64)交易流水号1
tenderNostring支付方式编号"WECHAT"
tenderNamestring支付方式名称"微信"
amountnumber支付金额1

com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse$DifferenceInfo

对账差异

名称类型必填说明示例
lwcEndDayReconciliationResponse$Detail
otherEndDayReconciliationResponse$Detail

com.leadwaycloud.rm.store.business.end.day.model.EndDayResponse

返回数据

名称类型必填说明示例
reconciliationEndDayReconciliationResponse

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEndDayReconciliationResponse

com.leadwaycloud.rm.store.business.end.day.model.CompanyBusinessDateChangeRequest

名称类型必填说明示例
cashierAccountstring收银员账号"131131"
posCodestring机台编号"10"
businessDatestring当前营业日"2026-07-23"

com.leadwaycloud.core.model.RJava.lang.Boolean

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
databoolean返回数据

com.leadwaycloud.rm.store.business.printer.dto.AddPrinterConfigDTO

增加打印机配置数据模版

名称类型必填说明示例
connectionTypestring连接类型 【 NETWORK : 网络 SERIAL : 串口 USBSERIAL : USB串口 USB : USB BLUETOOTH : 蓝牙 】"SERIAL"
networkHoststring网络地址"192.168.2.11"
networkPortstring网络端口"1900"
serialPortstring串口地址"/etc/ttyS01"
serialBandRatestring串口波特率"19200"
serialDataBitsstring串口数据位"8"
serialStopBitsstring串口停止位"0"
serialParitystring串口奇偶校验位"0"
deviceCommandIdinteger(int64)设备指令集ID1

com.leadwaycloud.rm.store.business.printer.dto.AddPrinterDTO

增加打印机数据模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"P001"
typestring类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】"THERMAL_TICKET"
namestring名称"1号票据打印机"
descriptionstring描述
printerConfigDTOAddPrinterConfigDTO
printTemplateListinteger(int64)[]打印模版

com.leadwaycloud.rm.store.business.printer.dto.AddPrintTemplateDTO

增加打印模版数据模版

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
typestring模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】"TRAN_TICKET"
namestring打印模版名称"交易小票"
contentstring模版内容
usableCompanyinteger(int64)[]可用公司1

com.leadwaycloud.rm.store.business.pos.dto.AddPosGroupDTO

增加机台分组数据模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"POS001"
namestring名称
descriptionstring描述
configobject配置{}

com.leadwaycloud.core.model.RJava.lang.String

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datastring返回数据

com.leadwaycloud.rm.store.business.pos.dto.AddPosDTO

增加机台数据模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
codestring编号"POS001"
descriptionstring描述
defStockWarehouseIdinteger(int64)非油商品默认扣减库存仓库ID1
posGroupIdinteger(int64)POS分组1
modestring机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】"POS"
bindingsstring绑定主POS设备列表

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter[]返回数据

com.leadwaycloud.rm.store.business.oil.dto.AddOilTankReadingDTO

增加油罐读数模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
tankIdinteger(int64)油罐ID1
goodsIdinteger(int64)油品ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
tankCodestring油罐编号"1"
temperaturenumber(double)温度1
gaugeLevelnumber(double)总深度1
gaugeVolumenumber(double)总体积1
gaugeTcVolumenumber(double)温度校正体积1
waterLevelnumber(double)水深度1
waterVolumenumber(double)水体积1
ullageVolumenumber(double)油罐空体积1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"FUEL_SERVER"

com.leadwaycloud.rm.store.business.oil.dto.AddOilTankDTO

名称类型必填说明示例
merchantIdinteger(int64)
companyIdinteger(int64)
codestring
namestring
maxVolumenumber(double)
alarmVolumenumber(double)
goodsIdinteger(int64)
stockWarehouseIdinteger(int64)

com.leadwaycloud.rm.store.business.oil.dto.AddEnergyOilTankStandardInfoDTO

新增油罐规格属性

名称类型必填说明示例
heightnumber(double)油罐高度
volumenumber(double)油罐体积(对应 tank_capacity)
seqinteger(int32)排序序号
highCapacityAlarmnumber(double)高液位报警
highCapacityWarningnumber(double)高液位预警
lowCapacityAlarmnumber(double)低液位报警
lowCapacityWarningnumber(double)低液位预警
highWaterWarningnumber(double)高水位预警
highWaterAlarmnumber(double)高水位报警
lowWaterAlarmnumber(double)低水位报警
gainRationumber(double)增益系数
lossRationumber(double)损耗系数
warningTemperaturenumber(double)预警温度

com.leadwaycloud.rm.store.business.oil.bo.PumpNumberDTO

名称类型必填说明示例
pumpstring
numbernumber(double)

com.leadwaycloud.rm.store.business.oil.bo.TankNumberDTO

名称类型必填说明示例
tankstring
v20Volumenumber(double)
p20Densitynumber(double)
temperaturenumber(double)
observedDensitynumber(double)
observedVolumenumber(double)
fuelLevelnumber(double)
fuelVolumenumber(double)
waterLevelnumber(double)
waterVolumenumber(double)

com.leadwaycloud.rm.store.business.oil.dto.OilShiftDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankNumberListTankNumberDTO[]
pumpNumberListPumpNumberDTO[]

com.leadwaycloud.rm.store.business.oil.dto.QueryOilOrderDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
tankstring
pumpstring
nozzlestring
tradeCodestring
startTimestring(date-time)
endTimestring(date-time)

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrderOil

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmOrderOil[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrderOil

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmOrderOil

com.leadwaycloud.rm.common.model.po.entity.RmOrderOil

订单油品

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
shiftNointeger(int64)班次号1
orderIdinteger(int64)订单ID
orderItemIdinteger(int64)订单品项ID1
tankstring油罐"1"
pumpstring油泵"1"
nozzlestring油枪"1"
pumpStartNumbernumber(double)起泵码100
pumpEndNumbernumber(double)止泵码150
machineOutnumber(double)油机付出50
tradCodestring交易号"12345"
tradTimestring交易时间"2020-11-11 10:20:39"

com.leadwaycloud.rm.store.business.oil.dto.OilCollectionDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankstring
startTimestring(date-time)
endTimestring(date-time)
startVolumenumber(double)
endVolumenumber(double)
saleVolumenumber(double)
inVolumenumber(double)
v20Volumenumber(double)
p20Densitynumber(double)
temperaturenumber(double)
observedDensitynumber(double)
observedVolumenumber(double)
fuelLevelnumber(double)
fuelVolumenumber(double)
waterLevelnumber(double)
waterVolumenumber(double)
ullagenumber(double)

com.leadwaycloud.rm.store.business.oil.dto.OilBackDTO

名称类型必填说明示例
companyIdinteger(int64)
posIdinteger(int64)
shiftNointeger(int32)
shiftDatestring(date)
tankstring
numbernumber(double)
reasonstring

com.leadwaycloud.rm.store.business.oil.dto.AddOilPumpDTO

名称类型必填说明示例
companyIdinteger(int64)
codestring
namestring
tankIdinteger(int64)
linkTanksinteger(int64)[]

com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO

新增油品损益配置DTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID1
oilProfitLossDTOListAddOilProfitLossConfigDTO$OilProfitLossDTO[]损益配置
oilTypeGoodsDTOListAddOilProfitLossConfigDTO$OilTypeGoodsDTO[]油品类型商品关联DTO

com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO$OilProfitLossDTO

损益配置

名称类型必填说明示例
oilTypestring油品类型 【 GASOLINE : 汽油 DIESEL : 柴油 】"GASOLINE"
cycleTypestring周期类型 【 SINGLE_DAY : 单日 FIVE_DAYS : 五日 THIRTY_DAYS : 三十日 】"SINGLE_DAY"
profitLossRatioUppernumber(double)损益率上限1
profitLossRatioLowernumber(double)损益率下限1
profitLossUppernumber(double)损益上限1
profitLossLowernumber(double)损益下限1

com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO$OilTypeGoodsDTO

油品类型商品关联DTO

名称类型必填说明示例
oilTypestring油品类型 【 GASOLINE : 汽油 DIESEL : 柴油 】"GASOLINE"
dilatationCoefficientnumber(double)膨胀系数1
goodsstring关联商品"1"

com.leadwaycloud.rm.store.business.oil.dto.AddOilNozzleReadingDTO

增加油枪读数模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
nozzleIdinteger(int64)油枪ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
volumeTotalnumber(double)总出油量1
moneyTotalnumber(double)总出油金额1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"FUEL_SERVER"

com.leadwaycloud.rm.store.business.oil.dto.AddOilNozzleDTO

新增油枪

名称类型必填说明示例
companyIdinteger(int64)门店ID1
codestring编号"1"
namestring名称"1"
pumpIdinteger(int64)油泵ID1
tankIdinteger(int64)油罐ID1
maxValuenumber(double)最大走字1

com.leadwaycloud.rm.store.business.oil.dto.FuelServerDataAddDTO

fuelServer数据添加模型

名称类型必填说明示例
companyIdinteger(int64)公司ID1
typestring数据类型 【 TANK_READING : 油罐读数 NOZZLE_READING : 油枪读数 】
datastring数据

com.leadwaycloud.rm.store.business.oil.dto.AddOilFuelServerConfigDTO

名称类型必填说明示例
companyIdinteger(int64)
hoststring
serverPathstring

com.leadwaycloud.rm.store.business.cashier.dto.AddCashierDTO

增加收银员数据模版

名称类型必填说明示例
companyIdinteger(int64)公司ID1
accountstring账号"131131"
passwordstring密码"111111"
typestring类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】"CASHIER"
employeeIdinteger(int64)员工ID1
imagestring头像/形象图片 URL"https://cdn.example.com/cashier/001.png"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonRespVO

com.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO

返回数据

名称类型必填说明示例
idinteger(int64)ID1
merchantIdinteger(int64)商户ID1
orderTypestring类型"SALE"
reasonstring交易理由
createByinteger(int64)创建人1
createTimestring创建时间"2020-09-01 11:01:1"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListTradeReasonListRespVO[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonListRespVO

com.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

当前页数据

名称类型必填说明示例
idinteger(int64)ID1
merchantIdinteger(int64)商户ID1
orderTypestring类型"SALE"
reasonstring交易理由
createByinteger(int64)创建人1
createTimestring创建时间"2020-09-01 11:01:1"

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTradeReasonListRespVO[]返回数据

com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.String

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmStoreServer[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmStoreServer

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurant[]返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmRestaurantTable[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTable

PageableObject

名称类型必填说明示例
pagedboolean
pageNumberinteger(int32)
offsetinteger(int64)
sortSortObject
pageSizeinteger(int32)
unpagedboolean

SortObject

名称类型必填说明示例
sortedboolean
emptyboolean
unsortedboolean

com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmRestaurantTableLayout

org.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

返回数据

名称类型必填说明示例
totalPagesinteger(int32)
totalElementsinteger(int64)
pageablePageableObject
firstboolean
lastboolean
sizeinteger(int32)
contentRmRestaurantTableLayout[]
numberinteger(int32)
sortSortObject
numberOfElementsinteger(int32)
emptyboolean

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataMerchantConfigResponseVO

com.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

返回数据

名称类型必填说明示例
idinteger(int64)ID1
merchantIdinteger(int64)商户ID1
configstring商户零管配置
createByinteger(int64)创建人1
createTimestring创建时间"2020-09-01 11:01:1"

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataWarehouseDto[]返回数据

com.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

门店/库位(stock_warehouse)

名称类型必填说明示例
idinteger(int64)ID1001
codestring编码"STORE-001"
namestring名称
typestring类型 WAREHOUSE|LOCATION|LOCATION_OIL
parentIdinteger(int64)父级 ID
statusstring状态(ERP 实体无此字段时为 null)
companyIdinteger(int64)公司 ID

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataWarehouseDto

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateSummaryDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutTemplateSummaryDto[]返回数据

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateSummaryDto

布局模板摘要

名称类型必填说明示例
idinteger(int64)
codestring
namestring
descriptionstring
categorystring
statusstring
floorWidthnumber
floorDepthnumber
sourceLayoutIdinteger(int64)
thumbnailUrlstring
hasSceneGraphboolean
updateTimestring(date-time)

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutSummaryDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataLayoutSummaryDto[]返回数据

com.leadwaycloud.rm.store.business.storelayout.dto.LayoutSummaryDto

返回数据

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)
codestring
namestring
versionNointeger(int32)
statusstring布局生命周期状态
floorWidthnumber
floorDepthnumber
updateTimestring(date-time)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPlanogramValidationResultDto

com.leadwaycloud.rm.store.business.storelayout.dto.PlanogramIssueDto

Planogram 合规校验问题项

名称类型必填说明示例
ruleCodestring规则编码"QUANTITY_MISMATCH"
severitystring严重级别 ERROR|WARN|INFO"ERROR"
messagestring问题描述"槽位件数与排面三要素不一致"
shelfIdinteger(int64)货架 ID501
shelfCodestring货架编码"S001"
layerNointeger(int32)层号2
slotIndexinteger(int32)槽位序号0
goodsCodestring货号"GD-001"

com.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto

Planogram 合规校验结果

名称类型必填说明示例
layoutIdinteger(int64)布局 ID1
passedboolean是否通过(无 ERROR 级问题)true
errorCountinteger(int32)ERROR 数量0
warnCountinteger(int32)WARN 数量1
infoCountinteger(int32)INFO 数量0
issuesPlanogramIssueDto[]问题明细

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsDto[]返回数据

com.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto

商品条码(stock_goods_barcode)

名称类型必填说明示例
idinteger(int64)条码 ID4001
barcodestring条码值"690000000001"
typestring条码类型"EAN13"
defSettlementboolean是否默认结算码
specstring规格

com.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

商品信息(stock_goods),含条码列表

名称类型必填说明示例
idinteger(int64)商品 ID3001
codestring货号"GD-001"
namestring商品名称"示例可乐 330ml"
specstring规格"330ml"
typestring生产类型 INGREDIENT|PREPARE|PRODUCT"PRODUCT"
markstring标记 ENERGY|CLOTHING|CUSTOMIZE 等"CUSTOMIZE"
categoryIdinteger(int64)分类 ID101
brandIdinteger(int64)品牌 ID201
imagesstring图片 URL
barcodesGoodsBarcodeDto[]关联条码列表

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsDto

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataGoodsBarcodeDto

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayout

门店布局主表(store_layout)。站点级 3D 设计,仓库绑定在 layout_zone。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring布局业务编码,公司内唯一"LAYOUT-001"
namestring布局名称"春熙路店默认布局"
versionNointeger(int32)版本号;每次发布递增1
statusstring布局生命周期状态
floorWidthnumber卖场平面宽度(米)30
floorDepthnumber卖场平面深度(米)20
sceneGraphstringPascal Editor 完整场景 JSON(节点字典),用于 3D 渲染与撤销/重做
merchantIdinteger(int64)商户 ID(多租户隔离)1
companyIdinteger(int64)公司 ID(多租户隔离)1

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAssetPreset

门店 3D 资产预设(store_asset_preset)。商户级资产库,各门店共享可复用组件模板。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户 ID(资产库按商户共享,非单门店)1
codestring预设编码,商户内唯一"FUEL-DISPENSER-01"
namestring预设显示名称"加油机标准型"
descriptionstring预设说明
categorystring资产预设业务分类
nodeTypestringPascal 节点类型:store-shelf / store-zone / scan / spawn 等"store-shelf"
presetJsonstring合并进节点 schema 的 JSON 默认字段(尺寸、材质、metadata 等)
thumbnailUrlstring缩略图 URL
modelUrlstringGLB/GLTF 模型访问 URL;visualMode=MODEL 时指向下载 API
modelDatastring(byte)GLB/glTF 模型二进制(visualMode=MODEL 时存库)
modelContentTypestring模型 MIME 类型,如 model/gltf-binary
modelFileNamestring上传时的原始文件名(Content-Disposition,非磁盘路径)
visualModestring渲染模式:PARAMETRIC 程序几何 / MODEL 外部 GLB 模型"PARAMETRIC"
sortOrderinteger(int32)列表排序序号0
statusstring资产预设状态

com.leadwaycloud.rm.common.model.po.entity.StockWarehouse

仓库

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring编号(仅允许字母和数字)"W01"
namestring名称"默认仓库"
idChainstring仓库ID完整架构(上下级仓库id用-连接)"123-456"
systemstring是否是系统默认分组(系统默认角色(不可修改/删除))"false"
parentIdstring上一级仓库"1"
imagesstring图片
typestring类型 【 WAREHOUSE : 仓库 LOCATION : 库位 LOCATION_OIL : 油库 】"WAREHOUSE"
statusstring状态
merchantIdinteger(int64)商户ID1
companyIdinteger(int64)公司ID1

com.leadwaycloud.rm.common.model.po.entity.StockGoods

商品

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
namestring名称"抽纸"
codestring货号"KDED24123123"
virtualboolean是否是虚拟产品true
imagesstring图片"..."
originstring来源"..."
descriptionstring描述"..."
otherNamestring别名"..."
markstring标记"ENERGY"
placestring产地
gradestring等级
externalCodestring外部编号
weightboolean非标售卖商品true
fuelboolean油品true
makeboolean自制品true
barcodeSettlementboolean商品结算方式 false(商品结算,默认) true(条码结算)
carwashboolean洗车商品true
goodsCategoryIdinteger(int64)分类ID
goodsBrandIdinteger(int64)品牌ID
specstring规格
uomIdstring计量单位ID
saleUomIdstring销售单位ID
goodsCategoryStockGoodsCategory
uomSysUom
saleUomSysUom
goodsBrandStockGoodsBrand
goodsEnergyStockGoodsEnergy

com.leadwaycloud.rm.common.model.po.entity.StockGoodsBrand

商品品牌

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
codestring编号"xxx"
namestring名称"xxx"
descriptionstring描述
imagesstring图片
statusstring状态 【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除 】"ACTIVE"
cooperativeboolean是否合作品牌false

com.leadwaycloud.rm.common.model.po.entity.StockGoodsCategory

商品分类

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
namestring名称"EN13"
codestring编号"C01"
statusstring状态 【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除 】"ACTIVE"
parentIdinteger(int64)上级商品分类ID1
idChainstring完整的组织结构"600556150271616"
imagesstring图片
boutiqueboolean是否在商城展示false
descriptionstring描述

com.leadwaycloud.rm.common.model.po.entity.StockGoodsEnergy

商品能源属性

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
goodsIdinteger(int64)商品
typestring能源商品类型 【 OIL : 石油 NATURAL_GAS : 天然气 ELECTRICITY : 电 UREA : 尿素 】"OIL"

com.leadwaycloud.rm.common.model.po.entity.SysUom

计量单位

名称类型必填说明示例
idinteger(int64)ID1
codestring编号"1"
namestring名称"公斤"
shortNamestring简称
isoShortNamestringIOS简称
symbolstring符号"kg"
activeboolean是否可用true
rationumber(double)换算率1000

com.leadwaycloud.rm.common.model.po.entity.StockGoodsBarcode

商品条码

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID1
goodsIdinteger(int64)商品ID
barcodestring条码"6914068029184"
typestring条码类型"EN13"
otherBarcodestring其他条码"6914068029184"
defSettlementboolean是否是结算默认条码
imagesstring图片
specstring规格

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutZone

布局销售区域(layout_zone)。支持矩形或多边形,可绑定 ERP 仓库/门店(WAREHOUSE)。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
warehouseIdinteger(int64)绑定的 ERP 仓库/门店 ID(stock_warehouse.id,type=WAREHOUSE)1101
codestring区域编码"ZONE-A"
namestring区域名称"饮料区"
zoneTypestring布局销售区域类型
shapeTypestring区域形状类型
polygonJsonstring多边形顶点 JSON,格式 [[x,z],...](米,XZ 平面)
positionXnumber矩形/多边形锚点 X 坐标(米)0
positionZnumber矩形/多边形锚点 Z 坐标(米)0
widthnumber矩形宽度(米)10
depthnumber矩形深度(米)8
rotationnumber绕 Y 轴旋转角(弧度)0
colorstring2D/3D 显示颜色 HEX"#4A90D9"
sortOrderinteger(int32)列表排序序号,越小越靠前0
sceneNodeIdstringPascal Editor 场景节点 ID"store-zone_abc123"

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutTemplate

布局模板(layout_template)。保存完整 scene_graph,支持复制到新门店。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司 ID1
codestring模板编码"TPL-GS-001"
namestring模板名称"加油站标准模板"
descriptionstring模板说明
categorystring布局模板业态分类
statusstring布局模板状态
sourceLayoutIdinteger(int64)来源布局 ID(从哪份布局保存而来)2
thumbnailUrlstring缩略图 URL
sceneGraphstringPascal Editor 场景 JSON 快照
floorWidthnumber模板默认卖场宽度(米)30
floorDepthnumber模板默认卖场深度(米)20

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelf

门店货架(layout_shelf)。可绑定 ERP 库位,含尺寸、位置与层数。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
zoneIdinteger(int64)所属销售区域 ID101
aisleIdinteger(int64)所属通道 ID201
warehouseLocationIdinteger(int64)绑定的 ERP 库位 ID(整架或主库位)2001
codestring货架编码,发布时可生成 ERP 库位"S001"
namestring货架名称"饮料货架 A"
shelfTypestring货架类型
positionXnumber世界坐标 X(米)5
positionYnumber世界坐标 Y(米,离地高度)0
positionZnumber世界坐标 Z(米)3
rotationYnumber绕 Y 轴旋转(弧度)0
widthnumber货架宽度(米)1.2
heightnumber货架总高度(米)2
depthnumber货架深度(米)0.4
layerCountinteger(int32)层数(与 layout_shelf_layer 记录数一致)4
sceneNodeIdstringPascal Editor 场景节点 ID"store-shelf_abc123"

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelfLayer

货架层(layout_shelf_layer)。定义层号、层板高度与 WMS 拣货优先级。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
shelfIdinteger(int64)所属货架 ID501
layerNointeger(int32)层号,从 1 起自下而上2
heightnumber层板距地面高度(米)1.2
maxWeightnumber层板最大承重(千克)50
maxItemsinteger(int32)本层最大 SKU 数12
sceneNodeIdstringPascal Editor 场景节点 ID"shelf-layer_abc123"
pickPriorityinteger(int32)WMS 拣货优先级,数值越小越优先拣货100

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutGoodsSlot

货架层商品排面槽位,对应零售 Planogram 单格陈列单元

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
shelfLayerIdinteger(int64)所属货架层 ID5001
goodsIdinteger(int64)ERP 商品 ID(stock_goods.id)3001
barcodeIdinteger(int64)ERP 结算条码 ID(stock_goods_barcode.id)4001
goodsCodestring冗余货号(stock_goods.code),便于列表展示"GD-001"
slotIndexinteger(int32)层内从左到右序号,从 0 开始0
facingsinteger(int32)横向排面列数(顾客可见正面数)4
depthFacingsinteger(int32)纵深陈列深度(向货架内延伸的列数)2
stackLayersinteger(int32)垂直堆叠层数1
facingstring商品朝向"FRONT"
quantityinteger(int32)陈列总件数,通常 = facings × depthFacings × stackLayers8
displayTypestring陈列类型"STANDARD"
positionOffsetnumber层内水平偏移(米)0
sceneNodeIdstringPascal Editor 场景节点 ID"goods-slot_abc123"
packWidthMminteger(int32)单品包装宽度(毫米),用于 3D 占宽与溢出校验65
packHeightMminteger(int32)单品包装高度(毫米)200
packDepthMminteger(int32)单品包装深度(毫米)65

com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAisle

门店通道(layout_aisle)。定义顾客动线,含起止点与通道宽度。

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
layoutIdinteger(int64)所属布局 ID1
zoneIdinteger(int64)所属销售区域 ID(layout_zone.id)101
codestring通道编码"AISLE-01"
namestring通道名称"主通道"
startXnumber起点 X 坐标(米)0
startZnumber起点 Z 坐标(米)0
endXnumber终点 X 坐标(米)10
endZnumber终点 Z 坐标(米)0
widthnumber通道有效宽度(米)1.2
directionstring方向:HORIZONTAL 水平 / VERTICAL 垂直 / CUSTOM 自定义"CUSTOM"
sceneNodeIdstringPascal Editor 场景节点 ID"store-aisle_abc123"

com.leadwaycloud.rm.store.model.po.entity.RmStoreAuditLog

操作审计日志(audit_log)。记录布局/模板/排面等资源的业务操作轨迹。

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司 ID1
userIdinteger(int64)操作用户 ID100
actionstring动作编码,如 PUBLISH_LAYOUT / APPLY_TEMPLATE / PLANogram_AUDIT"PUBLISH_LAYOUT"
resourceTypestring资源类型:LAYOUT / TEMPLATE / ASSET_PRESET 等"LAYOUT"
resourceIdinteger(int64)资源主键 ID1
detailstring操作详情 JSON 或文本
createTimestring(date-time)创建时间

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataAssetPresetDto[]返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos[]返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmDevicePrinter[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrinter

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmDevicePrintTemplate[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePrintTemplate

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmGoodsUpdateNotifyPos[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmGoodsUpdateNotifyPos

com.leadwaycloud.rm.common.model.po.entity.ResUser

用户

名称类型必填说明示例
idinteger(int64)
userNamestring账号"kunliang.zeng@leadwaycloud.com"
namestring名称"曾锟亮"
statusstring状态 【 ACTIVE : 活跃 BLOCK : 锁定 DELETE : 删除 INACTIVATED : 未激活 FREEZE : 冻结 】
auditStatusstring用户审核状态 【 PENDING_REVIEW : APPROVEING : APPROVEDONE : 】
partnerIdinteger(int64)关系ID
idaasIdstringIDaas用户ID
externalCodestring外部编号

com.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos

零管商品变更通知机台

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
companyIdinteger(int64)公司ID1
goodsIdinteger(int64)商品ID1
devicePosIdinteger(int64)设备机台ID1
updateTypestring变更类型 【 ERP_UPDATE : ERP商品基础信息变更 RM_UPDATE : 零管商品信息变更 】"RM_UPDATE"
updateUserResUser
updateDatastring变更数据
notifiedboolean是否已经通知false

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataPosBusinessInfoResponse

com.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse

返回数据

名称类型必填说明示例
businessDatestring营业日"2020-10-11"
shiftNointeger(int64)班次号1
pkNointeger(int64)交易流水号1

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmDevicePos[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePos

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup[]返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmDevicePosGroup[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmDevicePosGroup

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListEnergyOilTankReading[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilTankReading

com.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading

油罐读数

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司ID1
tankIdinteger(int64)油罐ID1
goodsIdinteger(int64)油品ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
tankCodestring油罐编号"1"
temperaturenumber(double)温度1
gaugeLevelnumber(double)总深度1
gaugeVolumenumber(double)总体积1
gaugeTcVolumenumber(double)温度校正体积1
waterLevelnumber(double)水深度1
waterVolumenumber(double)水体积1
ullageVolumenumber(double)油罐空体积1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"MANUAL"
createTimestring创建时间"2020-10-11 13:09:11"

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.oil.vo.OilTankListVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataOilTankListVO[]返回数据

com.leadwaycloud.rm.store.business.oil.vo.OilTankListVO

油罐列表项(含规格属性)

名称类型必填说明示例
idinteger(int64)油罐ID
companyIdinteger(int64)公司ID
codestring油罐编号
namestring油罐名称
stockWarehouseIdinteger(int64)仓库ID
goodsIdinteger(int64)绑定油品ID
maxVolumenumber(double)最大体积
alarmVolumenumber(double)警戒体积
specificationEnergyOilTankSpecification

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataTankGoodsVO[]返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilPump[]返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.OilProfitLossConfigVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataOilProfitLossConfigVO

com.leadwaycloud.rm.store.business.oil.vo.OilProfitLossConfigVO

返回数据

名称类型必填说明示例
oilProfitLossConfigListAddOilProfitLossConfigDTO$OilProfitLossDTO
oilTypeGoodsConfigListAddOilProfitLossConfigDTO$OilTypeGoodsDTO

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListEnergyOilNozzleReading[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataEnergyOilNozzleReading

com.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading

油枪读数

名称类型必填说明示例
idinteger(int64)
companyIdinteger(int64)公司ID1
nozzleIdinteger(int64)油枪ID1
businessDatestring(date)营业日"2026-06-01"
readingTimestring读数时间"2026-06-01 10:09:11"
volumeTotalnumber(double)总出油量1
moneyTotalnumber(double)总出油金额1
sourcestring来源(MANUAL、POS、FUEL_SERVER)"MANUAL"
createTimestring创建时间"2020-10-11 13:09:11"
transactionNostringfuelServer交易号"1"
startTotalnumber(double)起码1
endTotalnumber(double)止码1
startTimestring读数时间"2026-06-01 10:09:11"
endTimestring读数时间"2026-06-01 10:09:11"
amountnumber(double)加油金额1
unitPricenumber(double)加油金额1
nozzleCodestring枪号"1"
pumpCodestring泵号"1"
tankCodestring罐号"1"

com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmCashier

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListRmCashier[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmCashier

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataRmCashier

com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonDeleteReqDTO

名称类型必填说明示例
tradeReasonListinteger(int64)[]需要删除的交易理由,不传则删除商户下所有[]

com.leadwaycloud.core.model.R

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据