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

- 文档标题：product-rm-store
- 版本：2.0.2
- 描述：LWC Cloud API接口文档
- 数据来源：https://api.leadwaycloud.com/lwc-cloud-erp-rm-store/v3/api-docs
- 生成时间：2026-08-03T22:00:18.115Z
- 接口数量：173
- 分组数量：26
- 模型数量：209

## 服务地址

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

## 接口目录

### 交易理由业务接口

- [PUT /api/store-trade-reason/update - 交易理由修改接口](#put-api-store-trade-reason-update-update)
- [POST /api/store-trade-reason/add - 新增交易理由接口](#post-api-store-trade-reason-add-add)
- [GET /api/store-trade-reason/search/{id} - 交易理由ID搜索接口](#get-api-store-trade-reason-search-id-searchtradereason)
- [GET /api/store-trade-reason/search-page - 交易理由分页搜索接口](#get-api-store-trade-reason-search-page-searchtradereason-1)
- [GET /api/store-trade-reason/search-list - 交易理由列表搜索接口](#get-api-store-trade-reason-search-list-searchtradereason-2)
- [DELETE /api/store-trade-reason/delete - 交易理由删除接口](#delete-api-store-trade-reason-delete-remove)

### 门店服务器参数管理接口

- [PUT /api/store-server/update/{id} - 修改门店服务器接口](#put-api-store-server-update-id-update-1)
- [POST /api/store-server/add - 新增门店服务器配置](#post-api-store-server-add-add-1)
- [GET /api/store-server/types - 门店服务器类型](#get-api-store-server-types-types)
- [GET /api/store-server/query/{id} - 查询门店服务器(ID)接口](#get-api-store-server-query-id-query)
- [GET /api/store-server/query/{companyId}/{type}/{code} - 查询门店服务器配置(唯一索引)接口](#get-api-store-server-query-companyid-type-code-query-1)
- [GET /api/store-server/query-page - 查询门店服务器配置(分页)接口](#get-api-store-server-query-page-query-2)
- [DELETE /api/store-server/remove/{id} - 删除门店服务器接口](#delete-api-store-server-remove-id-remove-1)

### 门店餐厅管理接口

- [PUT /api/store-restaurant/update/{id} - 修改门店餐厅接口](#put-api-store-restaurant-update-id-update-2)
- [POST /api/store-restaurant/add - 添加门店餐厅接口](#post-api-store-restaurant-add-add-2)
- [GET /api/store-restaurant/query/{id} - 查询门店餐厅(ID)接口](#get-api-store-restaurant-query-id-query-3)
- [GET /api/store-restaurant/query/{companyId}/{code} - 查询门店餐厅(编号)接口](#get-api-store-restaurant-query-companyid-code-query-4)
- [GET /api/store-restaurant/query-list/{companyId} - 查询门店餐厅(列表)接口](#get-api-store-restaurant-query-list-companyid-querylist)

### 门店餐厅桌位管理接口

- [PUT /api/store-restaurant-table/update/{id} - 修改门店餐厅桌位接口](#put-api-store-restaurant-table-update-id-update-3)
- [PUT /api/store-restaurant-table/recovery/{id} - 回收门店餐厅桌位接口](#put-api-store-restaurant-table-recovery-id-recovery)
- [PUT /api/store-restaurant-table/enable/{id} - 启用门店餐厅桌位接口](#put-api-store-restaurant-table-enable-id-enable)
- [PUT /api/store-restaurant-table/batch-recovery - 批量回收门店餐厅桌位接口](#put-api-store-restaurant-table-batch-recovery-batchrecovery)
- [PUT /api/store-restaurant-table/batch-enable - 批量启用门店餐厅桌位接口](#put-api-store-restaurant-table-batch-enable-batchenable)
- [POST /api/store-restaurant-table/add - 添加门店餐厅桌位接口](#post-api-store-restaurant-table-add-add-3)
- [GET /api/store-restaurant-table/query/{id} - 查询门店餐厅桌位(ID)接口](#get-api-store-restaurant-table-query-id-query-5)
- [GET /api/store-restaurant-table/query/{companyId}/{restaurantId}/{code} - 查询门店餐厅桌位(编号)接口](#get-api-store-restaurant-table-query-companyid-restaurantid-code-query-6)
- [GET /api/store-restaurant-table/query-page/{companyId}/{restaurantId} - 查询门店餐厅桌位(分页)接口](#get-api-store-restaurant-table-query-page-companyid-restaurantid-querypage)

### 门店餐厅桌位布局管理接口

- [PUT /api/store-restaurant-table-layout/update/{id} - 修改门店餐厅桌位布局](#put-api-store-restaurant-table-layout-update-id-update-4)
- [POST /api/store-restaurant-table-layout/add - 添加门店餐厅桌位布局](#post-api-store-restaurant-table-layout-add-add-4)
- [GET /api/store-restaurant-table-layout/query/{id} - 查询门店餐厅桌位布局(ID)接口](#get-api-store-restaurant-table-layout-query-id-query-7)
- [GET /api/store-restaurant-table-layout/query/{companyId} - 查询门店餐厅桌位布局(编号)接口](#get-api-store-restaurant-table-layout-query-companyid-query-8)

### 布局模板

- [PUT /api/store-layout/v1/templates/{id}/scene-graph - 更新模板 scene_graph](#put-api-store-layout-v1-templates-id-scene-graph-updatescenegraph)
- [POST /api/store-layout/v1/templates/{id}/apply - 应用模板到门店](#post-api-store-layout-v1-templates-id-apply-apply)
- [POST /api/store-layout/v1/templates/from-layout/{layoutId} - 从布局保存为模板](#post-api-store-layout-v1-templates-from-layout-layoutid-createfromlayout)
- [GET /api/store-layout/v1/templates - 模板列表](#get-api-store-layout-v1-templates-list-2)
- [GET /api/store-layout/v1/templates/{id} - 模板详情](#get-api-store-layout-v1-templates-id-getbyid-3)
- [DELETE /api/store-layout/v1/templates/{id} - 归档模板](#delete-api-store-layout-v1-templates-id-archive-2)

### 布局

- [GET /api/store-layout/v1/layouts/{id} - 布局详情](#get-api-store-layout-v1-layouts-id-getbyid)
- [PUT /api/store-layout/v1/layouts/{id} - 更新布局](#put-api-store-layout-v1-layouts-id-update-5)
- [GET /api/store-layout/v1/layouts - 布局列表](#get-api-store-layout-v1-layouts-list)
- [POST /api/store-layout/v1/layouts - 创建布局](#post-api-store-layout-v1-layouts-create)
- [POST /api/store-layout/v1/layouts/{id}/publish - 发布布局](#post-api-store-layout-v1-layouts-id-publish-publish)
- [POST /api/store-layout/v1/layouts/{id}/archive - 归档布局](#post-api-store-layout-v1-layouts-id-archive-archive-1)

### 资产预设

- [GET /api/store-layout/v1/asset-presets/{id} - 资产预设详情](#get-api-store-layout-v1-asset-presets-id-getbyid-1)
- [PUT /api/store-layout/v1/asset-presets/{id} - 更新资产预设](#put-api-store-layout-v1-asset-presets-id-update-6)
- [DELETE /api/store-layout/v1/asset-presets/{id} - 归档资产预设](#delete-api-store-layout-v1-asset-presets-id-archive)
- [GET /api/store-layout/v1/asset-presets - 资产预设列表](#get-api-store-layout-v1-asset-presets-list-1)
- [POST /api/store-layout/v1/asset-presets - 创建资产预设](#post-api-store-layout-v1-asset-presets-create-1)
- [GET /api/store-layout/v1/asset-presets/{id}/model-file - 下载资产 3D 模型](#get-api-store-layout-v1-asset-presets-id-model-file-downloadmodelfile)
- [POST /api/store-layout/v1/asset-presets/{id}/model-file - 上传资产 3D 模型](#post-api-store-layout-v1-asset-presets-id-model-file-uploadmodelfile)

### 打印机管理接口

- [PUT /api/printer/update/{id} - 修改打印机接口](#put-api-printer-update-id-update-7)
- [PUT /api/printer/update-status/{id} ](#put-api-printer-update-status-id-updateprinterstatus)
- [POST /api/printer/untie/all-pos/{printerId} - 解绑所有机台接口](#post-api-printer-untie-all-pos-printerid-untieallpos)
- [POST /api/printer/add - 新增打印机接口](#post-api-printer-add-add-5)
- [GET /api/printer/query/{id} - 查询打印机(ID)接口](#get-api-printer-query-id-query-9)
- [GET /api/printer/query/{companyId}/{code} - 查询打印机(编号)接口](#get-api-printer-query-companyid-code-query-10)
- [GET /api/printer/query/use-printer-pos/{id} - 查询使用打印机的机台接口](#get-api-printer-query-use-printer-pos-id-queryuseprinterpos)
- [GET /api/printer/query-page - 查询打印机(分页)接口](#get-api-printer-query-page-query-11)

### 打印机模版管理接口

- [PUT /api/printer-template/update/{id} - 修改打印机模版接口](#put-api-printer-template-update-id-update-8)
- [POST /api/printer-template/add - 新增打印机模版接口](#post-api-printer-template-add-add-6)
- [GET /api/printer-template/query/{id} - 查询打印机模版(ID)接口](#get-api-printer-template-query-id-query-12)
- [GET /api/printer-template/query-page - 查询打印机模版(分页)接口](#get-api-printer-template-query-page-query-13)
- [DELETE /api/printer-template/remove/{id} - 删除打印模版接口](#delete-api-printer-template-remove-id-remove-2)

### 机台管理接口

- [PUT /api/pos/update/{id} - 修改机台接口](#put-api-pos-update-id-update-9)
- [PUT /api/pos/reset/{id} - 重置机台接口](#put-api-pos-reset-id-register)
- [PUT /api/pos/register - 注册机台接口](#put-api-pos-register-register-1)
- [PUT /api/pos/pos-group/update/{id} - 修改机台分组接口](#put-api-pos-pos-group-update-id-updateposgroup)
- [PUT /api/pos/generate-registration-code/{id} - 生成机台注册码接口](#put-api-pos-generate-registration-code-id-generateregistrationcode)
- [POST /api/pos/update-goods-callback/{id} - 机台更新商品回调接口](#post-api-pos-update-goods-callback-id-callbackposupdategoods)
- [POST /api/pos/remove/pos-printer/{posId}/{printerId} - 机台解绑打印机接口](#post-api-pos-remove-pos-printer-posid-printerid-posuntieprinter)
- [POST /api/pos/pos-group/add - 新增机台分组接口](#post-api-pos-pos-group-add-addposgroup)
- [POST /api/pos/manual-notify/goods-update-goods/{goodsUpdateNotifyPosId} - 查询机台商品更新通知机台记录接口](#post-api-pos-manual-notify-goods-update-goods-goodsupdatenotifyposid-querygoodsu)
- [POST /api/pos/get/api-connection-token/{id} - 获取POS接口通讯Token接口](#post-api-pos-get-api-connection-token-id-getapiconnectiontoken)
- [POST /api/pos/add - 新增机台接口](#post-api-pos-add-add-7)
- [POST /api/pos/add/pos-printer/{id} ](#post-api-pos-add-pos-printer-id-addposprinter)
- [GET /api/pos/query/{id} - 查询机台(ID)接口](#get-api-pos-query-id-query-14)
- [GET /api/pos/query/{companyId}/{code} - 查询机台(编号)接口](#get-api-pos-query-companyid-code-query-15)
- [GET /api/pos/query/goods-update-notify-pos-record/{id} - 查询机台商品更新通知机台记录接口](#get-api-pos-query-goods-update-notify-pos-record-id-querygoodsupdatenotifyposrec)
- [GET /api/pos/query/business-info/{id} - 查询机台(ID)接口](#get-api-pos-query-business-info-id-queryposbusinessinfo)
- [GET /api/pos/query-page - 查询机台(分页)接口](#get-api-pos-query-page-query-16)
- [GET /api/pos/pos-group/{id} - 查询机台分组(ID)接口](#get-api-pos-pos-group-id-groupquery)
- [GET /api/pos/pos-group/{companyId}/{code} - 查询机台分组(编号)接口](#get-api-pos-pos-group-companyid-code-groupquery-1)
- [GET /api/pos/pos-group/query-page - 查询机台组(分页)接口](#get-api-pos-pos-group-query-page-groupquery-2)
- [DELETE /api/pos/delete/{id} - 删除机台接口](#delete-api-pos-delete-id-delete)

### 油罐管理接口

- [PUT /api/oil/tank/update/{id} - 修改油罐](#put-api-oil-tank-update-id-update-10)
- [PUT /api/oil/tank/update/standard-info/{id} - 修改油罐规格信息（按规格ID）](#put-api-oil-tank-update-standard-info-id-updatetankstandardinfo)
- [PUT /api/oil/tank/update/standard-info/tank/{tankId} - 修改油罐规格信息（按油罐ID，一罐一条）](#put-api-oil-tank-update-standard-info-tank-tankid-updatetankstandardinfobytank)
- [PUT /api/oil/tank/update/goods - 更新油罐绑定油品](#put-api-oil-tank-update-goods-updatetankgoods)
- [POST /api/oil/tank/reading/add - 添加油罐读数](#post-api-oil-tank-reading-add-addreading)
- [POST /api/oil/tank/import/standard-info/tank/{tankId} - 导入油罐规格信息（一罐一条，覆盖已有）](#post-api-oil-tank-import-standard-info-tank-tankid-importtankstandardinfo)
- [POST /api/oil/tank/import/standard-info/{tankId} - 导入油罐规格信息（一罐一条，覆盖已有）](#post-api-oil-tank-import-standard-info-tankid-importtankstandardinfo-1)
- [POST /api/oil/tank/export/import-standard-info-template - 下载油罐规格信息导入模版](#post-api-oil-tank-export-import-standard-info-template-exportimporttankstandardi)
- [POST /api/oil/tank/add - 添加油罐](#post-api-oil-tank-add-add-8)
- [POST /api/oil/tank/add/standard-info/{tankId} - 添加油罐规格信息（一罐一条）](#post-api-oil-tank-add-standard-info-tankid-addtankstandardinfo)
- [GET /api/oil/tank/reading/page - 查询油罐读数](#get-api-oil-tank-reading-page-readingpage)
- [GET /api/oil/tank/query/{id} - 查询油罐(ID)](#get-api-oil-tank-query-id-query-17)
- [GET /api/oil/tank/query/{companyId}/{code} - 查询油罐(编号)](#get-api-oil-tank-query-companyid-code-querybycode)
- [GET /api/oil/tank/query/standard-info/{id} - 查询油罐规格信息（按规格ID）](#get-api-oil-tank-query-standard-info-id-querytankstandardinfo)
- [GET /api/oil/tank/query/standard-info/tank/{tankId} - 查询油罐规格信息（按油罐ID，一罐一条）](#get-api-oil-tank-query-standard-info-tank-tankid-querytankstandardinfobytank)
- [GET /api/oil/tank/query/list/{companyId} - 查询油罐列表（含规格属性）](#get-api-oil-tank-query-list-companyid-querylist-1)
- [GET /api/oil/tank/query/goods/{tankId} - 查询油罐绑定油品（一罐一条）](#get-api-oil-tank-query-goods-tankid-querytankgoods)
- [GET /api/oil/tank/query/goods/list/{companyId} - 查询门店所有油罐绑定油品](#get-api-oil-tank-query-goods-list-companyid-querytankgoodslist)
- [GET /api/oil/tank/query-page/standard-info/{tankId} - 查询油罐规格信息（按油罐ID，兼容旧路径）](#get-api-oil-tank-query-page-standard-info-tankid-pagequerytankstandardinfo)
- [DELETE /api/oil/tank/remove/standard-info/{tankId} - 清除油罐规格信息（按油罐ID）](#delete-api-oil-tank-remove-standard-info-tankid-cleartankstandardinfo)
- [DELETE /api/oil/tank/remove/standard-info/tank/{tankId} - 清除油罐规格信息（按油罐ID）](#delete-api-oil-tank-remove-standard-info-tank-tankid-cleartankstandardinfo-1)
- [DELETE /api/oil/tank/delete/standard-info/{id} - 删除油罐规格信息（按规格ID）](#delete-api-oil-tank-delete-standard-info-id-deletetankstandardinfo)

### 油泵管理接口

- [PUT /api/oil/pump/update/{id} - 修改油泵](#put-api-oil-pump-update-id-update-11)
- [POST /api/oil/pump/add - 添加油泵](#post-api-oil-pump-add-add-9)
- [GET /api/oil/pump/query/{id} - 查询油泵(ID)](#get-api-oil-pump-query-id-query-18)
- [GET /api/oil/pump/query/{companyId}/{code} - 查询油泵(编号)](#get-api-oil-pump-query-companyid-code-querybycode-1)
- [GET /api/oil/pump/query/list/{companyId} - 查询油泵列表](#get-api-oil-pump-query-list-companyid-querylist-2)

### 油品损益配置

- [PUT /api/oil/profit-loss/config/update/{merchantId} - 编辑配置](#put-api-oil-profit-loss-config-update-merchantid-update-12)
- [POST /api/oil/profit-loss/config/add - 添加配置](#post-api-oil-profit-loss-config-add-add-10)
- [GET /api/oil/profit-loss/config/query - 查询配置](#get-api-oil-profit-loss-config-query-query-19)

### 油枪管理接口

- [PUT /api/oil/nozzle/update/{id} - 修改油枪](#put-api-oil-nozzle-update-id-update-13)
- [PUT /api/oil/nozzle/update/group - 变更油枪分组](#put-api-oil-nozzle-update-group-updategroup)
- [POST /api/oil/nozzle/reading/add - 添加油枪读数](#post-api-oil-nozzle-reading-add-addreading-1)
- [POST /api/oil/nozzle/add - 添加油枪](#post-api-oil-nozzle-add-add-11)
- [GET /api/oil/nozzle/reading/page - 查询油枪读数](#get-api-oil-nozzle-reading-page-readingpage-1)
- [GET /api/oil/nozzle/query/{id} - 查询油枪(ID)](#get-api-oil-nozzle-query-id-query-20)
- [GET /api/oil/nozzle/query/{companyId}/{code} - 查询油枪(编号)](#get-api-oil-nozzle-query-companyid-code-querybycode-2)
- [GET /api/oil/nozzle/query/list/{companyId} - 查询油枪列表](#get-api-oil-nozzle-query-list-companyid-querylist-3)

### Fuel服务管理接口

- [PUT /api/oil/fuel-server/update/{id} - 修改Fuel服务配置](#put-api-oil-fuel-server-update-id-update-14)
- [POST /api/oil/fuel-server/data/add - 添加数据(油枪读数、油罐读数等)](#post-api-oil-fuel-server-data-add-dataadd)
- [POST /api/oil/fuel-server/add - 添加Fuel服务配置](#post-api-oil-fuel-server-add-add-12)
- [GET /api/oil/fuel-server/query/{id} - 查询Fuel服务配置(ID)](#get-api-oil-fuel-server-query-id-query-21)

### 收银员管理接口

- [PUT /api/cashier/update/{id} - 修改收银员接口](#put-api-cashier-update-id-updatecashierpassword)
- [PUT /api/cashier/change-password/{id} - 收银员修改密码接口](#put-api-cashier-change-password-id-changepassword)
- [POST /api/cashier/add - 新增收银员接口](#post-api-cashier-add-add-13)
- [GET /api/cashier/query/{id} - 查询收银员(ID)接口](#get-api-cashier-query-id-query-22)
- [GET /api/cashier/query/{companyId}/{account} - 查询收银员(账号)接口](#get-api-cashier-query-companyid-account-query-23)
- [GET /api/cashier/query-page - 查询收银员(分页)接口](#get-api-cashier-query-page-query-24)

### 商户配置搜索接口

- [POST /api/store-merchant-config/update - 商户配置更新接口](#post-api-store-merchant-config-update-update-15)
- [GET /api/store-merchant-config/search/{id} - 商户配置ID查询接口](#get-api-store-merchant-config-search-id-searchconfig)
- [GET /api/store-merchant-config/search-merchant/{merchantId} - 商户配置商户ID查询接口](#get-api-store-merchant-config-search-merchant-merchantid-searchconfigbymerchanti)

### 门店日结

- [POST /api/store-end-day/{id} - 门店日结接口](#post-api-store-end-day-id-storeendday)
- [POST /api/store-end-day/reconciliation/{id} - 门店日结对账接口](#post-api-store-end-day-reconciliation-id-enddayreconciliation)
- [POST /api/store-end-day/notice-pos/change/business-date/{id}/{newBusinessDate} - 通知门店所有机台切换营业日接口](#post-api-store-end-day-notice-pos-change-business-date-id-newbusinessdate-notice)
- [POST /api/store-end-day/change/business-date/{id}/{businessDate} - 更新门店营业日接口](#post-api-store-end-day-change-business-date-id-businessdate-changebusinessdate)

### 班次业务管理接口

- [POST /api/oil/shift-business/start-shift - 接班](#post-api-oil-shift-business-start-shift-startshift)
- [POST /api/oil/shift-business/query-order - 查询油品交易订单](#post-api-oil-shift-business-query-order-queryorder)
- [POST /api/oil/shift-business/oil-collection - 收油](#post-api-oil-shift-business-oil-collection-oilcollection)
- [POST /api/oil/shift-business/oil-back - 回罐](#post-api-oil-shift-business-oil-back-oilback)
- [POST /api/oil/shift-business/end-shift - 交班](#post-api-oil-shift-business-end-shift-endshift)

### 仓库/库位

- [GET /api/store-layout/v1/warehouses - 门店/仓库列表](#get-api-store-layout-v1-warehouses-liststores)
- [GET /api/store-layout/v1/warehouses/{id} - 仓库详情](#get-api-store-layout-v1-warehouses-id-getbyid-2)
- [GET /api/store-layout/v1/warehouses/{id}/locations - 库位列表](#get-api-store-layout-v1-warehouses-id-locations-listlocations)

### 排面 Planogram

- [GET /api/store-layout/v1/layouts/{layoutId}/planogram/validate - 合规校验](#get-api-store-layout-v1-layouts-layoutid-planogram-validate-validate)

### 商品

- [GET /api/store-layout/v1/goods - 搜索商品](#get-api-store-layout-v1-goods-search)
- [GET /api/store-layout/v1/goods/{id} - 按 ID 查询商品](#get-api-store-layout-v1-goods-id-getbyid-4)
- [GET /api/store-layout/v1/goods/code/{code} - 按货号查询商品](#get-api-store-layout-v1-goods-code-code-getbycode)
- [GET /api/store-layout/v1/goods/barcode/{barcode} - 按条码查询](#get-api-store-layout-v1-goods-barcode-barcode-getbybarcode)

### 数据模型

- [GET /api/store-layout/v1/doc/schemas/store-layout - rm_store_layout → RmStoreLayout](#get-api-store-layout-v1-doc-schemas-store-layout-storelayout)
- [GET /api/store-layout/v1/doc/schemas/store-asset-preset - rm_store_layout_asset_preset → RmStoreLayoutAssetPreset](#get-api-store-layout-v1-doc-schemas-store-asset-preset-storeassetpreset)
- [GET /api/store-layout/v1/doc/schemas/stock-warehouse - stock_warehouse → StockWarehouse](#get-api-store-layout-v1-doc-schemas-stock-warehouse-stockwarehouse)
- [GET /api/store-layout/v1/doc/schemas/stock-goods - stock_goods → StockGoods](#get-api-store-layout-v1-doc-schemas-stock-goods-stockgoods)
- [GET /api/store-layout/v1/doc/schemas/stock-goods-barcode - stock_goods_barcode → StockGoodsBarcode](#get-api-store-layout-v1-doc-schemas-stock-goods-barcode-stockgoodsbarcode)
- [GET /api/store-layout/v1/doc/schemas/layout-zone - rm_store_layout_zone → RmStoreLayoutZone](#get-api-store-layout-v1-doc-schemas-layout-zone-layoutzone)
- [GET /api/store-layout/v1/doc/schemas/layout-template - rm_store_layout_template → RmStoreLayoutTemplate](#get-api-store-layout-v1-doc-schemas-layout-template-layouttemplate)
- [GET /api/store-layout/v1/doc/schemas/layout-shelf - rm_store_layout_shelf → RmStoreLayoutShelf](#get-api-store-layout-v1-doc-schemas-layout-shelf-layoutshelf)
- [GET /api/store-layout/v1/doc/schemas/layout-shelf-layer - rm_store_layout_shelf_layer → RmStoreLayoutShelfLayer](#get-api-store-layout-v1-doc-schemas-layout-shelf-layer-layoutshelflayer)
- [GET /api/store-layout/v1/doc/schemas/layout-goods-slot - rm_store_layout_goods_slot → RmStoreLayoutGoodsSlot](#get-api-store-layout-v1-doc-schemas-layout-goods-slot-layoutgoodsslot)
- [GET /api/store-layout/v1/doc/schemas/layout-aisle - rm_store_layout_aisle → RmStoreLayoutAisle](#get-api-store-layout-v1-doc-schemas-layout-aisle-layoutaisle)
- [GET /api/store-layout/v1/doc/schemas/audit-log - rm_store_layout_audit_log → RmStoreAuditLog](#get-api-store-layout-v1-doc-schemas-audit-log-auditlog)

### 服务监控管理

- [GET /api/monitor/version - 获取服务版本信息](#get-api-monitor-version-version)
- [GET /api/monitor/health - 心跳检查](#get-api-monitor-health-health)

### main-site-error-handler

- [GET /error ](#get-error-handleerror)
- [POST /error ](#post-error-handleerror-1)
- [PUT /error ](#put-error-handleerror-2)
- [DELETE /error ](#delete-error-handleerror-3)
- [PATCH /error ](#patch-error-handleerror-4)
- [OPTIONS /error ](#options-error-handleerror-6)
- [HEAD /error ](#head-error-handleerror-5)


## 接口详情

<a id="put-api-store-trade-reason-update-update"></a>

### 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 | 否 |  |  |

<a id="post-api-store-trade-reason-add-add"></a>

### 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 | 否 |  |  |

<a id="get-api-store-trade-reason-search-id-searchtradereason"></a>

### 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 | 否 |  |  |

<a id="get-api-store-trade-reason-search-page-searchtradereason-1"></a>

### 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 | 否 |  |  |

<a id="get-api-store-trade-reason-search-list-searchtradereason-2"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-api-store-trade-reason-delete-remove"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-store-server-update-id-update-1"></a>

### 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 | 否 |  |  |

<a id="post-api-store-server-add-add-1"></a>

### 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 | 否 |  |  |

<a id="get-api-store-server-types-types"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-store-server-query-id-query"></a>

### 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 | 否 |  |  |

<a id="get-api-store-server-query-companyid-type-code-query-1"></a>

### 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 | 否 |  |  |

<a id="get-api-store-server-query-page-query-2"></a>

### 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 | 否 |  |  |

<a id="delete-api-store-server-remove-id-remove-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-store-restaurant-update-id-update-2"></a>

### 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 | 否 |  |  |

<a id="post-api-store-restaurant-add-add-2"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-query-id-query-3"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-query-companyid-code-query-4"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-query-list-companyid-querylist"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-api-store-restaurant-table-update-id-update-3"></a>

### 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 | 否 |  |  |

<a id="put-api-store-restaurant-table-recovery-id-recovery"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-store-restaurant-table-enable-id-enable"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-store-restaurant-table-batch-recovery-batchrecovery"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-store-restaurant-table-batch-enable-batchenable"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-store-restaurant-table-add-add-3"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-table-query-id-query-5"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-table-query-companyid-restaurantid-code-query-6"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-table-query-page-companyid-restaurantid-querypage"></a>

### 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 | 否 |  |  |

<a id="put-api-store-restaurant-table-layout-update-id-update-4"></a>

### 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 | 否 |  |  |

<a id="post-api-store-restaurant-table-layout-add-add-4"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-table-layout-query-id-query-7"></a>

### 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 | 否 |  |  |

<a id="get-api-store-restaurant-table-layout-query-companyid-query-8"></a>

### 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 | 否 |  |  |

<a id="put-api-store-layout-v1-templates-id-scene-graph-updatescenegraph"></a>

### 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 | 否 |  |  |

<a id="post-api-store-layout-v1-templates-id-apply-apply"></a>

### 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 | 否 |  |  |

<a id="post-api-store-layout-v1-templates-from-layout-layoutid-createfromlayout"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-templates-list-2"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-templates-id-getbyid-3"></a>

### 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 | 否 |  |  |

<a id="delete-api-store-layout-v1-templates-id-archive-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-layouts-id-getbyid"></a>

### 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 | 否 |  |  |

<a id="put-api-store-layout-v1-layouts-id-update-5"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-layouts-list"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-api-store-layout-v1-layouts-create"></a>

### 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 | 否 |  |  |

<a id="post-api-store-layout-v1-layouts-id-publish-publish"></a>

### 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 | 否 |  |  |

<a id="post-api-store-layout-v1-layouts-id-archive-archive-1"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-asset-presets-id-getbyid-1"></a>

### 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 | 否 |  |  |

<a id="put-api-store-layout-v1-asset-presets-id-update-6"></a>

### 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 | 否 |  |  |

<a id="delete-api-store-layout-v1-asset-presets-id-archive"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-asset-presets-list-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-api-store-layout-v1-asset-presets-create-1"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-asset-presets-id-model-file-downloadmodelfile"></a>

### 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)

无

<a id="post-api-store-layout-v1-asset-presets-id-model-file-uploadmodelfile"></a>

### 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 | 否 |  |  |

<a id="put-api-printer-update-id-update-7"></a>

### 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 | 否 |  |  |

<a id="put-api-printer-update-status-id-updateprinterstatus"></a>

### 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 | 否 |  |  |

<a id="post-api-printer-untie-all-pos-printerid-untieallpos"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-printer-add-add-5"></a>

### 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 | 否 |  |  |

<a id="get-api-printer-query-id-query-9"></a>

### 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 | 否 |  |  |

<a id="get-api-printer-query-companyid-code-query-10"></a>

### 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 | 否 |  |  |

<a id="get-api-printer-query-use-printer-pos-id-queryuseprinterpos"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-printer-query-page-query-11"></a>

### 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 | 否 |  |  |

<a id="put-api-printer-template-update-id-update-8"></a>

### 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 | 否 |  |  |

<a id="post-api-printer-template-add-add-6"></a>

### 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 | 否 |  |  |

<a id="get-api-printer-template-query-id-query-12"></a>

### 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 | 否 |  |  |

<a id="get-api-printer-template-query-page-query-13"></a>

### 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 | 否 |  |  |

<a id="delete-api-printer-template-remove-id-remove-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-pos-update-id-update-9"></a>

### 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 | 否 |  |  |

<a id="put-api-pos-reset-id-register"></a>

### 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 | 否 |  |  |

<a id="put-api-pos-register-register-1"></a>

### 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 | 否 |  |  |

<a id="put-api-pos-pos-group-update-id-updateposgroup"></a>

### 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 | 否 |  |  |

<a id="put-api-pos-generate-registration-code-id-generateregistrationcode"></a>

### 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 | 否 |  |  |

<a id="post-api-pos-update-goods-callback-id-callbackposupdategoods"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-pos-remove-pos-printer-posid-printerid-posuntieprinter"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-pos-pos-group-add-addposgroup"></a>

### 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 | 否 |  |  |

<a id="post-api-pos-manual-notify-goods-update-goods-goodsupdatenotifyposid-querygoodsu"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-pos-get-api-connection-token-id-getapiconnectiontoken"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-pos-add-add-7"></a>

### 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 | 否 |  |  |

<a id="post-api-pos-add-pos-printer-id-addposprinter"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-pos-query-id-query-14"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-query-companyid-code-query-15"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-query-goods-update-notify-pos-record-id-querygoodsupdatenotifyposrec"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-query-business-info-id-queryposbusinessinfo"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-query-page-query-16"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-pos-group-id-groupquery"></a>

### 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 | 否 |  |  |

<a id="get-api-pos-pos-group-companyid-code-groupquery-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-pos-pos-group-query-page-groupquery-2"></a>

### 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 | 否 |  |  |

<a id="delete-api-pos-delete-id-delete"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-oil-tank-update-id-update-10"></a>

### 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 | 否 |  |  |

<a id="put-api-oil-tank-update-standard-info-id-updatetankstandardinfo"></a>

### 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 | 否 |  |  |

<a id="put-api-oil-tank-update-standard-info-tank-tankid-updatetankstandardinfobytank"></a>

### 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 | 否 |  |  |

<a id="put-api-oil-tank-update-goods-updatetankgoods"></a>

### 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 | 否 |  |  |

<a id="post-api-oil-tank-reading-add-addreading"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-tank-import-standard-info-tank-tankid-importtankstandardinfo"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-tank-import-standard-info-tankid-importtankstandardinfo-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-tank-export-import-standard-info-template-exportimporttankstandardi"></a>

### 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)

无

<a id="post-api-oil-tank-add-add-8"></a>

### 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 | 否 |  |  |

<a id="post-api-oil-tank-add-standard-info-tankid-addtankstandardinfo"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-reading-page-readingpage"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-id-query-17"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-companyid-code-querybycode"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-standard-info-id-querytankstandardinfo"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-standard-info-tank-tankid-querytankstandardinfobytank"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-list-companyid-querylist-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-oil-tank-query-goods-tankid-querytankgoods"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-tank-query-goods-list-companyid-querytankgoodslist"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-oil-tank-query-page-standard-info-tankid-pagequerytankstandardinfo"></a>

### 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 | 否 |  |  |

<a id="delete-api-oil-tank-remove-standard-info-tankid-cleartankstandardinfo"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-api-oil-tank-remove-standard-info-tank-tankid-cleartankstandardinfo-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-api-oil-tank-delete-standard-info-id-deletetankstandardinfo"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-api-oil-pump-update-id-update-11"></a>

### 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 | 否 |  |  |

<a id="post-api-oil-pump-add-add-9"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-pump-query-id-query-18"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-pump-query-companyid-code-querybycode-1"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-pump-query-list-companyid-querylist-2"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-api-oil-profit-loss-config-update-merchantid-update-12"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-profit-loss-config-add-add-10"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-oil-profit-loss-config-query-query-19"></a>

### 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 | 否 |  |  |

<a id="put-api-oil-nozzle-update-id-update-13"></a>

### 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 | 否 |  |  |

<a id="put-api-oil-nozzle-update-group-updategroup"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-api-oil-nozzle-reading-add-addreading-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-nozzle-add-add-11"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-nozzle-reading-page-readingpage-1"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-nozzle-query-id-query-20"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-nozzle-query-companyid-code-querybycode-2"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-nozzle-query-list-companyid-querylist-3"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-api-oil-fuel-server-update-id-update-14"></a>

### 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 | 否 |  |  |

<a id="post-api-oil-fuel-server-data-add-dataadd"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-fuel-server-add-add-12"></a>

### 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 | 否 |  |  |

<a id="get-api-oil-fuel-server-query-id-query-21"></a>

### 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 | 否 |  |  |

<a id="put-api-cashier-update-id-updatecashierpassword"></a>

### 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 | 否 |  |  |

<a id="put-api-cashier-change-password-id-changepassword"></a>

### 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 | 否 |  |  |

<a id="post-api-cashier-add-add-13"></a>

### 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 | 否 |  |  |

<a id="get-api-cashier-query-id-query-22"></a>

### 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 | 否 |  |  |

<a id="get-api-cashier-query-companyid-account-query-23"></a>

### 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 | 否 |  |  |

<a id="get-api-cashier-query-page-query-24"></a>

### 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 | 否 |  |  |

<a id="post-api-store-merchant-config-update-update-15"></a>

### 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 | 否 |  |  |

<a id="get-api-store-merchant-config-search-id-searchconfig"></a>

### 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 | 否 |  |  |

<a id="get-api-store-merchant-config-search-merchant-merchantid-searchconfigbymerchanti"></a>

### 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 | 否 |  |  |

<a id="post-api-store-end-day-id-storeendday"></a>

### 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 | 否 |  |  |

<a id="post-api-store-end-day-reconciliation-id-enddayreconciliation"></a>

### 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 | 否 |  |  |

<a id="post-api-store-end-day-notice-pos-change-business-date-id-newbusinessdate-notice"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-store-end-day-change-business-date-id-businessdate-changebusinessdate"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-shift-business-start-shift-startshift"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-shift-business-query-order-queryorder"></a>

### 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 | 否 |  |  |

<a id="post-api-oil-shift-business-oil-collection-oilcollection"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-shift-business-oil-back-oilback"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-oil-shift-business-end-shift-endshift"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-warehouses-liststores"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-warehouses-id-getbyid-2"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-warehouses-id-locations-listlocations"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-layouts-layoutid-planogram-validate-validate"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-goods-search"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-store-layout-v1-goods-id-getbyid-4"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-goods-code-code-getbycode"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-goods-barcode-barcode-getbybarcode"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-doc-schemas-store-layout-storelayout"></a>

### 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 |

<a id="get-api-store-layout-v1-doc-schemas-store-asset-preset-storeassetpreset"></a>

### 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 | 是 | 资产预设状态 |  |

<a id="get-api-store-layout-v1-doc-schemas-stock-warehouse-stockwarehouse"></a>

### 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 |

<a id="get-api-store-layout-v1-doc-schemas-stock-goods-stockgoods"></a>

### 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 | 否 |  |  |

<a id="get-api-store-layout-v1-doc-schemas-stock-goods-barcode-stockgoodsbarcode"></a>

### 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 | 否 | 规格 |  |

<a id="get-api-store-layout-v1-doc-schemas-layout-zone-layoutzone"></a>

### 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" |

<a id="get-api-store-layout-v1-doc-schemas-layout-template-layouttemplate"></a>

### 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 |

<a id="get-api-store-layout-v1-doc-schemas-layout-shelf-layoutshelf"></a>

### 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" |

<a id="get-api-store-layout-v1-doc-schemas-layout-shelf-layer-layoutshelflayer"></a>

### 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 |

<a id="get-api-store-layout-v1-doc-schemas-layout-goods-slot-layoutgoodsslot"></a>

### 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 |

<a id="get-api-store-layout-v1-doc-schemas-layout-aisle-layoutaisle"></a>

### 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" |

<a id="get-api-store-layout-v1-doc-schemas-audit-log-auditlog"></a>

### 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) | 是 | 创建时间 |  |

<a id="get-api-monitor-version-version"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-monitor-health-health"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-error-handleerror"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-error-handleerror-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-error-handleerror-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-error-handleerror-3"></a>

### 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 | 否 | 返回数据 |  |

<a id="patch-error-handleerror-4"></a>

### 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 | 否 | 返回数据 |  |

<a id="options-error-handleerror-6"></a>

### 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 | 否 | 返回数据 |  |

<a id="head-error-handleerror-5"></a>

### HEAD /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_5

#### 调用方法

`HEAD /error`

#### 参数

无

#### 请求体

无

#### 响应


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

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


## 模型定义

### com.leadwaycloud.rm.store.business.trade.reason.dto.UpdateTradeReasonReqDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tradeReasonId | integer(int64) | 是 | 交易理由ID | 1 |
| orderType | string | 否 | 类型 | "SALE" |
| reason | string | 否 | 交易理由 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmTradeReason

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

### com.leadwaycloud.rm.common.model.po.entity.RmTradeReason

交易理由

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| orderType | string | 是 | 类型 | "SALE" |
| reason | string | 是 | 交易理由 |  |

### com.leadwaycloud.rm.store.business.store.server.dto.UpdateStoreServerDTO

修改门店服务器数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 否 | 服务类型 | "FUEL_SERVER" |
| code | string | 否 | 服务编号 | "001" |
| config | string | 否 | 服务配置 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer

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

### com.leadwaycloud.rm.store.model.po.entity.RmStoreServer

门店服务器

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 服务类型 | "FUEL_SERVER" |
| code | string | 是 | 服务编号 | "001" |
| config | string | 是 | 服务配置 |  |

### 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 | 是 | 餐厅图片 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurant

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

### com.leadwaycloud.rm.store.model.po.entity.RmRestaurant

餐厅

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 餐厅编号 | "C001" |
| name | string | 是 | 餐厅名称 | "C001" |
| active | boolean | 是 | 是否可用 | true |
| description | string | 否 | 描述 |  |
| externalId | string | 否 | 外部系统ID |  |
| menuTemplateId | integer(int64) | 否 | 菜单模版 | 1 |
| tableLayoutId | integer(int64) | 否 | 餐厅桌位布局 | 1 |
| images | string | 否 | 餐厅图片 |  |

### com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| floor | integer(int32) | 否 | 楼层 | 1 |
| info | string | 否 | 桌位详细信息 | "前端自定义json字符串" |
| externalId | string | 否 | 外部系统ID |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

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

### com.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 桌位号 | "C001" |
| floor | integer(int32) | 是 | 楼层 | 1 |
| active | boolean | 是 | 是否可用 | true |
| info | string | 否 | 桌位详细信息 | "前端自定义json字符串" |
| externalId | string | 否 | 外部系统ID |  |

### com.leadwaycloud.core.model.RJava.lang.Void

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

### com.leadwaycloud.rm.store.business.restaurant.dto.UpdateRestaurantTableLayoutDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 | "C001" |
| layout | boolean | 是 | 是否可用 | true |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

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

### com.leadwaycloud.rm.store.model.po.entity.RmRestaurantTableLayout

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编码 | "C001" |
| name | string | 否 | 名称说明 | "1" |
| layout | object[] | 否 | 桌位详细信息 | "前端自定义json字符串" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

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

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateDetailDto

布局模板详情（含 scene_graph）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| description | string | 否 |  |  |
| category | string | 否 |  |  |
| status | string | 否 |  |  |
| floorWidth | number | 否 |  |  |
| floorDepth | number | 否 |  |  |
| sourceLayoutId | integer(int64) | 否 |  |  |
| thumbnailUrl | string | 否 |  |  |
| sceneGraph | string | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.UpdateLayoutRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 |  |  |
| code | string | 否 |  |  |
| floorWidth | number | 否 |  |  |
| floorDepth | number | 否 |  |  |
| sceneGraph | string | 否 |  |  |
| status | string | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

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

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto

门店布局详情，含场景 JSON 与结构化区域/通道/货架/排面数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 布局 ID | 1 |
| code | string | 否 | 布局编码 | "LAYOUT-001" |
| name | string | 否 | 布局名称 | "春熙路店默认布局" |
| versionNo | integer(int32) | 否 | 版本号，发布时递增 | 1 |
| status | string | 否 | 布局生命周期状态 |  |
| floorWidth | number | 否 | 卖场宽度（米） | 30 |
| floorDepth | number | 否 | 卖场深度（米） | 20 |
| sceneGraph | string | 否 | Pascal Editor 场景 JSON 字符串 |  |
| companyId | integer(int64) | 否 | 公司 ID | 1 |
| updateTime | string(date-time) | 否 | 最后更新时间 |  |
| zones | LayoutDetailDto$ZoneDto[] | 否 | 销售区域列表 |  |
| aisles | LayoutDetailDto$AisleDto[] | 否 | 通道列表 |  |
| shelves | LayoutDetailDto$ShelfDto[] | 否 | 货架列表（含层与排面槽位） |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$AisleDto

门店通道

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 通道 ID |  |
| code | string | 否 | 通道编码 |  |
| name | string | 否 | 通道名称 |  |
| startX | number | 否 | 起点 X（米） |  |
| startZ | number | 否 | 起点 Z（米） |  |
| endX | number | 否 | 终点 X（米） |  |
| endZ | number | 否 | 终点 Z（米） |  |
| width | number | 否 | 通道宽度（米） |  |
| direction | string | 否 | 方向：HORIZONTAL\|VERTICAL\|CUSTOM |  |
| sceneNodeId | string | 否 | 场景节点 ID |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$GoodsSlotDto

商品排面槽位（Planogram 单元格）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 槽位 ID |  |
| slotIndex | integer(int32) | 否 | 层内序号，从 0 起 |  |
| goodsId | integer(int64) | 否 | ERP 商品 ID（stock_goods.id） | 3001 |
| barcodeId | integer(int64) | 否 | 结算条码 ID（stock_goods_barcode.id） | 4001 |
| goodsCode | string | 否 | 货号（stock_goods.code） | "GD-001" |
| facings | integer(int32) | 否 | 横向排面列数 | 4 |
| depthFacings | integer(int32) | 否 | 纵深陈列深度 | 2 |
| stackLayers | integer(int32) | 否 | 垂直堆叠层数 | 1 |
| facing | string | 否 | 朝向 FRONT\|SIDE\|TOP | "FRONT" |
| quantity | integer(int32) | 否 | 陈列总件数 | 8 |
| displayType | string | 否 | 陈列类型 STANDARD\|PDQ\|CLIP\|HANGING\|PALLET | "STANDARD" |
| sceneNodeId | string | 否 | 场景节点 ID |  |
| packWidthMm | integer(int32) | 否 | 包装宽度（毫米） | 65 |
| packHeightMm | integer(int32) | 否 | 包装高度（毫米） | 200 |
| packDepthMm | integer(int32) | 否 | 包装深度（毫米） | 65 |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ShelfDto

门店货架

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 货架 ID |  |
| code | string | 否 | 货架编码 |  |
| name | string | 否 | 货架名称 |  |
| shelfType | string | 否 | 货架类型 |  |
| positionX | number | 否 | X 坐标（米） |  |
| positionY | number | 否 | Y 坐标（米） |  |
| positionZ | number | 否 | Z 坐标（米） |  |
| rotationY | number | 否 | Y 轴旋转（弧度） |  |
| width | number | 否 | 货架宽度（米） |  |
| height | number | 否 | 货架高度（米） |  |
| depth | number | 否 | 货架深度（米） |  |
| layerCount | integer(int32) | 否 | 层数 |  |
| warehouseLocationId | integer(int64) | 否 | 绑定的 ERP 库位 ID |  |
| sceneNodeId | string | 否 | 场景节点 ID |  |
| layers | LayoutDetailDto$ShelfLayerDto[] | 否 | 货架层列表 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ShelfLayerDto

货架层

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 层 ID |  |
| layerNo | integer(int32) | 否 | 层号，从 1 起 |  |
| height | number | 否 | 层板高度（米） |  |
| maxItems | integer(int32) | 否 | 最大 SKU 数 |  |
| pickPriority | integer(int32) | 否 | WMS 拣货优先级，越小越先拣 | 100 |
| sceneNodeId | string | 否 | 场景节点 ID |  |
| slots | LayoutDetailDto$GoodsSlotDto[] | 否 | 本层排面槽位列表 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutDetailDto$ZoneDto

布局销售区域/形状

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 区域 ID |  |
| code | string | 否 | 区域编码 |  |
| name | string | 否 | 区域名称 |  |
| zoneType | string | 否 | 布局销售区域类型 |  |
| shapeType | string | 否 | 区域形状类型 |  |
| polygonJson | string | 否 | 多边形顶点 JSON：[[x,z],...] |  |
| positionX | number | 否 | X 坐标（米） |  |
| positionZ | number | 否 | Z 坐标（米） |  |
| width | number | 否 | 宽度（米） |  |
| depth | number | 否 | 深度（米） |  |
| rotation | number | 否 | 旋转角（弧度） |  |
| color | string | 否 | 显示颜色 HEX |  |
| warehouseId | integer(int64) | 否 | 绑定的 ERP 仓库/门店 ID |  |
| sceneNodeId | string | 否 | 场景节点 ID |  |

### 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) | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

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

### com.leadwaycloud.rm.store.business.storelayout.dto.AssetPresetDto

门店 3D 资产预设

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| merchantId | integer(int64) | 否 |  |  |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| description | string | 否 |  |  |
| category | string | 否 |  |  |
| nodeType | string | 否 |  |  |
| presetJson | string | 否 |  |  |
| thumbnailUrl | string | 否 |  |  |
| modelUrl | string | 否 |  |  |
| visualMode | string | 否 |  |  |
| sortOrder | integer(int32) | 否 |  |  |
| status | string | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |

### com.leadwaycloud.rm.store.business.printer.dto.UpdatePrinterConfigDTO

修改打印机配置数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| connectionType | string | 否 | 连接类型  【 NETWORK : 网络   SERIAL : 串口   USBSERIAL : USB串口   USB : USB   BLUETOOTH : 蓝牙   】 | "SERIAL" |
| networkHost | string | 否 | 网络地址 | "192.168.2.11" |
| networkPort | string | 否 | 网络端口 | "9100" |
| serialPort | string | 否 | 串口地址 | "/etc/ttyS01" |
| serialBandRate | string | 否 | 串口波特率 | "19200" |
| serialDataBits | string | 否 | 串口数据位 | "8" |
| serialStopBits | string | 否 | 串口停止位 | "0" |
| serialParity | string | 否 | 串口奇偶校验位 | "0" |
| deviceCommandId | integer(int64) | 否 | 设备指令集ID | 1 |

### 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)[] | 否 | 打印模版(变更时把模版重新提交) |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

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

### com.leadwaycloud.rm.common.model.po.entity.ResCompany

总部/区域总部/公司/门店

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| code | string | 是 | 公司编号(仅允许字母和数字) | "CD01" |
| name | string | 是 | 公司名称 | "成都立威云" |
| otherCode | string | 是 | 其他编号 | "AAAA-01" |
| type | string | 是 | 类型  【 MERCHANT : 总部   EMPTY : 无任何管理功能   AREA : 区域总部   STORE : 门店   】 | "STORE" |
| status | string | 是 | 状态  【 IN_OPERATION : 营业中   TO_BE_OPENED : 待开业   PREPARATION : 筹备中   DELETE : 已删除   】 | "IN_OPERATION" |
| idChain | string | 是 | 公司ID完整架构(上下级公司id用-连接) | "123-456" |
| slogan | string | 否 | 公司标语 | "努力工作就是为了不工作" |
| initConfig | string | 是 | 公司配置是否初始化 | "false" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| image | string | 否 | 图片 |  |
| contact | ResContact | 否 |  |  |
| merchant | ResMerchant | 是 |  |  |

### com.leadwaycloud.rm.common.model.po.entity.ResContact

地址联系关系

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| countryId | integer(int64) | 是 | 国家ID | 1 |
| stateId | integer(int64) | 是 | 省、直辖市ID | 1 |
| cityId | integer(int64) | 是 | 城市ID | 1 |
| areaId | integer(int64) | 否 | 区、县ID | 1 |
| streetId | integer(int64) | 否 | 街道ID | 1 |
| address | string | 否 | 详细地址 | "1" |
| postcode | string | 否 | 邮编 | "1" |
| phone | string | 否 | 电话 | "1" |
| mobile | string | 否 | 手机 | "1" |
| fax | string | 否 | 传真 | "1" |
| email | string | 否 | 邮箱 | "邮箱" |
| latLon | string | 否 | 经纬度 |  |

### com.leadwaycloud.rm.common.model.po.entity.ResMerchant

商户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 商户代号 | "lwc" |
| abbreviation | string | 是 | 简称 | "立威云" |
| fullName | string | 是 | 全称 | "成都立威云科技有限公司" |
| status | boolean | 是 | 状态 | false |
| industry | string | 是 | 行业 | "COMPLEX" |
| email | string | 是 | 联系邮箱(用作初始化创建账号) | "sale@leadwaycloud.com" |
| phone | string | 否 | 联系电话 |  |
| address | string | 否 | 联系地址 |  |
| logo | string | 否 | 图标 |  |

### com.leadwaycloud.rm.store.model.bo.DeviceCommandBO

设备指令集数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 指令名称 | "切纸" |
| code | string | 是 | 指令Code | "PARTIAL_CUT" |
| command | string | 是 | 指令 | "0x1D,0x56,0x00" |
| description | string | 否 | 指令描述 | "用作执行打印切纸动作" |

### com.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

打印模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| 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 |
| usableCompanyStr | string | 否 | 可用公司 |  |
| usableCompanyList | ResCompany[] | 否 | 可用公司集合 |  |

### com.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

打印机

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "P001" |
| type | string | 是 | 类型  【 MATRIX_PRINTER : 针式票据打印机   THERMAL_PRINTER : 热敏式票据打印机   】 | "THERMAL_TICKET" |
| status | string | 是 | 状态  【 NORMAL : 正常   FAULT : 故障   DAMAGE : 损坏   MAINTAIN : 维修   】 | "NORMAL" |
| name | string | 是 | 名称 | "1号票据打印机" |
| description | string | 否 | 描述 |  |
| devicePrinterConfig | RmDevicePrinterConfig | 是 |  |  |
| printTemplateList | RmDevicePrintTemplate[] | 否 | 打印模板 |  |

### com.leadwaycloud.rm.store.model.po.entity.RmDevicePrinterConfig

打印机配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| connectionType | string | 是 | 连接类型 | "SERIAL" |
| networkHost | string | 否 | 网络地址 | "192.168.2.11" |
| networkPort | string | 否 | 网络端口 | "1900" |
| serialPort | string | 否 | 串口地址 | "/etc/ttyS01" |
| serialBandRate | string | 否 | 串口波特率 | "19200" |
| serialDataBits | string | 否 | 串口数据位 | "8" |
| serialStopBits | string | 否 | 串口停止位 | "0" |
| serialParity | string | 否 | 串口奇偶校验位 | "0" |
| deviceCommand | SysDeviceCommand | 是 |  |  |

### com.leadwaycloud.rm.store.model.po.entity.SysDeviceCommand

设备指令

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| brand | string | 是 | 品牌 | "EPSON" |
| model | string | 是 | 型号 | "TM-T70" |
| type | string | 是 | 设备类型  【 PRINTER : 打印机   】 | "PRINTER" |
| command | DeviceCommandBO[] | 是 | 指令集 | [{"name":"切纸","code":"PARTIAL_CUT","command":"0x1D,0x56,0x00","description":"用作执行打印切纸动作"}] |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

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

### 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设备列表 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

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

### com.leadwaycloud.rm.store.model.po.entity.RmDevicePos

机台

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "POS001" |
| status | string | 是 | 状态 | "INACTIVATED" |
| description | string | 否 | 描述 |  |
| applicationVersion | string | 否 | 应用版本 |  |
| registerTime | string | 否 | 激活时间 | "2020-10-11 10:09:11" |
| deviceName | string | 否 | 设备名称 | "MacBook-Pro-zkl.local" |
| deviceOSType | string | 否 | 设备操作系统类型 | "macOS Catalina" |
| deviceOSVersion | string | 否 | 设备操作系统版本 | "10.15.7" |
| deviceMacAddress | string | 否 | 设备MAC地址 | "88:E9:FE:7B:DA:75" |
| deviceKey | string | 否 | 设备唯一标识 | "OJ0789I0UR290UR2393U82" |
| defStockWarehouseId | integer(int64) | 否 | 非油商品默认扣减库存仓库ID | 1 |
| mode | string | 否 | 应用模式  【 POS : 收银pos机   KDS : 厨房显示器   ORD : 订单显示屏   MDS : 媒体显示屏   SCO : 自助服务机   CDS : 独立客显   】 | "POS" |
| bindings | string | 否 | 绑定主POS设备列表 |  |
| registrationCode | string | 否 | POS注册码(Windows激活码格式) | "ABCDE-FGHJK-LMNPR-STUVW-XY234" |
| company | ResCompany | 否 |  |  |
| posGroup | RmDevicePosGroup | 否 |  |  |
| posPrinterList | RmDevicePrinter[] | 是 | 机台关联的打印机 |  |

### com.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

机台分组

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司 |  |
| code | string | 是 | 分组编号 | "GROUP-001" |
| name | string | 否 | 分组名称 | "Group 001" |
| description | string | 否 | 描述 |  |
| config | object | 否 | 分组通用配置 | {} |

### 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" |

### com.leadwaycloud.rm.store.business.pos.dto.UpdatePosGroupDTO

分页查询机台分组数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号 | "POS001" |
| name | string | 否 | 名称 |  |
| description | string | 否 | 描述 |  |
| config | string | 否 | 配置详情 | "{}" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

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

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilTankDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| maxVolume | number(double) | 否 |  |  |
| alarmVolume | number(double) | 否 |  |  |
| goodsId | integer(int64) | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTank

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

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilTank

石油-油罐

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 油罐编号 | "1" |
| name | string | 是 | 油罐名称 | "#1号油罐" |
| stockWarehouseId | integer(int64) | 是 | 仓库ID | 1 |
| goodsId | integer(int64) | 否 | 绑定油品ID（换罐/换油后直接更新此字段） | 1 |
| maxVolume | number(double) | 否 | 最大体积 |  |
| alarmVolume | number(double) | 否 | 警戒体积 |  |

### 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) | 否 | 预警温度 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification

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

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilTankSpecification

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| tankId | integer(int64) | 否 |  |  |
| height | number(double) | 否 |  |  |
| tankCapacity | number(double) | 否 |  |  |
| 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) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateTankGoodsDTO

更新油罐绑定油品

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tankId | integer(int64) | 是 | 油罐ID |  |
| goodsId | integer(int64) | 是 | 绑定油品ID |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO

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

### com.leadwaycloud.rm.store.business.oil.vo.TankGoodsVO

油罐绑定油品信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 否 | 公司ID |  |
| tankId | integer(int64) | 否 | 油罐ID |  |
| tankCode | string | 否 | 油罐编号 |  |
| tankName | string | 否 | 油罐名称 |  |
| stockWarehouseId | integer(int64) | 否 | 油库仓库ID |  |
| goodsId | integer(int64) | 否 | 绑定油品ID |  |
| goodsCode | string | 否 | 油品编码 |  |
| goodsName | string | 否 | 油品名称 |  |
| energyGoodsType | string | 否 | 能源商品类型 |  |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilPumpDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| tankId | integer(int64) | 否 |  |  |
| linkTanks | integer(int64)[] | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilPump

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

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilPump

石油-油泵

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 油泵编号 | "1" |
| name | string | 是 | 油泵名称 | "#1号油泵" |
| oilTank | EnergyOilTank | 否 |  |  |
| linkTankList | EnergyOilTank[] | 否 | 可连接的油罐列表 |  |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO

编辑油品损益配置DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| oilProfitLossDTOList | UpdateOilProfitLossConfigDTO$OilProfitLossDTO[] | 是 | 损益配置 |  |
| oilTypeGoodsDTOList | UpdateOilProfitLossConfigDTO$OilTypeGoodsDTO[] | 是 | 油品类型商品关联DTO |  |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO$OilProfitLossDTO

损益配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| profitLossRatioUpper | number(double) | 否 | 损益率上限 | 1 |
| profitLossRatioLower | number(double) | 否 | 损益率下限 | 1 |
| profitLossUpper | number(double) | 否 | 损益上限 | 1 |
| profitLossLower | number(double) | 否 | 损益下限 | 1 |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilProfitLossConfigDTO$OilTypeGoodsDTO

油品类型商品关联DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| dilatationCoefficient | number(double) | 是 | 膨胀系数 | 1 |
| goods | string | 是 | 关联商品 | "1" |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle

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

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzle

石油-油枪

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 油枪编号 | "1" |
| name | string | 是 | 油枪名称 | "#1号油枪" |
| maxValue | number(double) | 否 | 最大走字 | 1 |
| oilPump | EnergyOilPump | 否 |  |  |
| oilTank | EnergyOilTank | 否 |  |  |
| group | string | 是 | 分组 | "UUID" |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.oil.dto.UpdateOilFuelServerConfigDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| host | string | 否 |  |  |
| serverPath | string | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig

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

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilFuelServerConfig

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 否 |  |  |
| host | string | 否 |  |  |
| serverPath | string | 否 |  |  |

### 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" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmCashier

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

### com.leadwaycloud.rm.common.model.po.entity.RmCashier

收银员

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| account | string | 是 | 账号 | "131131" |
| password | string | 是 | 密码 | "111111" |
| status | string | 是 | 状态  【 ACTIVE : 活跃   LOCK : 锁定   VOID : 删除   】 | "ACTIVE" |
| type | string | 是 | 类型  【 CASHIER : 收银员   LEADER : 收银组长   MANAGER : 收银管理员   】 | "CASHIER" |
| employeeId | integer(int64) | 否 | 员工ID | 1 |
| image | string | 否 | 头像/形象图片 URL | "https://cdn.example.com/cashier/001.png" |

### com.leadwaycloud.rm.store.business.cashier.dto.ChangeCashierPasswordDTO

收银员修改密码数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| oldPassword | string | 是 | 原密码 | "111111" |
| newPassword | string | 是 | 新密码 | "222222" |

### com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonAddReqDTO

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

### com.leadwaycloud.rm.store.business.store.server.dto.AddStoreServerDTO

增加门店服务器数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 服务类型 | "FUEL_SERVER" |
| code | string | 是 | 服务编号 | "001" |
| config | string | 是 | 服务配置 |  |

### 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 | 是 | 餐厅图片 |  |

### 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 |  |

### com.leadwaycloud.rm.store.business.restaurant.dto.AddRestaurantTableLayoutDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "C001" |
| name | string | 是 | 名称 | "C001" |
| layout | string | 是 | 布局 | "[]" |

### com.leadwaycloud.rm.common.business.store.model.RmMerchantConfigBO

商户配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| maxCollectItemCount | integer(int32) | 否 | 收藏夹最大可收藏商品项 | 15 |
| maxShoppingCartItemCount | integer(int32) | 否 | 购物车最大可添加商品项 | 15 |
| autoReceiveDay | integer(int32) | 否 | 物流发出后默认收货天数 | 15 |
| refundMaxDelayDay | integer(int32) | 否 | 退货最大延迟天数 | 7 |
| useGoodsBarcodePriceList | boolean | 否 | 是否使用价目表价格 | true |
| onlineSelfOrderAutoDelivery | boolean | 否 | 在线自提销售订单是否自动发货 | true |
| mallShowBrand | boolean | 否 | 商城展示品牌板块 |  |
| serviceUserList | integer(int64)[] | 否 | 客服人员 | [] |
| serviceQrCode | string | 否 | 客服二维码 |  |
| businessSignet | string | 否 | 业务专用章 |  |
| saveTime | integer(int32) | 否 | 商城订单提交后保留时间(分钟)。默认720分钟(12小时) | 720 |
| customerServiceWindowNotice | string | 否 | 客服窗口提示文本 |  |
| helpdeskUrl | string | 否 | 帮助中心链接 |  |
| registerProtocolUrl | string | 否 | 怡合达工品服务协议链接 |  |
| privacyProtocolUrl | string | 否 | 怡合达工品用户隐私协议链接 |  |
| certificationLetterUrl | string | 否 | 怡合达工品电商平台认证企业申请函链接 |  |
| userWriteOffUrl | string | 否 | 怡合达工品账号注销重要提醒链接 |  |

### com.leadwaycloud.rm.store.business.merchant.config.dto.MerchantConfigUpdateRequestDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| merchantConfig | RmMerchantConfigBO | 是 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMerchantConfig

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

### com.leadwaycloud.rm.common.model.po.entity.RmMerchantConfig

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| config | string | 否 | 商户零管配置 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.ApplyLayoutTemplateRequest

应用布局模板创建新布局

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| layoutName | string | 是 |  |  |
| layoutCode | string | 否 |  |  |
| companyId | integer(int64) | 是 |  |  |
| merchantId | integer(int64) | 否 |  |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.CreateTemplateFromLayoutRequest

从布局保存为模板

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 |  |  |
| code | string | 否 |  |  |
| description | string | 否 |  |  |
| category | string | 否 |  |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.CreateLayoutRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 |  |  |
| code | string | 否 |  |  |
| floorWidth | number | 否 |  |  |
| floorDepth | number | 否 |  |  |
| sceneGraph | string | 否 |  |  |
| companyId | integer(int64) | 是 |  |  |
| merchantId | integer(int64) | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto

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

### com.leadwaycloud.rm.store.business.storelayout.dto.PublishResultDto

布局发布结果

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| layoutId | integer(int64) | 否 | 布局 ID | 1 |
| versionNo | integer(int32) | 否 | 发布后版本号 | 2 |
| generatedLocationCodes | string[] | 否 | 本次自动生成的库位编码列表 | ["STORE-001-S001","STORE-001-S002"] |

### com.leadwaycloud.rm.store.business.end.day.model.EndDayRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| cashierAccount | string | 是 | 收银员账号 | "131131" |
| posCode | string | 是 | 机台编号 | "10" |
| businessDate | string | 是 | 当前营业日 | "2026-07-22" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.end.day.model.EndDayResponse

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

### com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse

日结对账结果

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| success | boolean | 否 | 是否成功 | true |
| differenceList | EndDayReconciliationResponse$DifferenceInfo[] | 否 | 对账差异 |  |

### com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse$Detail

其他系统数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| posNo | string | 是 | 对账机台号 | "1" |
| orderCode | string | 是 | 订单编号 | "xxx" |
| pkNo | integer(int64) | 是 | 交易流水号 | 1 |
| tenderNo | string | 是 | 支付方式编号 | "WECHAT" |
| tenderName | string | 是 | 支付方式名称 | "微信" |
| amount | number | 是 | 支付金额 | 1 |

### com.leadwaycloud.rm.store.business.end.day.model.EndDayReconciliationResponse$DifferenceInfo

对账差异

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| lwc | EndDayReconciliationResponse$Detail | 否 |  |  |
| other | EndDayReconciliationResponse$Detail | 否 |  |  |

### com.leadwaycloud.rm.store.business.end.day.model.EndDayResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| reconciliation | 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 | 否 |  |  |

### com.leadwaycloud.rm.store.business.end.day.model.CompanyBusinessDateChangeRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| cashierAccount | string | 是 | 收银员账号 | "131131" |
| posCode | string | 是 | 机台编号 | "10" |
| businessDate | string | 是 | 当前营业日 | "2026-07-23" |

### com.leadwaycloud.core.model.RJava.lang.Boolean

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

### com.leadwaycloud.rm.store.business.printer.dto.AddPrinterConfigDTO

增加打印机配置数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| connectionType | string | 是 | 连接类型  【 NETWORK : 网络   SERIAL : 串口   USBSERIAL : USB串口   USB : USB   BLUETOOTH : 蓝牙   】 | "SERIAL" |
| networkHost | string | 否 | 网络地址 | "192.168.2.11" |
| networkPort | string | 否 | 网络端口 | "1900" |
| serialPort | string | 否 | 串口地址 | "/etc/ttyS01" |
| serialBandRate | string | 否 | 串口波特率 | "19200" |
| serialDataBits | string | 否 | 串口数据位 | "8" |
| serialStopBits | string | 否 | 串口停止位 | "0" |
| serialParity | string | 否 | 串口奇偶校验位 | "0" |
| deviceCommandId | integer(int64) | 是 | 设备指令集ID | 1 |

### 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)[] | 否 | 打印模版 |  |

### 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 |

### com.leadwaycloud.rm.store.business.pos.dto.AddPosGroupDTO

增加机台分组数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "POS001" |
| name | string | 否 | 名称 |  |
| description | string | 否 | 描述 |  |
| config | object | 否 | 配置 | {} |

### com.leadwaycloud.core.model.RJava.lang.String

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

### 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设备列表 |  |

### 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[] | 否 | 返回数据 |  |

### 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" |

### 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) | 否 |  |  |

### 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) | 否 | 预警温度 |  |

### com.leadwaycloud.rm.store.business.oil.bo.PumpNumberDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pump | string | 否 |  |  |
| number | number(double) | 否 |  |  |

### com.leadwaycloud.rm.store.business.oil.bo.TankNumberDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tank | string | 否 |  |  |
| 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) | 否 |  |  |

### com.leadwaycloud.rm.store.business.oil.dto.OilShiftDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 否 |  |  |
| posId | integer(int64) | 否 |  |  |
| shiftNo | integer(int32) | 否 |  |  |
| shiftDate | string(date) | 否 |  |  |
| tankNumberList | TankNumberDTO[] | 否 |  |  |
| pumpNumberList | PumpNumberDTO[] | 否 |  |  |

### 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) | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmOrderOil

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.common.model.po.entity.RmOrderOil

订单油品

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| shiftNo | integer(int64) | 否 | 班次号 | 1 |
| orderId | integer(int64) | 是 | 订单ID |  |
| orderItemId | integer(int64) | 是 | 订单品项ID | 1 |
| tank | string | 是 | 油罐 | "1" |
| pump | string | 是 | 油泵 | "1" |
| nozzle | string | 是 | 油枪 | "1" |
| pumpStartNumber | number(double) | 是 | 起泵码 | 100 |
| pumpEndNumber | number(double) | 是 | 止泵码 | 150 |
| machineOut | number(double) | 是 | 油机付出 | 50 |
| tradCode | string | 是 | 交易号 | "12345" |
| tradTime | string | 是 | 交易时间 | "2020-11-11 10:20:39" |

### com.leadwaycloud.rm.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) | 否 |  |  |

### 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 | 否 |  |  |

### com.leadwaycloud.rm.store.business.oil.dto.AddOilPumpDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 否 |  |  |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| tankId | integer(int64) | 否 |  |  |
| linkTanks | integer(int64)[] | 否 |  |  |

### com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO

新增油品损益配置DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| oilProfitLossDTOList | AddOilProfitLossConfigDTO$OilProfitLossDTO[] | 是 | 损益配置 |  |
| oilTypeGoodsDTOList | AddOilProfitLossConfigDTO$OilTypeGoodsDTO[] | 是 | 油品类型商品关联DTO |  |

### com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO$OilProfitLossDTO

损益配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| oilType | string | 是 | 油品类型  【 GASOLINE : 汽油   DIESEL : 柴油   】 | "GASOLINE" |
| cycleType | string | 是 | 周期类型  【 SINGLE_DAY : 单日   FIVE_DAYS : 五日   THIRTY_DAYS : 三十日   】 | "SINGLE_DAY" |
| profitLossRatioUpper | number(double) | 是 | 损益率上限 | 1 |
| profitLossRatioLower | number(double) | 是 | 损益率下限 | 1 |
| profitLossUpper | number(double) | 否 | 损益上限 | 1 |
| profitLossLower | number(double) | 否 | 损益下限 | 1 |

### com.leadwaycloud.rm.store.business.oil.dto.AddOilProfitLossConfigDTO$OilTypeGoodsDTO

油品类型商品关联DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| oilType | string | 是 | 油品类型  【 GASOLINE : 汽油   DIESEL : 柴油   】 | "GASOLINE" |
| dilatationCoefficient | number(double) | 是 | 膨胀系数 | 1 |
| goods | string | 是 | 关联商品 | "1" |

### 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" |

### 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 |

### com.leadwaycloud.rm.store.business.oil.dto.FuelServerDataAddDTO

fuelServer数据添加模型

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 数据类型  【 TANK_READING : 油罐读数   NOZZLE_READING : 油枪读数   】 |  |
| data | string | 是 | 数据 |  |

### com.leadwaycloud.rm.store.business.oil.dto.AddOilFuelServerConfigDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 否 |  |  |
| host | string | 否 |  |  |
| serverPath | string | 否 |  |  |

### 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" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO

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

### com.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonRespVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| orderType | string | 是 | 类型 | "SALE" |
| reason | string | 是 | 交易理由 |  |
| createBy | integer(int64) | 否 | 创建人 | 1 |
| createTime | string | 否 | 创建时间 | "2020-09-01 11:01:1" |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.store.business.trade.reason.vo.TradeReasonListRespVO

当前页数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| orderType | string | 是 | 类型 | "SALE" |
| reason | string | 是 | 交易理由 |  |
| createBy | integer(int64) | 否 | 创建人 | 1 |
| createTime | string | 否 | 创建时间 | "2020-09-01 11:01:1" |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.String

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmStoreServer

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmRestaurantTable

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### 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 | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

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

### com.leadwaycloud.rm.store.business.merchant.config.vo.MerchantConfigResponseVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| config | string | 是 | 商户零管配置 |  |
| createBy | integer(int64) | 否 | 创建人 | 1 |
| createTime | string | 否 | 创建时间 | "2020-09-01 11:01:1" |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

门店/库位（stock_warehouse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | ID | 1001 |
| code | string | 否 | 编码 | "STORE-001" |
| name | string | 否 | 名称 |  |
| type | string | 否 | 类型 WAREHOUSE\|LOCATION\|LOCATION_OIL |  |
| parentId | integer(int64) | 否 | 父级 ID |  |
| status | string | 否 | 状态（ERP 实体无此字段时为 null） |  |
| companyId | integer(int64) | 否 | 公司 ID |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.WarehouseDto

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

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutTemplateSummaryDto

布局模板摘要

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| description | string | 否 |  |  |
| category | string | 否 |  |  |
| status | string | 否 |  |  |
| floorWidth | number | 否 |  |  |
| floorDepth | number | 否 |  |  |
| sourceLayoutId | integer(int64) | 否 |  |  |
| thumbnailUrl | string | 否 |  |  |
| hasSceneGraph | boolean | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.LayoutSummaryDto

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 否 |  |  |
| code | string | 否 |  |  |
| name | string | 否 |  |  |
| versionNo | integer(int32) | 否 |  |  |
| status | string | 否 | 布局生命周期状态 |  |
| floorWidth | number | 否 |  |  |
| floorDepth | number | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto

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

### com.leadwaycloud.rm.store.business.storelayout.dto.PlanogramIssueDto

Planogram 合规校验问题项

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| ruleCode | string | 否 | 规则编码 | "QUANTITY_MISMATCH" |
| severity | string | 否 | 严重级别 ERROR\|WARN\|INFO | "ERROR" |
| message | string | 否 | 问题描述 | "槽位件数与排面三要素不一致" |
| shelfId | integer(int64) | 否 | 货架 ID | 501 |
| shelfCode | string | 否 | 货架编码 | "S001" |
| layerNo | integer(int32) | 否 | 层号 | 2 |
| slotIndex | integer(int32) | 否 | 槽位序号 | 0 |
| goodsCode | string | 否 | 货号 | "GD-001" |

### com.leadwaycloud.rm.store.business.storelayout.dto.PlanogramValidationResultDto

Planogram 合规校验结果

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| layoutId | integer(int64) | 否 | 布局 ID | 1 |
| passed | boolean | 否 | 是否通过（无 ERROR 级问题） | true |
| errorCount | integer(int32) | 否 | ERROR 数量 | 0 |
| warnCount | integer(int32) | 否 | WARN 数量 | 1 |
| infoCount | integer(int32) | 否 | INFO 数量 | 0 |
| issues | PlanogramIssueDto[] | 否 | 问题明细 |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto

商品条码（stock_goods_barcode）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 条码 ID | 4001 |
| barcode | string | 否 | 条码值 | "690000000001" |
| type | string | 否 | 条码类型 | "EAN13" |
| defSettlement | boolean | 否 | 是否默认结算码 |  |
| spec | string | 否 | 规格 |  |

### com.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

商品信息（stock_goods），含条码列表

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 商品 ID | 3001 |
| code | string | 否 | 货号 | "GD-001" |
| name | string | 否 | 商品名称 | "示例可乐 330ml" |
| spec | string | 否 | 规格 | "330ml" |
| type | string | 否 | 生产类型 INGREDIENT\|PREPARE\|PRODUCT | "PRODUCT" |
| mark | string | 否 | 标记 ENERGY\|CLOTHING\|CUSTOMIZE 等 | "CUSTOMIZE" |
| categoryId | integer(int64) | 否 | 分类 ID | 101 |
| brandId | integer(int64) | 否 | 品牌 ID | 201 |
| images | string | 否 | 图片 URL |  |
| barcodes | GoodsBarcodeDto[] | 否 | 关联条码列表 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsDto

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.storelayout.dto.GoodsBarcodeDto

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

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayout

门店布局主表（store_layout）。站点级 3D 设计，仓库绑定在 layout_zone。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAssetPreset

门店 3D 资产预设（store_asset_preset）。商户级资产库，各门店共享可复用组件模板。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 | 是 | 资产预设状态 |  |

### 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 |

### 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 | 否 |  |  |

### com.leadwaycloud.rm.common.model.po.entity.StockGoodsBrand

商品品牌

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| code | string | 是 | 编号 | "xxx" |
| name | string | 是 | 名称 | "xxx" |
| description | string | 否 | 描述 |  |
| images | string | 否 | 图片 |  |
| status | string | 是 | 状态  【 ACTIVE : 可用   DEACTIVATE : 停用   DELETE : 删除   】 | "ACTIVE" |
| cooperative | boolean | 否 | 是否合作品牌 | false |

### com.leadwaycloud.rm.common.model.po.entity.StockGoodsCategory

商品分类

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | "EN13" |
| code | string | 是 | 编号 | "C01" |
| status | string | 是 | 状态  【 ACTIVE : 可用   DEACTIVATE : 停用   DELETE : 删除   】 | "ACTIVE" |
| parentId | integer(int64) | 是 | 上级商品分类ID | 1 |
| idChain | string | 是 | 完整的组织结构 | "600556150271616" |
| images | string | 否 | 图片 |  |
| boutique | boolean | 否 | 是否在商城展示 | false |
| description | string | 否 | 描述 |  |

### com.leadwaycloud.rm.common.model.po.entity.StockGoodsEnergy

商品能源属性

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| goodsId | integer(int64) | 是 | 商品 |  |
| type | string | 是 | 能源商品类型  【 OIL : 石油   NATURAL_GAS : 天然气   ELECTRICITY : 电   UREA : 尿素   】 | "OIL" |

### com.leadwaycloud.rm.common.model.po.entity.SysUom

计量单位

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| code | string | 是 | 编号 | "1" |
| name | string | 是 | 名称 | "公斤" |
| shortName | string | 否 | 简称 |  |
| isoShortName | string | 否 | IOS简称 |  |
| symbol | string | 是 | 符号 | "kg" |
| active | boolean | 是 | 是否可用 | true |
| ratio | number(double) | 否 | 换算率 | 1000 |

### 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 | 否 | 规格 |  |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutZone

布局销售区域（layout_zone）。支持矩形或多边形，可绑定 ERP 仓库/门店（WAREHOUSE）。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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" |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutTemplate

布局模板（layout_template）。保存完整 scene_graph，支持复制到新门店。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelf

门店货架（layout_shelf）。可绑定 ERP 库位，含尺寸、位置与层数。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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" |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutShelfLayer

货架层（layout_shelf_layer）。定义层号、层板高度与 WMS 拣货优先级。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutGoodsSlot

货架层商品排面槽位，对应零售 Planogram 单格陈列单元

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreLayoutAisle

门店通道（layout_aisle）。定义顾客动线，含起止点与通道宽度。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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" |

### com.leadwaycloud.rm.store.model.po.entity.RmStoreAuditLog

操作审计日志（audit_log）。记录布局/模板/排面等资源的业务操作轨迹。

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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) | 是 | 创建时间 |  |

### 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[] | 否 | 返回数据 |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrinter

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePrintTemplate

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.common.model.po.entity.ResUser

用户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| userName | string | 是 | 账号 | "kunliang.zeng@leadwaycloud.com" |
| name | string | 是 | 名称 | "曾锟亮" |
| status | string | 是 | 状态  【 ACTIVE : 活跃   BLOCK : 锁定   DELETE : 删除   INACTIVATED : 未激活   FREEZE : 冻结   】 |  |
| auditStatus | string | 否 | 用户审核状态  【 PENDING_REVIEW :    APPROVEING :    APPROVEDONE :    】 |  |
| partnerId | integer(int64) | 是 | 关系ID |  |
| idaasId | string | 否 | IDaas用户ID |  |
| externalCode | string | 否 | 外部编号 |  |

### com.leadwaycloud.rm.store.model.po.entity.RmGoodsUpdateNotifyPos

零管商品变更通知机台

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| devicePosId | integer(int64) | 是 | 设备机台ID | 1 |
| updateType | string | 是 | 变更类型  【 ERP_UPDATE : ERP商品基础信息变更   RM_UPDATE : 零管商品信息变更   】 | "RM_UPDATE" |
| updateUser | ResUser | 是 |  |  |
| updateData | string | 否 | 变更数据 |  |
| notified | boolean | 是 | 是否已经通知 | false |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse

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

### com.leadwaycloud.rm.store.business.pos.dto.PosBusinessInfoResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessDate | string | 是 | 营业日 | "2020-10-11" |
| shiftNo | integer(int64) | 是 | 班次号 | 1 |
| pkNo | integer(int64) | 是 | 交易流水号 | 1 |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePos

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.RmDevicePosGroup

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilTankReading

油罐读数

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| 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） | "MANUAL" |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.rm.store.business.oil.vo.OilTankListVO

油罐列表项（含规格属性）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 油罐ID |  |
| companyId | integer(int64) | 否 | 公司ID |  |
| code | string | 否 | 油罐编号 |  |
| name | string | 否 | 油罐名称 |  |
| stockWarehouseId | integer(int64) | 否 | 仓库ID |  |
| goodsId | integer(int64) | 否 | 绑定油品ID |  |
| maxVolume | number(double) | 否 | 最大体积 |  |
| alarmVolume | number(double) | 否 | 警戒体积 |  |
| specification | EnergyOilTankSpecification | 否 |  |  |

### 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[] | 否 | 返回数据 |  |

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.rm.store.business.oil.vo.OilProfitLossConfigVO

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

### com.leadwaycloud.rm.store.business.oil.vo.OilProfitLossConfigVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| oilProfitLossConfigList | AddOilProfitLossConfigDTO$OilProfitLossDTO | 是 |  |  |
| oilTypeGoodsConfigList | AddOilProfitLossConfigDTO$OilTypeGoodsDTO | 是 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.store.model.po.entity.EnergyOilNozzleReading

油枪读数

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| 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） | "MANUAL" |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |
| transactionNo | string | 否 | fuelServer交易号 | "1" |
| startTotal | number(double) | 否 | 起码 | 1 |
| endTotal | number(double) | 否 | 止码 | 1 |
| startTime | string | 否 | 读数时间 | "2026-06-01 10:09:11" |
| endTime | string | 否 | 读数时间 | "2026-06-01 10:09:11" |
| amount | number(double) | 否 | 加油金额 | 1 |
| unitPrice | number(double) | 否 | 加油金额 | 1 |
| nozzleCode | string | 否 | 枪号 | "1" |
| pumpCode | string | 否 | 泵号 | "1" |
| tankCode | string | 否 | 罐号 | "1" |

### com.leadwaycloud.core.model.RJava.lang.Object

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmCashier

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.rm.store.business.trade.reason.dto.TradeReasonDeleteReqDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tradeReasonList | integer(int64)[] | 否 | 需要删除的交易理由,不传则删除商户下所有 | [] |

### com.leadwaycloud.core.model.R

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

