# lwc-cloud-erp-data-broadcast API 接口文档

- 文档标题：lwc-cloud-erp-data-broadcast
- 版本：1.0.0
- 描述：LWC Cloud API接口文档
- 数据来源：https://api.leadwaycloud.com/lwc-cloud-erp-data-broadcast/v3/api-docs
- 生成时间：2026-08-03T22:00:03.100Z
- 接口数量：11
- 分组数量：3
- 模型数量：5

## 服务地址

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

## 接口目录

### 公共接口

- [POST /api/common/get/properties/{channel}/{method} - 查询渠道推送方式配置接口](#post-api-common-get-properties-channel-method-databroadcast)
- [POST /api/common/data-broadcast/{merchantId} - 批量数据推送接口](#post-api-common-data-broadcast-merchantid-databroadcast-1)

### 服务监控管理

- [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-2)
- [PUT /error ](#put-error-handleerror-3)
- [DELETE /error ](#delete-error-handleerror-5)
- [PATCH /error ](#patch-error-handleerror-4)
- [OPTIONS /error ](#options-error-handleerror-6)
- [HEAD /error ](#head-error-handleerror-1)


## 接口详情

<a id="post-api-common-get-properties-channel-method-databroadcast"></a>

### POST /api/common/get/properties/{channel}/{method}

- 分组：公共接口
- 名称：查询渠道推送方式配置接口
- OperationId：dataBroadcast

#### 调用方法

`POST /api/common/get/properties/{channel}/{method}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| channel | path | 是 | string | 渠道 | "hht" |
| method | path | 是 | string | 推送方式 | "RABBIT_MQ" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Object（com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Object）

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

<a id="post-api-common-data-broadcast-merchantid-databroadcast-1"></a>

### POST /api/common/data-broadcast/{merchantId}

- 分组：公共接口
- 名称：批量数据推送接口
- OperationId：dataBroadcast_1

#### 调用方法

`POST /api/common/data-broadcast/{merchantId}`

#### 参数

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

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UnpromptedPushDTO[]（com.leadwaycloud.data.broadcast.model.dto.UnpromptedPushDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | UnpromptedPushDTO[] |  |  |  |

#### 响应


- 状态码：`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-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-2"></a>

### POST /error

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

#### 调用方法

`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-3"></a>

### PUT /error

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

#### 调用方法

`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-5"></a>

### DELETE /error

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

#### 调用方法

`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-1"></a>

### HEAD /error

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

#### 调用方法

`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.core.model.RJava.util.MapJava.lang.StringJava.lang.Object

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

### com.leadwaycloud.data.broadcast.model.dto.UnpromptedPushDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pushType | string | 是 | 推送类型  【 ENERGY_OIL_TANK : 油罐(提供energy_oil_tank表ID)   ENERGY_OIL_PUMP : 油泵(提供energy_oil_pump表ID)   ENERGY_OIL_NOZZLE : 油枪(提供energy_oil_nozzle表ID)   FINANCE_TAX : 税(提供finance_tax表ID)   CRM_SUPPLIER : 供应商(提供crm_supplier表ID)   RES_REASON_CODE : 原因码(提供res_reason_code表ID)   SYS_UOM : 计量单位变动(提供sys_uom表ID)   STOCK_GOODS : 商品(提供stock_goods表ID)   STOCK_GOODS_CATEGORY : 商品分类(提供stock_goods_category表ID)   STOCK_WAREHOUSE : 仓库(提供stock_warehouse表ID)   STOCK_GOODS_SUPPLIER : 零管供应商关系变动(提供stock_goods_supplier表ID)   RM_GOODS : 零管商品(提供rm_item表ID)   RM_GOODS_BARCODE : 零管商品(提供rm_item_barcode表ID)   RM_GOODS_PRICE_ADJUST_PLAN_DETAIL : 零管商品变价计划(提供rm_goods_price_adjust_plan_detail表ID)   RM_CASHIER : 零管收银员(提供rm_cashier表ID)   RM_DEVICE_POS : 零管机台(提供rm_device_pos表ID)   RM_RESTAURANT : 零管餐厅(提供rm_restaurant表ID)   RM_TENDER : 零管支付方式(提供rm_tender表ID)   GOODS_STOCK : 商品库存(提供stock_goods_barcode表ID)仅在手工推送使用   SPEC_SETTING : 门店特殊设置(提供res_company表ID)仅在手工推送使用   CLEAR_STOCK_GOODS : 清除商品(提供stock_goods表ID)仅在手工推送使用   CLEAR_STOCK_GOODS_CATEGORY : 清除商品分类(提供stock_goods_category表ID)仅在手工推送使用   CLEAR_GOODS_STOCK : 清除商品库存(提供stock_goods表ID)仅在手工推送使用   】  【 ENERGY_OIL_TANK : 油罐(提供energy_oil_tank表ID)   ENERGY_OIL_PUMP : 油泵(提供energy_oil_pump表ID)   ENERGY_OIL_NOZZLE : 油枪(提供energy_oil_nozzle表ID)   FINANCE_TAX : 税(提供finance_tax表ID)   CRM_SUPPLIER : 供应商(提供crm_supplier表ID)   RES_REASON_CODE : 原因码(提供res_reason_code表ID)   SYS_UOM : 计量单位变动(提供sys_uom表ID)   STOCK_GOODS : 商品(提供stock_goods表ID)   STOCK_GOODS_CATEGORY : 商品分类(提供stock_goods_category表ID)   STOCK_WAREHOUSE : 仓库(提供stock_warehouse表ID)   STOCK_GOODS_SUPPLIER : 零管供应商关系变动(提供stock_goods_supplier表ID)   RM_GOODS : 零管商品(提供rm_item表ID)   RM_GOODS_BARCODE : 零管商品(提供rm_item_barcode表ID)   RM_GOODS_PRICE_ADJUST_PLAN_DETAIL : 零管商品变价计划(提供rm_goods_price_adjust_plan_detail表ID)   RM_CASHIER : 零管收银员(提供rm_cashier表ID)   RM_DEVICE_POS : 零管机台(提供rm_device_pos表ID)   RM_RESTAURANT : 零管餐厅(提供rm_restaurant表ID)   RM_TENDER : 零管支付方式(提供rm_tender表ID)   GOODS_STOCK : 商品库存(提供stock_goods_barcode表ID)仅在手工推送使用   SPEC_SETTING : 门店特殊设置(提供res_company表ID)仅在手工推送使用   CLEAR_STOCK_GOODS : 清除商品(提供stock_goods表ID)仅在手工推送使用   CLEAR_STOCK_GOODS_CATEGORY : 清除商品分类(提供stock_goods_category表ID)仅在手工推送使用   CLEAR_GOODS_STOCK : 清除商品库存(提供stock_goods表ID)仅在手工推送使用   】 | "ENERGY_OIL_TANK" |
| companyList | integer(int64)[] | 否 | 公司ID集合(当推送类型可指定公司时，未填则推送所有公司) | [1] |
| dataList | integer(int64)[] | 否 | 数据ID集合(未填则推送所有，当推送类型可指定公司时推送的是当前门店的全部该类型数据) | [1] |

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

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

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

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

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

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