服务地址
| 地址 | 说明 |
|---|
| 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| tradeReasonId | integer(int64) | 是 | 交易理由ID | 1 |
| orderType | string | 否 | 类型 | "SALE" |
| reason | string | 否 | 交易理由 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmTradeReason | 否 | | |
PUT
/api/store-server/update/{id}
门店服务器参数管理接口
修改门店服务器接口
OperationId: update_1
调用方法
PUT /api/store-server/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 门店服务器ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateStoreServerDTO com.leadwaycloud.rm.store.business.store.server.dto.UpdateStoreServerDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 否 | 服务类型 | "FUEL_SERVER" |
| code | string | 否 | 服务编号 | "001" |
| config | string | 否 | 服务配置 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmStoreServer com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmStoreServer | 否 | | |
PUT
/api/store-restaurant/update/{id}
门店餐厅管理接口
修改门店餐厅接口
OperationId: update_2
调用方法
PUT /api/store-restaurant/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 餐厅ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateRestaurantDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 餐厅名称 | "C001" |
| active | boolean | 是 | 是否可用 | true |
| description | string | 是 | 描述 | |
| externalId | string | 是 | 外部系统ID | |
| menuTemplateId | integer(int64) | 是 | 菜单定义模版 | 1 |
| tableLayoutId | string | 是 | 餐厅桌位布局 | "1" |
| images | string | 是 | 餐厅图片 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurant com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurant | 否 | | |
PUT
/api/store-restaurant-table/update/{id}
门店餐厅桌位管理接口
修改门店餐厅桌位接口
OperationId: update_3
调用方法
PUT /api/store-restaurant-table/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateRestaurantTableDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| floor | integer(int32) | 否 | 楼层 | 1 |
| info | string | 否 | 桌位详细信息 | "前端自定义json字符串" |
| externalId | string | 否 | 外部系统ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTable com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTable | 否 | | |
PUT
/api/store-restaurant-table/recovery/{id}
门店餐厅桌位管理接口
回收门店餐厅桌位接口
OperationId: recovery
调用方法
PUT /api/store-restaurant-table/recovery/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/store-restaurant-table/enable/{id}
门店餐厅桌位管理接口
启用门店餐厅桌位接口
OperationId: enable
调用方法
PUT /api/store-restaurant-table/enable/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/store-restaurant-table-layout/update/{id}
门店餐厅桌位布局管理接口
修改门店餐厅桌位布局
OperationId: update_4
调用方法
PUT /api/store-restaurant-table-layout/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位布局ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateRestaurantTableLayoutDTO com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableLayoutDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | "C001" |
| layout | boolean | 是 | 是否可用 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTableLayout com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTableLayout | 否 | | |
PUT
/api/store-layout/v1/templates/{id}/scene-graph
布局模板
更新模板 scene_graph
OperationId: updateSceneGraph
用于内置模板初始化或管理员补全
调用方法
PUT /api/store-layout/v1/templates/{id}/scene-graph
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: object
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutTemplateDetailDto | 否 | | |
GET
/api/store-layout/v1/layouts/{id}
布局
布局详情
OperationId: getById
含 scene_graph、区域、通道、货架、layout_goods_slot 排面槽位
调用方法
GET /api/store-layout/v1/layouts/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 布局 ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutDetailDto | 否 | | |
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}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateLayoutRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpdateLayoutRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | | |
| code | string | 否 | | |
| floorWidth | number | 否 | | |
| floorDepth | number | 否 | | |
| sceneGraph | string | 否 | | |
| status | string | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutDetailDto | 否 | | |
GET
/api/store-layout/v1/asset-presets/{id}
资产预设
资产预设详情
OperationId: getById_1
调用方法
GET /api/store-layout/v1/asset-presets/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AssetPresetDto | 否 | | |
PUT
/api/store-layout/v1/asset-presets/{id}
资产预设
更新资产预设
OperationId: update_6
调用方法
PUT /api/store-layout/v1/asset-presets/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpsertAssetPresetRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpsertAssetPresetRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | | |
| name | string | 是 | | |
| description | string | 否 | | |
| category | string | 是 | | |
| nodeType | string | 是 | | |
| presetJson | string | 是 | | |
| thumbnailUrl | string | 否 | | |
| modelUrl | string | 否 | | |
| visualMode | string | 否 | | |
| sortOrder | integer(int32) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AssetPresetDto | 否 | | |
DELETE
/api/store-layout/v1/asset-presets/{id}
资产预设
归档资产预设
OperationId: archive
调用方法
DELETE /api/store-layout/v1/asset-presets/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/printer/update/{id}
打印机管理接口
修改打印机接口
OperationId: update_7
调用方法
PUT /api/printer/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdatePrinterDTO com.leadwaycloud.rm.store.business.printer.dto.UpdatePrinterDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "P001" |
| type | string | 否 | 类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】 | "THERMAL_TICKET" |
| name | string | 否 | 名称 | "1号票据打印机" |
| description | string | 否 | 描述 | |
| printerConfigDTO | UpdatePrinterConfigDTO | 否 | | |
| printTemplateList | integer(int64)[] | 否 | 打印模版(变更时把模版重新提交) | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
PUT
/api/printer/update-status/{id}
打印机管理接口
-
OperationId: updatePrinterStatus
调用方法
PUT /api/printer/update-status/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: string
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
PUT
/api/printer-template/update/{id}
打印机模版管理接口
修改打印机模版接口
OperationId: update_8
调用方法
PUT /api/printer-template/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机模版ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdatePrintTemplateDTO com.leadwaycloud.rm.store.business.printer.dto.UpdatePrintTemplateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 否 | 模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】 | "TRAN_TICKET" |
| name | string | 否 | 打印模版名称 | "交易小票" |
| content | string | 否 | 模版内容 | |
| usableCompany | integer(int64)[] | 否 | 可用公司 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrintTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrintTemplate | 否 | | |
PUT
/api/pos/update/{id}
机台管理接口
修改机台接口
OperationId: update_9
调用方法
PUT /api/pos/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdatePosDTO com.leadwaycloud.rm.store.business.pos.dto.UpdatePosDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "POS001" |
| description | string | 否 | 描述 | |
| defStockWarehouseId | integer(int64) | 否 | 非油商品默认扣减库存仓库ID | 1 |
| posGroupId | integer(int64) | 否 | POS分组 | 1 |
| mode | string | 否 | 机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】 | "POS" |
| bindings | string | 否 | 绑定主POS设备列表 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
PUT
/api/pos/reset/{id}
机台管理接口
重置机台接口
OperationId: register
仅重置机台信息,相关的班次/流水/打印机关系不会被重置
调用方法
PUT /api/pos/reset/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
PUT
/api/pos/register
机台管理接口
注册机台接口
OperationId: register_1
调用方法
PUT /api/pos/register
参数
无
请求体
Content-Type: application/json 必填: 是 类型: RegisterPosDTO com.leadwaycloud.rm.store.business.pos.dto.RegisterPosDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantCode | string | 是 | 商户号 | "lwc" |
| companyCode | string | 是 | 公司编号 | "CD01" |
| posCode | string | 是 | 机台编号 | "POS001" |
| applicationVersion | string | 否 | 应用版本 | |
| deviceName | string | 否 | 设备名称 | "MacBook-Pro-zkl.local" |
| deviceOSType | string | 否 | 设备操作系统类型 | "macOS Catalina" |
| deviceOSVersion | string | 否 | 设备操作系统版本 | "10.15.7" |
| deviceMacAddress | string | 否 | 设备MAC地址 | "88:E9:FE:7B:DA:75" |
| deviceKey | string | 否 | 设备唯一标识 | "OJ0789I0UR290UR2393U82" |
| registrationCode | string | 否 | POS注册码(Windows激活码格式) | "ABCDE-FGHJK-LMNPR-STUVW-XY234" |
| model | string | 否 | 模式 【 POS : POS机台 SCO : 自助大屏 】 | "SCO" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
PUT
/api/pos/pos-group/update/{id}
机台管理接口
修改机台分组接口
OperationId: updatePosGroup
调用方法
PUT /api/pos/pos-group/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台分组ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdatePosGroupDTO com.leadwaycloud.rm.store.business.pos.dto.UpdatePosGroupDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "POS001" |
| name | string | 否 | 名称 | |
| description | string | 否 | 描述 | |
| config | string | 否 | 配置详情 | "{}" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePosGroup com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePosGroup | 否 | | |
PUT
/api/pos/generate-registration-code/{id}
机台管理接口
生成机台注册码接口
OperationId: generateRegistrationCode
为未激活机台生成或重新生成 Windows 风格注册码
调用方法
PUT /api/pos/generate-registration-code/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
PUT
/api/oil/tank/update/{id}
油罐管理接口
修改油罐
OperationId: update_10
调用方法
PUT /api/oil/tank/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateOilTankDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilTankDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | | |
| name | string | 否 | | |
| maxVolume | number(double) | 否 | | |
| alarmVolume | number(double) | 否 | | |
| goodsId | integer(int64) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTank com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTank | 否 | | |
PUT
/api/oil/tank/update/standard-info/{id}
油罐管理接口
修改油罐规格信息(按规格ID)
OperationId: updateTankStandardInfo
调用方法
PUT /api/oil/tank/update/standard-info/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateEnergyOilTankStandardInfoDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| height | number(double) | 否 | 油罐高度 | |
| volume | number(double) | 否 | 油罐体积(对应 tank_capacity) | |
| seq | integer(int32) | 否 | 排序序号 | |
| highCapacityAlarm | number(double) | 否 | 高液位报警 | |
| highCapacityWarning | number(double) | 否 | 高液位预警 | |
| lowCapacityAlarm | number(double) | 否 | 低液位报警 | |
| lowCapacityWarning | number(double) | 否 | 低液位预警 | |
| highWaterWarning | number(double) | 否 | 高水位预警 | |
| highWaterAlarm | number(double) | 否 | 高水位报警 | |
| lowWaterAlarm | number(double) | 否 | 低水位报警 | |
| gainRatio | number(double) | 否 | 增益系数 | |
| lossRatio | number(double) | 否 | 损耗系数 | |
| warningTemperature | number(double) | 否 | 预警温度 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
PUT
/api/oil/tank/update/standard-info/tank/{tankId}
油罐管理接口
修改油罐规格信息(按油罐ID,一罐一条)
OperationId: updateTankStandardInfoByTank
调用方法
PUT /api/oil/tank/update/standard-info/tank/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateEnergyOilTankStandardInfoDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| height | number(double) | 否 | 油罐高度 | |
| volume | number(double) | 否 | 油罐体积(对应 tank_capacity) | |
| seq | integer(int32) | 否 | 排序序号 | |
| highCapacityAlarm | number(double) | 否 | 高液位报警 | |
| highCapacityWarning | number(double) | 否 | 高液位预警 | |
| lowCapacityAlarm | number(double) | 否 | 低液位报警 | |
| lowCapacityWarning | number(double) | 否 | 低液位预警 | |
| highWaterWarning | number(double) | 否 | 高水位预警 | |
| highWaterAlarm | number(double) | 否 | 高水位报警 | |
| lowWaterAlarm | number(double) | 否 | 低水位报警 | |
| gainRatio | number(double) | 否 | 增益系数 | |
| lossRatio | number(double) | 否 | 损耗系数 | |
| warningTemperature | number(double) | 否 | 预警温度 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| tankId | integer(int64) | 是 | 油罐ID | |
| goodsId | integer(int64) | 是 | 绑定油品ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: TankGoodsVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TankGoodsVO | 否 | | |
PUT
/api/oil/pump/update/{id}
油泵管理接口
修改油泵
OperationId: update_11
调用方法
PUT /api/oil/pump/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateOilPumpDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilPumpDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | | |
| name | string | 否 | | |
| tankId | integer(int64) | 否 | | |
| linkTanks | integer(int64)[] | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilPump com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilPump | 否 | | |
PUT
/api/oil/profit-loss/config/update/{merchantId}
油品损益配置
编辑配置
OperationId: update_12
调用方法
PUT /api/oil/profit-loss/config/update/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateOilProfitLossConfigDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| oilProfitLossDTOList | UpdateOilProfitLossConfigDTO$OilProfitLossDTO[] | 是 | 损益配置 | |
| oilTypeGoodsDTOList | UpdateOilProfitLossConfigDTO$OilTypeGoodsDTO[] | 是 | 油品类型商品关联DTO | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/oil/nozzle/update/{id}
油枪管理接口
修改油枪
OperationId: update_13
调用方法
PUT /api/oil/nozzle/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateOilNozzleDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilNozzleDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 名称 | "1" |
| pumpId | integer(int64) | 否 | 油泵ID | 1 |
| tankId | integer(int64) | 否 | 油罐ID | 1 |
| maxValue | number(double) | 否 | 最大走字 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzle com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle[] | 否 | 返回数据 | |
PUT
/api/oil/fuel-server/update/{id}
Fuel服务管理接口
修改Fuel服务配置
OperationId: update_14
调用方法
PUT /api/oil/fuel-server/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateOilFuelServerConfigDTO com.leadwaycloud.rm.store.business.oil.dto.UpdateOilFuelServerConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| host | string | 否 | | |
| serverPath | string | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilFuelServerConfig com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilFuelServerConfig | 否 | | |
PUT
/api/cashier/update/{id}
收银员管理接口
修改收银员接口
OperationId: updateCashierPassword
调用方法
PUT /api/cashier/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 收银员ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateCashierDTO com.leadwaycloud.rm.store.business.cashier.dto.UpdateCashierDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| password | string | 否 | 密码 | "111111" |
| status | string | 否 | 状态 【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除 】 | "ACTIVE" |
| type | string | 否 | 类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】 | "CASHIER" |
| employeeId | integer(int64) | 否 | 员工ID | 1 |
| image | string | 否 | 头像/形象图片 URL | "https://cdn.example.com/cashier/001.png" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmCashier com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
PUT
/api/cashier/change-password/{id}
收银员管理接口
收银员修改密码接口
OperationId: changePassword
调用方法
PUT /api/cashier/change-password/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 收银员ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: ChangeCashierPasswordDTO com.leadwaycloud.rm.store.business.cashier.dto.ChangeCashierPasswordDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| oldPassword | string | 是 | 原密码 | "111111" |
| newPassword | string | 是 | 新密码 | "222222" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmCashier com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| orderType | string | 是 | 类型 | "SALE" |
| reason | string | 是 | 交易理由 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmTradeReason com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmTradeReason | 否 | | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 服务类型 | "FUEL_SERVER" |
| code | string | 是 | 服务编号 | "001" |
| config | string | 是 | 服务配置 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmStoreServer com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmStoreServer | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 餐厅编号 | "C001" |
| name | string | 是 | 餐厅名称 | "C001" |
| description | string | 是 | 描述 | |
| externalId | string | 是 | 外部系统ID | |
| menuTemplateId | integer(int64) | 是 | 菜单定义模版 | 1 |
| tableLayoutId | string | 是 | 餐厅桌位布局 | "1" |
| images | string | 是 | 餐厅图片 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurant com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurant | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| restaurantId | integer(int64) | 是 | 餐厅ID | 1 |
| code | string | 是 | 桌位号 | "C001" |
| floor | integer(int32) | 是 | 楼层 | 1 |
| info | string | 否 | 桌位详细信息 | "前端自定义json字符串" |
| externalId | string | 否 | 外部系统ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTable com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTable | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "C001" |
| name | string | 是 | 名称 | "C001" |
| layout | string | 是 | 布局 | "[]" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTableLayout com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTableLayout | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| merchantConfig | RmMerchantConfigBO | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmMerchantConfig com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMerchantConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmMerchantConfig | 否 | | |
POST
/api/store-layout/v1/templates/{id}/apply
布局模板
应用模板到门店
OperationId: apply
创建新布局并复制模板 scene_graph
调用方法
POST /api/store-layout/v1/templates/{id}/apply
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: ApplyLayoutTemplateRequest com.leadwaycloud.rm.store.business.storelayout.dto.ApplyLayoutTemplateRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| layoutName | string | 是 | | |
| layoutCode | string | 否 | | |
| companyId | integer(int64) | 是 | | |
| merchantId | integer(int64) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutDetailDto | 否 | | |
POST
/api/store-layout/v1/templates/from-layout/{layoutId}
布局模板
从布局保存为模板
OperationId: createFromLayout
调用方法
POST /api/store-layout/v1/templates/from-layout/{layoutId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| layoutId | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: CreateTemplateFromLayoutRequest com.leadwaycloud.rm.store.business.storelayout.dto.CreateTemplateFromLayoutRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | | |
| code | string | 否 | | |
| description | string | 否 | | |
| category | string | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutTemplateDetailDto | 否 | | |
GET
/api/store-layout/v1/layouts
布局
布局列表
OperationId: list
按公司查询布局;可选 warehouseId 过滤含该仓库 zone 的布局
调用方法
GET /api/store-layout/v1/layouts
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | integer(int64) | 公司 ID | 1 |
| warehouseId | query | 否 | integer(int64) | 可选:按 zone 绑定的 ERP 仓库过滤 | 1101 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutSummaryDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutSummaryDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutSummaryDto[] | 否 | 返回数据 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | | |
| code | string | 否 | | |
| floorWidth | number | 否 | | |
| floorDepth | number | 否 | | |
| sceneGraph | string | 否 | | |
| companyId | integer(int64) | 是 | | |
| merchantId | integer(int64) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutDetailDto | 否 | | |
POST
/api/store-layout/v1/layouts/{id}/publish
布局
发布布局
OperationId: publish
状态改为 PUBLISHED,版本号 +1,保存版本快照,并为未绑定库位的货架生成 LOCATION 编码
调用方法
POST /api/store-layout/v1/layouts/{id}/publish
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PublishResultDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PublishResultDto | 否 | | |
POST
/api/store-layout/v1/layouts/{id}/archive
布局
归档布局
OperationId: archive_1
状态改为 ARCHIVED,不再作为当前编辑方案
调用方法
POST /api/store-layout/v1/layouts/{id}/archive
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutDetailDto | 否 | | |
GET
/api/store-layout/v1/asset-presets
资产预设
资产预设列表
OperationId: list_1
按商户查询;可选 category=SHELF|FUEL|CANOPY|...
调用方法
GET /api/store-layout/v1/asset-presets
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | | |
| category | query | 否 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AssetPresetDto[] | 否 | 返回数据 | |
POST
/api/store-layout/v1/asset-presets
资产预设
创建资产预设
OperationId: create_1
调用方法
POST /api/store-layout/v1/asset-presets
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpsertAssetPresetRequest com.leadwaycloud.rm.store.business.storelayout.dto.UpsertAssetPresetRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | | |
| name | string | 是 | | |
| description | string | 否 | | |
| category | string | 是 | | |
| nodeType | string | 是 | | |
| presetJson | string | 是 | | |
| thumbnailUrl | string | 否 | | |
| modelUrl | string | 否 | | |
| visualMode | string | 否 | | |
| sortOrder | integer(int32) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AssetPresetDto | 否 | | |
GET
/api/store-layout/v1/asset-presets/{id}/model-file
资产预设
下载资产 3D 模型
OperationId: downloadModelFile
二进制流,不使用 R 包装
调用方法
GET /api/store-layout/v1/asset-presets/{id}/model-file
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(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
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| file | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: AssetPresetDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AssetPresetDto | 否 | | |
POST
/api/store-end-day/{id}
门店日结
门店日结接口
OperationId: storeEndDay
自动进行门店日结对账,并根据对账结果与商户规则,发送消息通知门店机台进行营业日切换
调用方法
POST /api/store-end-day/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司ID | 948513515844539 |
请求体
Content-Type: application/json 必填: 是 类型: EndDayRequest com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| cashierAccount | string | 是 | 收银员账号 | "131131" |
| posCode | string | 是 | 机台编号 | "10" |
| businessDate | string | 是 | 当前营业日 | "2026-07-22" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EndDayResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayResponse
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EndDayResponse | 否 | | |
POST
/api/store-end-day/reconciliation/{id}
门店日结
门店日结对账接口
OperationId: endDayReconciliation
进行门店日结对账,并返回对账结果
调用方法
POST /api/store-end-day/reconciliation/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司ID | 948513515844539 |
请求体
Content-Type: application/json 必填: 是 类型: EndDayRequest com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| cashierAccount | string | 是 | 收银员账号 | "131131" |
| posCode | string | 是 | 机台编号 | "10" |
| businessDate | string | 是 | 当前营业日 | "2026-07-22" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EndDayReconciliationResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EndDayReconciliationResponse | 否 | | |
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}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司ID | 948513515844539 |
| newBusinessDate | path | 是 | string(date) | 新的营业日 | "2026-07-22" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/api/store-end-day/change/business-date/{id}/{businessDate}
门店日结
更新门店营业日接口
OperationId: changeBusinessDate
写入门店营业日切换记录与日志,并消息通知门店所有机台切换营业日
调用方法
POST /api/store-end-day/change/business-date/{id}/{businessDate}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司ID | 948513515844539 |
请求体
Content-Type: application/json 必填: 是 类型: CompanyBusinessDateChangeRequest com.leadwaycloud.rm.store.business.end.day.model.CompanyBusinessDateChangeRequest
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| cashierAccount | string | 是 | 收银员账号 | "131131" |
| posCode | string | 是 | 机台编号 | "10" |
| businessDate | string | 是 | 当前营业日 | "2026-07-23" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/api/printer/untie/all-pos/{printerId}
打印机管理接口
解绑所有机台接口
OperationId: untieAllPos
调用方法
POST /api/printer/untie/all-pos/{printerId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| printerId | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/printer/add
打印机管理接口
新增打印机接口
OperationId: add_5
调用方法
POST /api/printer/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddPrinterDTO com.leadwaycloud.rm.store.business.printer.dto.AddPrinterDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "P001" |
| type | string | 是 | 类型 【 MATRIX_PRINTER : 针式票据打印机 THERMAL_PRINTER : 热敏式票据打印机 】 | "THERMAL_TICKET" |
| name | string | 是 | 名称 | "1号票据打印机" |
| description | string | 否 | 描述 | |
| printerConfigDTO | AddPrinterConfigDTO | 是 | | |
| printTemplateList | integer(int64)[] | 否 | 打印模版 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| type | string | 是 | 模版类型 【 TRAN_TICKET : 交易票据 XREAD_TICKET : 班结票据 PAYIN_TICKET : PAYIN票据 PAYOUT_TICKET : PAYOUT票据 PROMOTIONAL_PRICE_TAG : 促销价签 】 | "TRAN_TICKET" |
| name | string | 是 | 打印模版名称 | "交易小票" |
| content | string | 是 | 模版内容 | |
| usableCompany | integer(int64)[] | 否 | 可用公司 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrintTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrintTemplate | 否 | | |
POST
/api/pos/update-goods-callback/{id}
机台管理接口
机台更新商品回调接口
OperationId: callbackPosUpdateGoods
调用方法
POST /api/pos/update-goods-callback/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/pos/remove/pos-printer/{posId}/{printerId}
机台管理接口
机台解绑打印机接口
OperationId: posUntiePrinter
调用方法
POST /api/pos/remove/pos-printer/{posId}/{printerId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| posId | path | 是 | integer(int64) | 机台ID | 1 |
| printerId | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "POS001" |
| name | string | 否 | 名称 | |
| description | string | 否 | 描述 | |
| config | object | 否 | 配置 | {} |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePosGroup com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePosGroup | 否 | | |
POST
/api/pos/manual-notify/goods-update-goods/{goodsUpdateNotifyPosId}
机台管理接口
查询机台商品更新通知机台记录接口
OperationId: queryGoodsUpdateNotifyPosRecord
调用方法
POST /api/pos/manual-notify/goods-update-goods/{goodsUpdateNotifyPosId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| goodsUpdateNotifyPosId | path | 是 | integer(int64) | 机台商品更新通知机台记录ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/pos/get/api-connection-token/{id}
机台管理接口
获取POS接口通讯Token接口
OperationId: getAPIConnectionToken
Token 一年有效
调用方法
POST /api/pos/get/api-connection-token/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 | |
POST
/api/pos/add
机台管理接口
新增机台接口
OperationId: add_7
调用方法
POST /api/pos/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddPosDTO com.leadwaycloud.rm.store.business.pos.dto.AddPosDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "POS001" |
| description | string | 否 | 描述 | |
| defStockWarehouseId | integer(int64) | 否 | 非油商品默认扣减库存仓库ID | 1 |
| posGroupId | integer(int64) | 否 | POS分组 | 1 |
| mode | string | 否 | 机台模式 【 POS : 收银pos机 KDS : 厨房显示器 ORD : 订单显示屏 MDS : 媒体显示屏 SCO : 自助服务机 CDS : 独立客显 】 | "POS" |
| bindings | string | 否 | 绑定主POS设备列表 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
POST
/api/pos/add/pos-printer/{id}
机台管理接口
-
OperationId: addPosPrinter
调用方法
POST /api/pos/add/pos-printer/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter[] | 否 | 返回数据 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| tankId | integer(int64) | 是 | 油罐ID | 1 |
| goodsId | integer(int64) | 是 | 油品ID | 1 |
| businessDate | string(date) | 是 | 营业日 | "2026-06-01" |
| readingTime | string | 否 | 读数时间 | "2026-06-01 10:09:11" |
| tankCode | string | 否 | 油罐编号 | "1" |
| temperature | number(double) | 否 | 温度 | 1 |
| gaugeLevel | number(double) | 否 | 总深度 | 1 |
| gaugeVolume | number(double) | 否 | 总体积 | 1 |
| gaugeTcVolume | number(double) | 否 | 温度校正体积 | 1 |
| waterLevel | number(double) | 否 | 水深度 | 1 |
| waterVolume | number(double) | 否 | 水体积 | 1 |
| ullageVolume | number(double) | 否 | 油罐空体积 | 1 |
| source | string | 否 | 来源(MANUAL、POS、FUEL_SERVER) | "FUEL_SERVER" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/oil/tank/import/standard-info/tank/{tankId}
油罐管理接口
导入油罐规格信息(一罐一条,覆盖已有)
OperationId: importTankStandardInfo
调用方法
POST /api/oil/tank/import/standard-info/tank/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| file | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/oil/tank/import/standard-info/{tankId}
油罐管理接口
导入油罐规格信息(一罐一条,覆盖已有)
OperationId: importTankStandardInfo_1
调用方法
POST /api/oil/tank/import/standard-info/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| file | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 否 | | |
| companyId | integer(int64) | 否 | | |
| code | string | 否 | | |
| name | string | 否 | | |
| maxVolume | number(double) | 否 | | |
| alarmVolume | number(double) | 否 | | |
| goodsId | integer(int64) | 否 | | |
| stockWarehouseId | integer(int64) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTank com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTank | 否 | | |
POST
/api/oil/tank/add/standard-info/{tankId}
油罐管理接口
添加油罐规格信息(一罐一条)
OperationId: addTankStandardInfo
调用方法
POST /api/oil/tank/add/standard-info/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: AddEnergyOilTankStandardInfoDTO com.leadwaycloud.rm.store.business.oil.dto.AddEnergyOilTankStandardInfoDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| height | number(double) | 否 | 油罐高度 | |
| volume | number(double) | 否 | 油罐体积(对应 tank_capacity) | |
| seq | integer(int32) | 否 | 排序序号 | |
| highCapacityAlarm | number(double) | 否 | 高液位报警 | |
| highCapacityWarning | number(double) | 否 | 高液位预警 | |
| lowCapacityAlarm | number(double) | 否 | 低液位报警 | |
| lowCapacityWarning | number(double) | 否 | 低液位预警 | |
| highWaterWarning | number(double) | 否 | 高水位预警 | |
| highWaterAlarm | number(double) | 否 | 高水位报警 | |
| lowWaterAlarm | number(double) | 否 | 低水位报警 | |
| gainRatio | number(double) | 否 | 增益系数 | |
| lossRatio | number(double) | 否 | 损耗系数 | |
| warningTemperature | number(double) | 否 | 预警温度 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| posId | integer(int64) | 否 | | |
| shiftNo | integer(int32) | 否 | | |
| shiftDate | string(date) | 否 | | |
| tankNumberList | TankNumberDTO[] | 否 | | |
| pumpNumberList | PumpNumberDTO[] | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/oil/shift-business/query-order
班次业务管理接口
查询油品交易订单
OperationId: queryOrder
调用方法
POST /api/oil/shift-business/query-order
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | | |
| size | query | 是 | integer(int32) | | |
请求体
Content-Type: application/json 必填: 是 类型: QueryOilOrderDTO com.leadwaycloud.rm.store.business.oil.dto.QueryOilOrderDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| posId | integer(int64) | 否 | | |
| tank | string | 否 | | |
| pump | string | 否 | | |
| nozzle | string | 否 | | |
| tradeCode | string | 否 | | |
| startTime | string(date-time) | 否 | | |
| endTime | string(date-time) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmOrderOil com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrderOil
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmOrderOil | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| posId | integer(int64) | 否 | | |
| shiftNo | integer(int32) | 否 | | |
| shiftDate | string(date) | 否 | | |
| tank | string | 否 | | |
| startTime | string(date-time) | 否 | | |
| endTime | string(date-time) | 否 | | |
| startVolume | number(double) | 否 | | |
| endVolume | number(double) | 否 | | |
| saleVolume | number(double) | 否 | | |
| inVolume | number(double) | 否 | | |
| v20Volume | number(double) | 否 | | |
| p20Density | number(double) | 否 | | |
| temperature | number(double) | 否 | | |
| observedDensity | number(double) | 否 | | |
| observedVolume | number(double) | 否 | | |
| fuelLevel | number(double) | 否 | | |
| fuelVolume | number(double) | 否 | | |
| waterLevel | number(double) | 否 | | |
| waterVolume | number(double) | 否 | | |
| ullage | number(double) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| posId | integer(int64) | 否 | | |
| shiftNo | integer(int32) | 否 | | |
| shiftDate | string(date) | 否 | | |
| tank | string | 否 | | |
| number | number(double) | 否 | | |
| reason | string | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| posId | integer(int64) | 否 | | |
| shiftNo | integer(int32) | 否 | | |
| shiftDate | string(date) | 否 | | |
| tankNumberList | TankNumberDTO[] | 否 | | |
| pumpNumberList | PumpNumberDTO[] | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/oil/pump/add
油泵管理接口
添加油泵
OperationId: add_9
调用方法
POST /api/oil/pump/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddOilPumpDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilPumpDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| code | string | 否 | | |
| name | string | 否 | | |
| tankId | integer(int64) | 否 | | |
| linkTanks | integer(int64)[] | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilPump com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilPump | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| oilProfitLossDTOList | AddOilProfitLossConfigDTO$OilProfitLossDTO[] | 是 | 损益配置 | |
| oilTypeGoodsDTOList | AddOilProfitLossConfigDTO$OilTypeGoodsDTO[] | 是 | 油品类型商品关联DTO | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| nozzleId | integer(int64) | 是 | 油枪ID | 1 |
| businessDate | string(date) | 是 | 营业日 | "2026-06-01" |
| readingTime | string | 否 | 读数时间 | "2026-06-01 10:09:11" |
| volumeTotal | number(double) | 否 | 总出油量 | 1 |
| moneyTotal | number(double) | 否 | 总出油金额 | 1 |
| source | string | 否 | 来源(MANUAL、POS、FUEL_SERVER) | "FUEL_SERVER" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/oil/nozzle/add
油枪管理接口
添加油枪
OperationId: add_11
调用方法
POST /api/oil/nozzle/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddOilNozzleDTO com.leadwaycloud.rm.store.business.oil.dto.AddOilNozzleDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 门店ID | 1 |
| code | string | 是 | 编号 | "1" |
| name | string | 否 | 名称 | "1" |
| pumpId | integer(int64) | 是 | 油泵ID | 1 |
| tankId | integer(int64) | 是 | 油罐ID | 1 |
| maxValue | number(double) | 否 | 最大走字 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzle com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 数据类型 【 TANK_READING : 油罐读数 NOZZLE_READING : 油枪读数 】 | |
| data | string | 是 | 数据 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 否 | | |
| host | string | 否 | | |
| serverPath | string | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilFuelServerConfig com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilFuelServerConfig | 否 | | |
POST
/api/cashier/add
收银员管理接口
新增收银员接口
OperationId: add_13
调用方法
POST /api/cashier/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddCashierDTO com.leadwaycloud.rm.store.business.cashier.dto.AddCashierDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| account | string | 是 | 账号 | "131131" |
| password | string | 是 | 密码 | "111111" |
| type | string | 是 | 类型 【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员 】 | "CASHIER" |
| employeeId | integer(int64) | 否 | 员工ID | 1 |
| image | string | 否 | 头像/形象图片 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
GET
/api/store-trade-reason/search/{id}
交易理由业务接口
交易理由ID搜索接口
OperationId: searchTradeReason
调用方法
GET /api/store-trade-reason/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 交易理由ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TradeReasonRespVO | 否 | | |
GET
/api/store-trade-reason/search-page
交易理由业务接口
交易理由分页搜索接口
OperationId: searchTradeReason_1
调用方法
GET /api/store-trade-reason/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| orderType | query | 否 | string | 类型 | "SALE" |
| reason | query | 否 | string | 交易理由 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TradeReasonListRespVO | 否 | | |
GET
/api/store-trade-reason/search-list
交易理由业务接口
交易理由列表搜索接口
OperationId: searchTradeReason_2
调用方法
GET /api/store-trade-reason/search-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | long | 商户ID | 1 |
| orderType | query | 否 | string | 类型 | "SALE" |
| reason | query | 否 | string | 交易理由 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TradeReasonListRespVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TradeReasonListRespVO[] | 否 | 返回数据 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/store-server/query/{id}
门店服务器参数管理接口
查询门店服务器(ID)接口
OperationId: query
调用方法
GET /api/store-server/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 门店服务器ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmStoreServer com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmStoreServer | 否 | | |
GET
/api/store-server/query/{companyId}/{type}/{code}
门店服务器参数管理接口
查询门店服务器配置(唯一索引)接口
OperationId: query_1
调用方法
GET /api/store-server/query/{companyId}/{type}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| type | path | 是 | string | 门店服务器类型 | "FUEL_SERVER" |
| code | path | 是 | string | 门店服务器编号 | "001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmStoreServer com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmStoreServer | 否 | | |
GET
/api/store-server/query-page
门店服务器参数管理接口
查询门店服务器配置(分页)接口
OperationId: query_2
调用方法
GET /api/store-server/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| type | query | 否 | string | 服务类型 | "FUEL_SERVER" |
| code | query | 否 | string | 服务编号 | "001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmStoreServer com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmStoreServer | 否 | | |
GET
/api/store-restaurant/query/{id}
门店餐厅管理接口
查询门店餐厅(ID)接口
OperationId: query_3
调用方法
GET /api/store-restaurant/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 餐厅ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurant com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurant | 否 | | |
GET
/api/store-restaurant/query/{companyId}/{code}
门店餐厅管理接口
查询门店餐厅(编号)接口
OperationId: query_4
调用方法
GET /api/store-restaurant/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| code | path | 是 | string | 餐厅编号 | "P001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurant com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurant | 否 | | |
GET
/api/store-restaurant/query-list/{companyId}
门店餐厅管理接口
查询门店餐厅(列表)接口
OperationId: queryList
调用方法
GET /api/store-restaurant/query-list/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurant com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurant[] | 否 | 返回数据 | |
GET
/api/store-restaurant-table/query/{id}
门店餐厅桌位管理接口
查询门店餐厅桌位(ID)接口
OperationId: query_5
调用方法
GET /api/store-restaurant-table/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTable com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTable | 否 | | |
GET
/api/store-restaurant-table/query/{companyId}/{restaurantId}/{code}
门店餐厅桌位管理接口
查询门店餐厅桌位(编号)接口
OperationId: query_6
调用方法
GET /api/store-restaurant-table/query/{companyId}/{restaurantId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| restaurantId | path | 是 | integer(int64) | 餐厅ID | 1 |
| code | path | 是 | string | 桌位编号 | "P001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTable com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTable | 否 | | |
GET
/api/store-restaurant-table/query-page/{companyId}/{restaurantId}
门店餐厅桌位管理接口
查询门店餐厅桌位(分页)接口
OperationId: queryPage
调用方法
GET /api/store-restaurant-table/query-page/{companyId}/{restaurantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| restaurantId | path | 是 | integer(int64) | 餐厅ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 桌位号 | "C001" |
| floor | query | 否 | int | 楼层 | 1 |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTable com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTable | 否 | | |
GET
/api/store-restaurant-table-layout/query/{id}
门店餐厅桌位布局管理接口
查询门店餐厅桌位布局(ID)接口
OperationId: query_7
调用方法
GET /api/store-restaurant-table-layout/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 桌位布局ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTableLayout com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTableLayout | 否 | | |
GET
/api/store-restaurant-table-layout/query/{companyId}
门店餐厅桌位布局管理接口
查询门店餐厅桌位布局(编号)接口
OperationId: query_8
调用方法
GET /api/store-restaurant-table-layout/query/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 编号 | "C001" |
| name | query | 否 | string | 名称 | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmRestaurantTableLayout com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTableLayout | 否 | | |
GET
/api/store-merchant-config/search/{id}
商户配置搜索接口
商户配置ID查询接口
OperationId: searchConfig
调用方法
GET /api/store-merchant-config/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商户配置ID | 0 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MerchantConfigResponseVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MerchantConfigResponseVO | 否 | | |
GET
/api/store-merchant-config/search-merchant/{merchantId}
商户配置搜索接口
商户配置商户ID查询接口
OperationId: searchConfigByMerchantid
调用方法
GET /api/store-merchant-config/search-merchant/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 0 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MerchantConfigResponseVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MerchantConfigResponseVO | 否 | | |
GET
/api/store-layout/v1/warehouses
仓库/库位
门店/仓库列表
OperationId: listStores
调用方法
GET /api/store-layout/v1/warehouses
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | WarehouseDto[] | 否 | 返回数据 | |
GET
/api/store-layout/v1/warehouses/{id}
仓库/库位
仓库详情
OperationId: getById_2
调用方法
GET /api/store-layout/v1/warehouses/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | WarehouseDto | 否 | | |
GET
/api/store-layout/v1/warehouses/{id}/locations
仓库/库位
库位列表
OperationId: listLocations
调用方法
GET /api/store-layout/v1/warehouses/{id}/locations
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: WarehouseDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | WarehouseDto[] | 否 | 返回数据 | |
GET
/api/store-layout/v1/templates
布局模板
模板列表
OperationId: list_2
调用方法
GET /api/store-layout/v1/templates
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateSummaryDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateSummaryDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutTemplateSummaryDto[] | 否 | 返回数据 | |
GET
/api/store-layout/v1/templates/{id}
布局模板
模板详情
OperationId: getById_3
调用方法
GET /api/store-layout/v1/templates/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LayoutTemplateDetailDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LayoutTemplateDetailDto | 否 | | |
DELETE
/api/store-layout/v1/templates/{id}
布局模板
归档模板
OperationId: archive_2
调用方法
DELETE /api/store-layout/v1/templates/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/store-layout/v1/layouts/{layoutId}/planogram/validate
排面 Planogram
合规校验
OperationId: validate
检查排面三要素、件数一致性、货架溢出、品类相邻禁配、黄金视线层等
调用方法
GET /api/store-layout/v1/layouts/{layoutId}/planogram/validate
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| layoutId | path | 是 | integer(int64) | 布局 ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PlanogramValidationResultDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PlanogramValidationResultDto | 否 | | |
GET
/api/store-layout/v1/goods
商品
搜索商品
OperationId: search
按商户 ID 模糊搜索货号或名称
调用方法
GET /api/store-layout/v1/goods
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | 商户 ID | 1 |
| keyword | query | 否 | string | 货号/名称关键字 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsDto com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsDto[] | 否 | 返回数据 | |
GET
/api/store-layout/v1/goods/{id}
商品
按 ID 查询商品
OperationId: getById_4
调用方法
GET /api/store-layout/v1/goods/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsDto | 否 | | |
GET
/api/store-layout/v1/goods/code/{code}
商品
按货号查询商品
OperationId: getByCode
调用方法
GET /api/store-layout/v1/goods/code/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | | |
| code | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsDto | 否 | | |
GET
/api/store-layout/v1/goods/barcode/{barcode}
商品
按条码查询
OperationId: getByBarcode
调用方法
GET /api/store-layout/v1/goods/barcode/{barcode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | | |
| barcode | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsBarcodeDto com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsBarcodeDto | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| code | string | 否 | 布局业务编码,公司内唯一 | "LAYOUT-001" |
| name | string | 是 | 布局名称 | "春熙路店默认布局" |
| versionNo | integer(int32) | 是 | 版本号;每次发布递增 | 1 |
| status | string | 是 | 布局生命周期状态 | |
| floorWidth | number | 否 | 卖场平面宽度(米) | 30 |
| floorDepth | number | 否 | 卖场平面深度(米) | 20 |
| sceneGraph | string | 否 | Pascal Editor 完整场景 JSON(节点字典),用于 3D 渲染与撤销/重做 | |
| merchantId | integer(int64) | 否 | 商户 ID(多租户隔离) | 1 |
| companyId | integer(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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| merchantId | integer(int64) | 是 | 商户 ID(资产库按商户共享,非单门店) | 1 |
| code | string | 是 | 预设编码,商户内唯一 | "FUEL-DISPENSER-01" |
| name | string | 是 | 预设显示名称 | "加油机标准型" |
| description | string | 否 | 预设说明 | |
| category | string | 是 | 资产预设业务分类 | |
| nodeType | string | 是 | Pascal 节点类型:store-shelf / store-zone / scan / spawn 等 | "store-shelf" |
| presetJson | string | 是 | 合并进节点 schema 的 JSON 默认字段(尺寸、材质、metadata 等) | |
| thumbnailUrl | string | 否 | 缩略图 URL | |
| modelUrl | string | 否 | GLB/GLTF 模型访问 URL;visualMode=MODEL 时指向下载 API | |
| modelData | string(byte) | 否 | GLB/glTF 模型二进制(visualMode=MODEL 时存库) | |
| modelContentType | string | 否 | 模型 MIME 类型,如 model/gltf-binary | |
| modelFileName | string | 否 | 上传时的原始文件名(Content-Disposition,非磁盘路径) | |
| visualMode | string | 是 | 渲染模式:PARAMETRIC 程序几何 / MODEL 外部 GLB 模型 | "PARAMETRIC" |
| sortOrder | integer(int32) | 是 | 列表排序序号 | 0 |
| status | string | 是 | 资产预设状态 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| code | string | 是 | 编号(仅允许字母和数字) | "W01" |
| name | string | 是 | 名称 | "默认仓库" |
| idChain | string | 是 | 仓库ID完整架构(上下级仓库id用-连接) | "123-456" |
| system | string | 否 | 是否是系统默认分组(系统默认角色(不可修改/删除)) | "false" |
| parentId | string | 是 | 上一级仓库 | "1" |
| images | string | 否 | 图片 | |
| type | string | 是 | 类型 【 WAREHOUSE : 仓库 LOCATION : 库位 LOCATION_OIL : 油库 】 | "WAREHOUSE" |
| status | string | 是 | 状态 | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | "抽纸" |
| code | string | 是 | 货号 | "KDED24123123" |
| virtual | boolean | 是 | 是否是虚拟产品 | true |
| images | string | 否 | 图片 | "..." |
| origin | string | 否 | 来源 | "..." |
| description | string | 否 | 描述 | "..." |
| otherName | string | 否 | 别名 | "..." |
| mark | string | 否 | 标记 | "ENERGY" |
| place | string | 否 | 产地 | |
| grade | string | 否 | 等级 | |
| externalCode | string | 否 | 外部编号 | |
| weight | boolean | 是 | 非标售卖商品 | true |
| fuel | boolean | 是 | 油品 | true |
| make | boolean | 是 | 自制品 | true |
| barcodeSettlement | boolean | 是 | 商品结算方式 false(商品结算,默认) true(条码结算) | |
| carwash | boolean | 是 | 洗车商品 | true |
| goodsCategoryId | integer(int64) | 是 | 分类ID | |
| goodsBrandId | integer(int64) | 否 | 品牌ID | |
| spec | string | 否 | 规格 | |
| uomId | string | 是 | 计量单位ID | |
| saleUomId | string | 否 | 销售单位ID | |
| goodsCategory | StockGoodsCategory | 是 | | |
| uom | SysUom | 是 | | |
| saleUom | SysUom | 否 | | |
| goodsBrand | StockGoodsBrand | 否 | | |
| goodsEnergy | StockGoodsEnergy | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| goodsId | integer(int64) | 是 | 商品ID | |
| barcode | string | 是 | 条码 | "6914068029184" |
| type | string | 是 | 条码类型 | "EN13" |
| otherBarcode | string | 否 | 其他条码 | "6914068029184" |
| defSettlement | boolean | 是 | 是否是结算默认条码 | |
| images | string | 否 | 图片 | |
| spec | string | 否 | 规格 | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| layoutId | integer(int64) | 是 | 所属布局 ID | 1 |
| warehouseId | integer(int64) | 否 | 绑定的 ERP 仓库/门店 ID(stock_warehouse.id,type=WAREHOUSE) | 1101 |
| code | string | 否 | 区域编码 | "ZONE-A" |
| name | string | 是 | 区域名称 | "饮料区" |
| zoneType | string | 是 | 布局销售区域类型 | |
| shapeType | string | 是 | 区域形状类型 | |
| polygonJson | string | 否 | 多边形顶点 JSON,格式 [[x,z],...](米,XZ 平面) | |
| positionX | number | 是 | 矩形/多边形锚点 X 坐标(米) | 0 |
| positionZ | number | 是 | 矩形/多边形锚点 Z 坐标(米) | 0 |
| width | number | 否 | 矩形宽度(米) | 10 |
| depth | number | 否 | 矩形深度(米) | 8 |
| rotation | number | 是 | 绕 Y 轴旋转角(弧度) | 0 |
| color | string | 否 | 2D/3D 显示颜色 HEX | "#4A90D9" |
| sortOrder | integer(int32) | 否 | 列表排序序号,越小越靠前 | 0 |
| sceneNodeId | string | 否 | Pascal 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| companyId | integer(int64) | 是 | 公司 ID | 1 |
| code | string | 是 | 模板编码 | "TPL-GS-001" |
| name | string | 是 | 模板名称 | "加油站标准模板" |
| description | string | 否 | 模板说明 | |
| category | string | 否 | 布局模板业态分类 | |
| status | string | 否 | 布局模板状态 | |
| sourceLayoutId | integer(int64) | 否 | 来源布局 ID(从哪份布局保存而来) | 2 |
| thumbnailUrl | string | 否 | 缩略图 URL | |
| sceneGraph | string | 否 | Pascal Editor 场景 JSON 快照 | |
| floorWidth | number | 否 | 模板默认卖场宽度(米) | 30 |
| floorDepth | number | 否 | 模板默认卖场深度(米) | 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| layoutId | integer(int64) | 是 | 所属布局 ID | 1 |
| zoneId | integer(int64) | 否 | 所属销售区域 ID | 101 |
| aisleId | integer(int64) | 否 | 所属通道 ID | 201 |
| warehouseLocationId | integer(int64) | 否 | 绑定的 ERP 库位 ID(整架或主库位) | 2001 |
| code | string | 否 | 货架编码,发布时可生成 ERP 库位 | "S001" |
| name | string | 否 | 货架名称 | "饮料货架 A" |
| shelfType | string | 是 | 货架类型 | |
| positionX | number | 是 | 世界坐标 X(米) | 5 |
| positionY | number | 是 | 世界坐标 Y(米,离地高度) | 0 |
| positionZ | number | 是 | 世界坐标 Z(米) | 3 |
| rotationY | number | 是 | 绕 Y 轴旋转(弧度) | 0 |
| width | number | 是 | 货架宽度(米) | 1.2 |
| height | number | 是 | 货架总高度(米) | 2 |
| depth | number | 是 | 货架深度(米) | 0.4 |
| layerCount | integer(int32) | 是 | 层数(与 layout_shelf_layer 记录数一致) | 4 |
| sceneNodeId | string | 否 | Pascal 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| shelfId | integer(int64) | 是 | 所属货架 ID | 501 |
| layerNo | integer(int32) | 是 | 层号,从 1 起自下而上 | 2 |
| height | number | 否 | 层板距地面高度(米) | 1.2 |
| maxWeight | number | 否 | 层板最大承重(千克) | 50 |
| maxItems | integer(int32) | 否 | 本层最大 SKU 数 | 12 |
| sceneNodeId | string | 否 | Pascal Editor 场景节点 ID | "shelf-layer_abc123" |
| pickPriority | integer(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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| shelfLayerId | integer(int64) | 是 | 所属货架层 ID | 5001 |
| goodsId | integer(int64) | 否 | ERP 商品 ID(stock_goods.id) | 3001 |
| barcodeId | integer(int64) | 否 | ERP 结算条码 ID(stock_goods_barcode.id) | 4001 |
| goodsCode | string | 否 | 冗余货号(stock_goods.code),便于列表展示 | "GD-001" |
| slotIndex | integer(int32) | 否 | 层内从左到右序号,从 0 开始 | 0 |
| facings | integer(int32) | 否 | 横向排面列数(顾客可见正面数) | 4 |
| depthFacings | integer(int32) | 否 | 纵深陈列深度(向货架内延伸的列数) | 2 |
| stackLayers | integer(int32) | 否 | 垂直堆叠层数 | 1 |
| facing | string | 否 | 商品朝向 | "FRONT" |
| quantity | integer(int32) | 否 | 陈列总件数,通常 = facings × depthFacings × stackLayers | 8 |
| displayType | string | 否 | 陈列类型 | "STANDARD" |
| positionOffset | number | 否 | 层内水平偏移(米) | 0 |
| sceneNodeId | string | 否 | Pascal Editor 场景节点 ID | "goods-slot_abc123" |
| packWidthMm | integer(int32) | 否 | 单品包装宽度(毫米),用于 3D 占宽与溢出校验 | 65 |
| packHeightMm | integer(int32) | 否 | 单品包装高度(毫米) | 200 |
| packDepthMm | integer(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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| createBy | integer(int64) | 否 | | |
| createTime | string(date-time) | 否 | | |
| updateBy | integer(int64) | 否 | | |
| updateTime | string(date-time) | 否 | | |
| layoutId | integer(int64) | 是 | 所属布局 ID | 1 |
| zoneId | integer(int64) | 否 | 所属销售区域 ID(layout_zone.id) | 101 |
| code | string | 否 | 通道编码 | "AISLE-01" |
| name | string | 否 | 通道名称 | "主通道" |
| startX | number | 是 | 起点 X 坐标(米) | 0 |
| startZ | number | 是 | 起点 Z 坐标(米) | 0 |
| endX | number | 是 | 终点 X 坐标(米) | 10 |
| endZ | number | 是 | 终点 Z 坐标(米) | 0 |
| width | number | 是 | 通道有效宽度(米) | 1.2 |
| direction | string | 是 | 方向:HORIZONTAL 水平 / VERTICAL 垂直 / CUSTOM 自定义 | "CUSTOM" |
| sceneNodeId | string | 否 | Pascal 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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | | |
| companyId | integer(int64) | 是 | 公司 ID | 1 |
| userId | integer(int64) | 否 | 操作用户 ID | 100 |
| action | string | 是 | 动作编码,如 PUBLISH_LAYOUT / APPLY_TEMPLATE / PLANogram_AUDIT | "PUBLISH_LAYOUT" |
| resourceType | string | 是 | 资源类型:LAYOUT / TEMPLATE / ASSET_PRESET 等 | "LAYOUT" |
| resourceId | integer(int64) | 是 | 资源主键 ID | 1 |
| detail | string | 否 | 操作详情 JSON 或文本 | |
| createTime | string(date-time) | 是 | 创建时间 | |
GET
/api/printer/query/{id}
打印机管理接口
查询打印机(ID)接口
OperationId: query_9
调用方法
GET /api/printer/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
GET
/api/printer/query/{companyId}/{code}
打印机管理接口
查询打印机(编号)接口
OperationId: query_10
调用方法
GET /api/printer/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| code | path | 是 | string | 打印机编号 | "D001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
GET
/api/printer/query/use-printer-pos/{id}
打印机管理接口
查询使用打印机的机台接口
OperationId: queryUsePrinterPos
调用方法
GET /api/printer/query/use-printer-pos/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos[] | 否 | 返回数据 | |
GET
/api/printer/query-page
打印机管理接口
查询打印机(分页)接口
OperationId: query_11
调用方法
GET /api/printer/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| code | query | 否 | string | 编号 | "P001" |
| type | query | 否 | string | 类型 | "THERMAL_TICKET" |
| status | query | 否 | string | 状态 | "IDLE" |
| connectionType | query | 否 | string | 连接类型 | "SERIAL" |
| deviceCommandId | query | 否 | long | 设备指令集ID | 1 |
| printTemplateId | query | 否 | long | 打印模版ID | 1 |
| printTemplateName | query | 否 | string | 打印模版名称 | "交易小票" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrinter com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrinter | 否 | | |
GET
/api/printer-template/query/{id}
打印机模版管理接口
查询打印机模版(ID)接口
OperationId: query_12
调用方法
GET /api/printer-template/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机模版ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrintTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrintTemplate | 否 | | |
GET
/api/printer-template/query-page
打印机模版管理接口
查询打印机模版(分页)接口
OperationId: query_13
调用方法
GET /api/printer-template/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| typeList | query | 否 | string | 模版类型 | ["TRAN_TICKET"] |
| name | query | 否 | string | 打印模版名称 | "交易小票" |
| companyIdList | query | 否 | long | 门店id集合 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePrintTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePrintTemplate | 否 | | |
GET
/api/pos/query/{id}
机台管理接口
查询机台(ID)接口
OperationId: query_14
调用方法
GET /api/pos/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
GET
/api/pos/query/{companyId}/{code}
机台管理接口
查询机台(编号)接口
OperationId: query_15
调用方法
GET /api/pos/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| code | path | 是 | string | 机台编号 | "POS001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
GET
/api/pos/query/goods-update-notify-pos-record/{id}
机台管理接口
查询机台商品更新通知机台记录接口
OperationId: queryGoodsUpdateNotifyPosRecord_1
调用方法
GET /api/pos/query/goods-update-notify-pos-record/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsUpdateNotifyPos com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsUpdateNotifyPos | 否 | | |
GET
/api/pos/query/business-info/{id}
机台管理接口
查询机台(ID)接口
OperationId: queryPosBusinessInfo
调用方法
GET /api/pos/query/business-info/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PosBusinessInfoResponse com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PosBusinessInfoResponse | 否 | | |
GET
/api/pos/query-page
机台管理接口
查询机台(分页)接口
OperationId: query_16
调用方法
GET /api/pos/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| code | query | 否 | string | 编号 | "POS001" |
| status | query | 否 | string | 状态 | "INACTIVATED" |
| mode | query | 否 | string | 应用模式 | "POS" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePos com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePos | 否 | | |
GET
/api/pos/pos-group/{id}
机台管理接口
查询机台分组(ID)接口
OperationId: groupQuery
调用方法
GET /api/pos/pos-group/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台分组ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePosGroup com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePosGroup | 否 | | |
GET
/api/pos/pos-group/{companyId}/{code}
机台管理接口
查询机台分组(编号)接口
OperationId: groupQuery_1
调用方法
GET /api/pos/pos-group/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| code | path | 是 | string | 机台编号 | "POS001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePosGroup com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePosGroup[] | 否 | 返回数据 | |
GET
/api/pos/pos-group/query-page
机台管理接口
查询机台组(分页)接口
OperationId: groupQuery_2
调用方法
GET /api/pos/pos-group/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| code | query | 否 | string | 编号 | "GROUP-001" |
| name | query | 否 | string | 名称 | "Group 001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmDevicePosGroup com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmDevicePosGroup | 否 | | |
GET
/api/oil/tank/reading/page
油罐管理接口
查询油罐读数
OperationId: readingPage
调用方法
GET /api/oil/tank/reading/page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| tankId | query | 是 | long | 油罐ID | 1 |
| companyId | query | 否 | long | 公司ID | 1 |
| source | query | 否 | string | 来源(MANUAL:手动、POS、FUEL_MACHINE:油机) | "FUEL_MACHINE" |
| businessDate | query | 否 | LocalDate | 营业日 | "2026-06-01" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankReading com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankReading | 否 | | |
GET
/api/oil/tank/query/{id}
油罐管理接口
查询油罐(ID)
OperationId: query_17
调用方法
GET /api/oil/tank/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTank com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTank | 否 | | |
GET
/api/oil/tank/query/{companyId}/{code}
油罐管理接口
查询油罐(编号)
OperationId: queryByCode
调用方法
GET /api/oil/tank/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
| code | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTank com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTank | 否 | | |
GET
/api/oil/tank/query/standard-info/{id}
油罐管理接口
查询油罐规格信息(按规格ID)
OperationId: queryTankStandardInfo
调用方法
GET /api/oil/tank/query/standard-info/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
GET
/api/oil/tank/query/standard-info/tank/{tankId}
油罐管理接口
查询油罐规格信息(按油罐ID,一罐一条)
OperationId: queryTankStandardInfoByTank
调用方法
GET /api/oil/tank/query/standard-info/tank/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
GET
/api/oil/tank/query/list/{companyId}
油罐管理接口
查询油罐列表(含规格属性)
OperationId: queryList_1
调用方法
GET /api/oil/tank/query/list/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: OilTankListVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.oil.vo.OilTankListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | OilTankListVO[] | 否 | 返回数据 | |
GET
/api/oil/tank/query/goods/{tankId}
油罐管理接口
查询油罐绑定油品(一罐一条)
OperationId: queryTankGoods
调用方法
GET /api/oil/tank/query/goods/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TankGoodsVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TankGoodsVO | 否 | | |
GET
/api/oil/tank/query/goods/list/{companyId}
油罐管理接口
查询门店所有油罐绑定油品
OperationId: queryTankGoodsList
调用方法
GET /api/oil/tank/query/goods/list/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TankGoodsVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TankGoodsVO[] | 否 | 返回数据 | |
GET
/api/oil/tank/query-page/standard-info/{tankId}
油罐管理接口
查询油罐规格信息(按油罐ID,兼容旧路径)
OperationId: pageQueryTankStandardInfo
调用方法
GET /api/oil/tank/query-page/standard-info/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilTankSpecification com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilTankSpecification | 否 | | |
GET
/api/oil/pump/query/{id}
油泵管理接口
查询油泵(ID)
OperationId: query_18
调用方法
GET /api/oil/pump/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilPump com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilPump | 否 | | |
GET
/api/oil/pump/query/{companyId}/{code}
油泵管理接口
查询油泵(编号)
OperationId: queryByCode_1
调用方法
GET /api/oil/pump/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
| code | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilPump com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilPump | 否 | | |
GET
/api/oil/pump/query/list/{companyId}
油泵管理接口
查询油泵列表
OperationId: queryList_2
调用方法
GET /api/oil/pump/query/list/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilPump com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilPump[] | 否 | 返回数据 | |
GET
/api/oil/profit-loss/config/query
油品损益配置
查询配置
OperationId: query_19
调用方法
GET /api/oil/profit-loss/config/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: OilProfitLossConfigVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.OilProfitLossConfigVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | OilProfitLossConfigVO | 否 | | |
GET
/api/oil/nozzle/reading/page
油枪管理接口
查询油枪读数
OperationId: readingPage_1
调用方法
GET /api/oil/nozzle/reading/page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| nozzleId | query | 是 | long | 油枪ID | 1 |
| companyId | query | 否 | long | 公司ID | 1 |
| source | query | 否 | string | 来源(MANUAL:手动、POS、FUEL_MACHINE:油机) | "FUEL_MACHINE" |
| businessDate | query | 否 | LocalDate | 营业日 | "2026-06-01" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzleReading com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzleReading | 否 | | |
GET
/api/oil/nozzle/query/{id}
油枪管理接口
查询油枪(ID)
OperationId: query_20
调用方法
GET /api/oil/nozzle/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzle com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle | 否 | | |
GET
/api/oil/nozzle/query/{companyId}/{code}
油枪管理接口
查询油枪(编号)
OperationId: queryByCode_2
调用方法
GET /api/oil/nozzle/query/{companyId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
| code | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzle com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle | 否 | | |
GET
/api/oil/nozzle/query/list/{companyId}
油枪管理接口
查询油枪列表
OperationId: queryList_3
调用方法
GET /api/oil/nozzle/query/list/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilNozzle com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilNozzle[] | 否 | 返回数据 | |
GET
/api/oil/fuel-server/query/{id}
Fuel服务管理接口
查询Fuel服务配置(ID)
OperationId: query_21
调用方法
GET /api/oil/fuel-server/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: EnergyOilFuelServerConfig com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EnergyOilFuelServerConfig | 否 | | |
GET
/api/monitor/version
服务监控管理
获取服务版本信息
OperationId: version
调用方法
GET /api/monitor/version
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/monitor/health
服务监控管理
心跳检查
OperationId: health
调用方法
GET /api/monitor/health
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/cashier/query/{id}
收银员管理接口
查询收银员(ID)接口
OperationId: query_22
调用方法
GET /api/cashier/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmCashier com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
GET
/api/cashier/query/{companyId}/{account}
收银员管理接口
查询收银员(账号)接口
OperationId: query_23
调用方法
GET /api/cashier/query/{companyId}/{account}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| account | path | 是 | string | 收银员账号 | "C001" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmCashier com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
GET
/api/cashier/query-page
收银员管理接口
查询收银员(分页)接口
OperationId: query_24
调用方法
GET /api/cashier/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| type | query | 否 | string | 类型 | "CASHIER" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmCashier com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmCashier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmCashier | 否 | | |
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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| tradeReasonList | integer(int64)[] | 否 | 需要删除的交易理由,不传则删除商户下所有 | [] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/store-server/remove/{id}
门店服务器参数管理接口
删除门店服务器接口
OperationId: remove_1
物理删除
调用方法
DELETE /api/store-server/remove/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 门店服务器ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/printer-template/remove/{id}
打印机模版管理接口
删除打印模版接口
OperationId: remove_2
物理删除
调用方法
DELETE /api/printer-template/remove/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 打印机ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/pos/delete/{id}
机台管理接口
删除机台接口
OperationId: delete
调用方法
DELETE /api/pos/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 机台ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/oil/tank/remove/standard-info/{tankId}
油罐管理接口
清除油罐规格信息(按油罐ID)
OperationId: clearTankStandardInfo
调用方法
DELETE /api/oil/tank/remove/standard-info/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/oil/tank/remove/standard-info/tank/{tankId}
油罐管理接口
清除油罐规格信息(按油罐ID)
OperationId: clearTankStandardInfo_1
调用方法
DELETE /api/oil/tank/remove/standard-info/tank/{tankId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| tankId | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/oil/tank/delete/standard-info/{id}
油罐管理接口
删除油罐规格信息(按规格ID)
OperationId: deleteTankStandardInfo
调用方法
DELETE /api/oil/tank/delete/standard-info/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
GET
/error
main-site-error-handler
-
OperationId: handleError
调用方法
GET /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/error
main-site-error-handler
-
OperationId: handleError_1
调用方法
POST /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/error
main-site-error-handler
-
OperationId: handleError_2
调用方法
PUT /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
DELETE
/error
main-site-error-handler
-
OperationId: handleError_3
调用方法
DELETE /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PATCH
/error
main-site-error-handler
-
OperationId: handleError_4
调用方法
PATCH /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
OPTIONS
/error
main-site-error-handler
-
OperationId: handleError_6
调用方法
OPTIONS /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
HEAD
/error
main-site-error-handler
-
OperationId: handleError_5
调用方法
HEAD /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
模型定义
PageableObject
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| paged | boolean | 否 | | |
| pageNumber | integer(int32) | 否 | | |
| offset | integer(int64) | 否 | | |
| sort | SortObject | 否 | | |
| pageSize | integer(int32) | 否 | | |
| unpaged | boolean | 否 | | |
SortObject
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| sorted | boolean | 否 | | |
| empty | boolean | 否 | | |
| unsorted | boolean | 否 | | |
com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmRestaurantTableLayout | 否 | | |
org.springframework.data.domain.PageCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| totalPages | integer(int32) | 否 | | |
| totalElements | integer(int64) | 否 | | |
| pageable | PageableObject | 否 | | |
| first | boolean | 否 | | |
| last | boolean | 否 | | |
| size | integer(int32) | 否 | | |
| content | RmRestaurantTableLayout[] | 否 | | |
| number | integer(int32) | 否 | | |
| sort | SortObject | 否 | | |
| numberOfElements | integer(int32) | 否 | | |
| empty | boolean | 否 | | |