服务地址
| 地址 | 说明 |
|---|
| http://localhost:8080 | 开发环境 |
| https://api.leadwaycloud.com | 测试环境 |
接口详情
PUT
/api/rm-goods-category/update/{categoryId}
零管商品分类业务接口
修改零管商品分类接口
OperationId: updateRmGoodsCategory
调用方法
PUT /api/rm-goods-category/update/{categoryId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| categoryId | path | 是 | integer(int64) | 零管商品分类ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateRmGoodsCategoryDTO com.leadwaycloud.rm.goods.business.category.model.dto.UpdateRmGoodsCategoryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| channel | string | 否 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| name | string | 否 | 名称 | "EN13" |
| parentId | integer(int64) | 否 | 上级商品分类ID | 1 |
| images | string | 否 | 图片 | |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategory com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmGoodsCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategory | 否 | | |
PUT
/api/rm-goods-category/unbind-item/{categoryId}
零管商品分类业务接口
零管商品分类解绑零管商品接口
OperationId: unbindItem
调用方法
PUT /api/rm-goods-category/unbind-item/{categoryId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| categoryId | path | 是 | integer(int64) | 零管商品分类ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/rm-goods-category/unbind-category/{itemId}
零管商品分类业务接口
零管商品解绑零管商品分类接口
OperationId: unbindCategory
调用方法
PUT /api/rm-goods-category/unbind-category/{itemId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| itemId | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/rm-goods-category/sort/{categoryId}/{active}
零管商品分类业务接口
同级零管商品分类排序接口
OperationId: sortSameLevelRmGoodsCategory
调用方法
PUT /api/rm-goods-category/sort/{categoryId}/{active}
参数
无
请求体
Content-Type: application/json 必填: 是 类型: SortRmGoodsCategoryDTO[] com.leadwaycloud.rm.goods.business.category.model.dto.SortRmGoodsCategoryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | SortRmGoodsCategoryDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/rm-goods-category/operation/{categoryId}/{active}
零管商品分类业务接口
零管商品分类启/停用接口
OperationId: operationRmGoodsCategory
启用则向上冒泡,停用则向下同步
调用方法
PUT /api/rm-goods-category/operation/{categoryId}/{active}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| categoryId | path | 是 | integer(int64) | 零管商品分类ID | 1 |
| active | path | 是 | boolean | 是否启用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/rm-goods-category/bind-item/single/{categoryId}
零管商品分类业务接口
零管商品分类绑定零管商品(支持零管商品仅绑定一个分类)接口
OperationId: bindItemForSingle
调用方法
PUT /api/rm-goods-category/bind-item/single/{categoryId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| categoryId | path | 是 | integer(int64) | 零管商品分类ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/rm-goods-category/bind-category/single/{itemId}/{categoryId}
零管商品分类业务接口
零管商品绑定零管商品分类(支持零管商品仅绑定一个分类)接口
OperationId: bindCategoryForSingle
调用方法
PUT /api/rm-goods-category/bind-category/single/{itemId}/{categoryId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| itemId | path | 是 | integer(int64) | 零管商品ID | 1 |
| categoryId | path | 是 | integer(int64) | 零管商品分类ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/api/item/update/status/{id}
零管商品管理接口
变更零管商品状态接口
OperationId: updateStatus
调用方法
PUT /api/item/update/status/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: string
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
PUT
/api/item/update/graphic-text/{id}
零管商品管理接口
变更零管商品图文接口
OperationId: updateDetailContent
调用方法
PUT /api/item/update/graphic-text/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateItemGraphicTextDTO com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateItemGraphicTextDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsDetailGraphicText | string | 否 | 商品图文(未作修改请不传) | |
| goodsServerGraphicText | string | 否 | 商品服务图文(未作修改请不传) | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
PUT
/api/item/update/detail-content/{id}
零管商品管理接口
变更零管商品详情图文接口
OperationId: updateDetailContent_1
调用方法
PUT /api/item/update/detail-content/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
Content-Type: application/json 必填: 否 类型: string
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
PUT
/api/item-shelf/on-shelf
零管商品货架管理接口
上架零管商品接口
OperationId: onShelf
调用方法
PUT /api/item-shelf/on-shelf
参数
无
请求体
Content-Type: application/json 必填: 是 类型: RmItemShelvesDTO com.leadwaycloud.rm.goods.business.history.model.DTO.RmItemShelvesDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| rmItemIdList | integer(int64)[] | 否 | 零管商品ID(如果为null则上/下架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/api/item-shelf/off-shelf
零管商品货架管理接口
下架零管商品接口
OperationId: offShelf
调用方法
PUT /api/item-shelf/off-shelf
参数
无
请求体
Content-Type: application/json 必填: 是 类型: RmItemShelvesDTO com.leadwaycloud.rm.goods.business.history.model.DTO.RmItemShelvesDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| rmItemIdList | integer(int64)[] | 否 | 零管商品ID(如果为null则上/下架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/api/item-shelf/append/shelf-qty/{id}
零管商品货架管理接口
-
OperationId: appendShelfQty
调用方法
PUT /api/item-shelf/append/shelf-qty/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: integer(int32)
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/api/goods-presale-active/stop/{id}
商品预售活动管理接口
停用活动
OperationId: stop
调用方法
PUT /api/goods-presale-active/stop/{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 | 否 | 返回数据 | |
PUT
/api/goods-presale-active/start-using/{id}
商品预售活动管理接口
启用活动
OperationId: startUsing
调用方法
PUT /api/goods-presale-active/start-using/{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 | 否 | 返回数据 | |
PUT
/api/goods-adjust-price/update/{id}
商品零售价格调整计划管理接口
修改商品零售价格调整计划接口
OperationId: update
调用方法
PUT /api/goods-adjust-price/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商品零售价格调整计划ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateGoodsPriceAdjustPlanDTO com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateGoodsPriceAdjustPlanDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 否 | 调整类型 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| goodsPriceAdjustPlanDetailList | AddGoodsPriceAdjustPlanDetailDTO[] | 否 | 零管商品条码价格调整计划详情 | |
| remarks | string | 否 | 备注 | "..." |
| isFuel | boolean | 否 | 是否油品变价单 | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
PUT
/api/goods-adjust-price/stop/{id}
商品零售价格调整计划管理接口
停用商品零售价格调整计划接口
OperationId: stop_1
调用方法
PUT /api/goods-adjust-price/stop/{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 | 否 | 返回数据 | |
PUT
/api/goods-adjust-price/start-using/{id}
商品零售价格调整计划管理接口
启用商品零售价格调整计划接口
OperationId: startUsing_1
调用方法
PUT /api/goods-adjust-price/start-using/{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 | 否 | 返回数据 | |
PUT
/api/goods-adjust-price/instancy-stop/{id}
商品零售价格调整计划管理接口
紧急终止商品零售价格调整计划接口(执行中的变价计划通过该功能可以提前回滚价格)
OperationId: instancyStop
调用方法
PUT /api/goods-adjust-price/instancy-stop/{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 | 否 | 返回数据 | |
PUT
/api/barcode/update/{id}
零管商品条码管理接口
修改零管商品条码接口
OperationId: update_3
调用方法
PUT /api/barcode/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateRmItemBarcodeDTO com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateRmItemBarcodeDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| checkStock | boolean | 否 | 是否检查库存 | false |
| price | number(double) | 否 | 售价 | 100 |
| shelfQty | number(double) | 否 | 上架数量(此数量不作为商品库存数量。在渠道销售终端不可展示。库存需在通过单独接口获取) | 100 |
| orderMinQty | number(double) | 否 | 单次最小购买数量 | 1 |
| orderMaxQty | number(double) | 否 | 单次最大购买数量 | 999999 |
| active | boolean | 否 | 是否可用 | false |
| spec | string | 否 | 规格 | "xxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcode com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItemBarcode
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcode | 否 | | |
POST
/api/rm-goods-category/create
零管商品分类业务接口
创建零管商品分类接口
OperationId: createRmGoodsCategory
调用方法
POST /api/rm-goods-category/create
参数
无
请求体
Content-Type: application/json 必填: 是 类型: CreateRmGoodsCategoryDTO com.leadwaycloud.rm.goods.business.category.model.dto.CreateRmGoodsCategoryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 574533689957252 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| name | string | 是 | 名称 | "日用百货" |
| parentId | integer(int64) | 否 | 上级商品分类ID | 1 |
| images | string | 否 | 图片 | |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategory com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmGoodsCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategory | 否 | | |
POST
/api/quick-item/save
零管POS首页快捷商品布局接口
保存POS首页快捷商品布局(按公司+渠道唯一,存在则更新)
OperationId: save
调用方法
POST /api/quick-item/save
参数
无
请求体
Content-Type: application/json 必填: 是 类型: SaveRmQuickItemLayoutDTO com.leadwaycloud.rm.goods.business.history.model.DTO.SaveRmQuickItemLayoutDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| itemsLayout | string | 是 | POS首页商品布局JSON | "{\"rows\":4,\"cols\":5,\"cells\":[]}" |
| active | boolean | 否 | 是否启用,默认 true | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmQuickItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmQuickItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmQuickItem | 否 | | |
POST
/api/item/query-list/{companyId}/{channel}
零管商品管理接口
查询零管商品(公司&渠道&商品ID集合)接口
OperationId: query
调用方法
POST /api/item/query-list/{companyId}/{channel}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| channel | path | 是 | integer(int64) | 渠道ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem[] | 否 | 返回数据 | |
POST
/api/item/query-by-change-order
零管商品管理接口
查询零管商品(变价单使用)
OperationId: queryByChangeOrder
调用方法
POST /api/item/query-by-change-order
参数
无
请求体
Content-Type: application/json 必填: 是 类型: QueryItemByChangeOrderDTO[] com.leadwaycloud.rm.goods.business.history.model.DTO.QueryItemByChangeOrderDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | QueryItemByChangeOrderDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ChangeOrderItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.history.model.VO.ChangeOrderItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ChangeOrderItemVO[] | 否 | 返回数据 | |
POST
/api/item/put/detail-content/to-other-channel/{id}
零管商品管理接口
-
OperationId: putDetailContentToOtherChannel
调用方法
POST /api/item/put/detail-content/to-other-channel/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: string[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | string[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/item/add
零管商品管理接口
添加零管商品接口
OperationId: add
调用方法
POST /api/item/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddItemDTO com.leadwaycloud.rm.goods.business.history.model.DTO.AddItemDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| stockGoodsId | integer(int64) | 是 | 商品ID | |
| companyGoodsId | integer(int64) | 是 | 公司商品ID | |
| detailContent | string | 否 | 详细内容(商品图文消息) | |
| serverContent | string | 否 | 服务内容(商品服务详情图文) | "..." |
| itemBarcodeList | AddItemBarcodeDTO[] | 否 | 条码 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
POST
/api/item/add-list
零管商品管理接口
批量添加零管商品接口(异步接口)
OperationId: add_1
调用方法
POST /api/item/add-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddItemDTO[] com.leadwaycloud.rm.goods.business.history.model.DTO.AddItemDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | AddItemDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/item-shelf/query/item-barcode-stock
零管商品货架管理接口
查询零管商品条码线上库存接口
OperationId: queryItemBarcodeStock
调用方法
POST /api/item-shelf/query/item-barcode-stock
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/api/goods/wrokflow/callback
零管商品模块审核业务接口
Workflow任务回调
OperationId: callback
调用方法
POST /api/goods/wrokflow/callback
参数
无
请求体
Content-Type: application/json 必填: 是 类型: WorkflowDTO$CallbackDTO com.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$CallbackDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 否 | 商户ID | |
| submitBy | string | 否 | 当前 审批人/操作人 | |
| businessTypeKey | string | 是 | 业务唯一key | |
| businessId | string | 是 | 业务ID | |
| taskId | string | 否 | 节点实例任务ID | |
| serviceName | string | 否 | 回调服务名 | |
| function | string | 是 | 具体执行方法(自定义配置,可缺省) | |
| businessData | object | 否 | 业务数据(发起时业务、审批中特有变量 并集) | |
| instanceState | string | 是 | 实例状态(pass, reject, terminate) | |
| terminationRemark | string | 否 | 消息 | |
| body | object | 否 | 自定义配置数据 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: WorkflowDTO$ReturnDTO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | WorkflowDTO$ReturnDTO | 否 | | |
POST
/api/goods/verify
零管商品模块审核业务接口
申请单发起审核接口
OperationId: verifyOrder
调用方法
POST /api/goods/verify
参数
无
请求体
Content-Type: application/json 必填: 是 类型: GoodsVerifyReqDTO com.leadwaycloud.rm.goods.business.verify.model.GoodsVerifyReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| applyId | integer(int64) | 是 | 上下架申请单ID | 1 |
| verifyType | string | 是 | 审核类别 【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核 】 | "BARCODE_ON_SHELF" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods/verify/result-hand-enter
零管商品模块审核业务接口
审批结果手工录入
OperationId: verifyResultHandEnter
调用方法
POST /api/goods/verify/result-hand-enter
参数
无
请求体
Content-Type: application/json 必填: 是 类型: GoodsVerifyResultDTO com.leadwaycloud.rm.goods.business.verify.model.GoodsVerifyResultDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| applyId | integer(int64) | 是 | 申请单ID | 1 |
| businessKey | string | 是 | 业务类型 | "xxx" |
| pass | boolean | 是 | 是否通过 | false |
| notice | string | 否 | 审核结果描述 | "xxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: WorkflowDTO$ReturnDTO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.openfeign.workflow.model.WorkflowDTO$ReturnDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | WorkflowDTO$ReturnDTO | 否 | | |
POST
/api/goods-presale-active/update/{id}
商品预售活动管理接口
编辑商品预售活动
OperationId: update_4
调用方法
POST /api/goods-presale-active/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateGoodsPresaleActiveDTO com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateGoodsPresaleActiveDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | "预售活动" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| joinCompany | integer(int64)[] | 否 | 参与公司 | [1] |
| deliveryMode | object | 否 | 发货方式(供应商自提点自提包含自提点信息) | {} |
| description | string | 否 | 描述 | |
| addGoodsPresaleActiveLineList | AddGoodsPresaleActiveLineDTO[] | 否 | 添加预售活动明细 | |
| deleteLineIdList | integer(int64)[] | 否 | 删除活动明细行ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/api/goods-presale-active/postpone/{id}
商品预售活动管理接口
活动延期
OperationId: postpone
调用方法
POST /api/goods-presale-active/postpone/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 活动ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateGoodsPresaleActiveDTO com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateGoodsPresaleActiveDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | "预售活动" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| joinCompany | integer(int64)[] | 否 | 参与公司 | [1] |
| deliveryMode | object | 否 | 发货方式(供应商自提点自提包含自提点信息) | {} |
| description | string | 否 | 描述 | |
| addGoodsPresaleActiveLineList | AddGoodsPresaleActiveLineDTO[] | 否 | 添加预售活动明细 | |
| deleteLineIdList | integer(int64)[] | 否 | 删除活动明细行ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-presale-active/add
商品预售活动管理接口
添加商品预售活动
OperationId: add_2
调用方法
POST /api/goods-presale-active/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddGoodsPresaleActiveDTO com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPresaleActiveDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | "预售活动" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| status | string | 是 | 状态 【 DRAFT : 草稿 PREPARING : 准备中 IN_EXECUTION : 执行中 COMPLETED : 已完成 TERMINATED : 已停用 DELETED : 已删除 】 | "DRAFT" |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| joinCompany | integer(int64)[] | 是 | 参与公司 | 1 |
| deliveryMode | object | 是 | 发货方式(供应商自提点自提包含自提点信息) | {} |
| createCompanyId | integer(int64) | 是 | 创建公司 | 1 |
| description | string | 否 | 描述 | |
| addGoodsPresaleActiveLineList | AddGoodsPresaleActiveLineDTO[] | 否 | 预售活动明细 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPresaleActive com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPresaleActive
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPresaleActive | 否 | | |
POST
/api/goods-item/update/sale-qty
零管商品业务接口
零管商品销量修改接口
OperationId: updateSaleQty
调用方法
POST /api/goods-item/update/sale-qty
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemUpdateSaleQtyDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemUpdateSaleQtyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 是 | 零管商品ID | 1 |
| saleQty | number(double) | 是 | 追加销售数量 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-item/update/name
零管商品业务接口
零管商品名称修改接口
OperationId: updateName
调用方法
POST /api/goods-item/update/name
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemUpdateNameDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemUpdateNameDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 是 | 零管商品ID | 1 |
| name | string | 是 | 名称 | "xxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-item/store/search-list
门店零管商品搜索接口
门店零管商品列表搜索接口
OperationId: searchItemForStore
调用方法
POST /api/goods-item/store/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreListItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.item.model.vo.StoreListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreListItemVO[] | 否 | 返回数据 | |
POST
/api/goods-item/smart-search/suggest
零管商品智慧搜索业务接口
零管商品智慧提示词搜索接口
OperationId: searchItem
调用方法
POST /api/goods-item/smart-search/suggest
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemSmartSearchForSuggestReqDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForSuggestReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 | "xxx" |
| keyword | string | 是 | 关键词 | "xxx" |
| size | integer(int32) | 否 | 搜索条数数 | 50 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.util.ListJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string[] | 否 | 返回数据 | |
POST
/api/goods-item/smart-search/hot-keyword
零管商品智慧搜索业务接口
零管商品智慧热词搜索接口
OperationId: searchItem_1
调用方法
POST /api/goods-item/smart-search/hot-keyword
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemSmartSearchForHotKeywordReqDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForHotKeywordReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| size | integer(int32) | 是 | 搜索个数(如过超过后台默认维护的最大个数则以后台最大个数为准) | 5 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.util.LinkedHashSetJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string[] | 否 | 返回数据 | |
POST
/api/goods-item/smart-search/full-text
零管商品智慧搜索业务接口
零管商品智慧全文搜索接口
OperationId: searchItem_2
调用方法
POST /api/goods-item/smart-search/full-text
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemSmartSearchForFullTextReqDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 | "xxx" |
| memberId | integer(int64) | 否 | 会员ID | 1 |
| keyword | string | 否 | 关键词 | "xxx" |
| brandList | integer(int64)[] | 否 | 品牌ID集合 | [] |
| categoryList | integer(int64)[] | 否 | 分类ID集合 | [] |
| rmCategoryList | integer(int64)[] | 否 | 零管分类ID集合 | [] |
| itemSpecMap | object | 否 | 规格 | {} |
| minPrice | string | 否 | 最小价格 | "1" |
| maxPrice | string | 否 | 最大价格 | "1000" |
| sortSaleQtyType | string | 否 | 销量排序类型 【 ASC : 升序 DESC : 降序 】 | "ASC" |
| sortPriceType | string | 否 | 价格排序类型 【 ASC : 升序 DESC : 降序 】 | "ASC" |
| page | integer(int32) | 否 | 搜索页码 | 0 |
| size | integer(int32) | 否 | 搜索页行数 | 50 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemSmartSearchForFullTextRespDTO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextRespDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemSmartSearchForFullTextRespDTO | 否 | | |
POST
/api/goods-item/search/import-result
零管商品扩展搜索接口
零管商品是否已经导入公司指定渠道校验
OperationId: searchCompanyGoodsImportResult
调用方法
POST /api/goods-item/search/import-result
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ItemImportResultSearchDTO com.leadwaycloud.rm.goods.business.item.model.dto.ItemImportResultSearchDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 | "xxx" |
| goodsList | integer(int64)[] | 否 | 商品集合 | [] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemImportResultVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.item.model.vo.ItemImportResultVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemImportResultVO[] | 否 | 返回数据 | |
POST
/api/goods-item/on-shelf/cache-async/{companyId}
零管商品业务接口
缓存公司已上架零管商品接口
OperationId: cacheCompanyOnShelfItem
调用方法
POST /api/goods-item/on-shelf/cache-async/{companyId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-item/mobile/search-list
移动端零管商品搜索接口
移动端零管商品列表搜索接口
OperationId: searchItemForMobile
调用方法
POST /api/goods-item/mobile/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: MobileListItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.item.model.vo.MobileListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MobileListItemVO[] | 否 | 返回数据 | |
POST
/api/goods-item/mall/search-list
商城零管商品搜索接口
商城零管商品列表搜索接口
OperationId: searchItemForMall
调用方法
POST /api/goods-item/mall/search-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| memberId | query | 否 | integer(int64) | 会员ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: MallListItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.item.model.vo.MallListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MallListItemVO[] | 否 | 返回数据 | |
POST
/api/goods-item/erp/search-list
ERP零管商品搜索接口
ERP零管商品列表搜索接口
OperationId: searchItemForERP
调用方法
POST /api/goods-item/erp/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpListItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.item.model.vo.ErpListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpListItemVO[] | 否 | 返回数据 | |
POST
/api/goods-item/cache-async
零管商品业务接口
缓存指定零管商品接口
OperationId: asyncCacheItem
调用方法
POST /api/goods-item/cache-async
参数
无
请求体
Content-Type: application/json 必填: 是 类型: CacheItemInfoReqDTO com.leadwaycloud.rm.common.business.goods.model.dto.CacheItemInfoReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemList | integer(int64)[] | 否 | 商品集合 | |
| companyId | integer(int64) | 否 | 公司ID | |
| channel | string | 否 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/update/shelf-qty
零管商品条码业务接口
零管商品条码线上库存数量修改接口
OperationId: updateShelfQty
调用方法
POST /api/goods-barcode/update/shelf-qty
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeSelfQtyUpdateReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeSelfQtyUpdateReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemBarcodeId | integer(int64) | 是 | 零管商品条码ID | 1 |
| type | integer(int32) | 是 | 类型 0:覆盖 1:追加 | 1 |
| shelfQty | number(double) | 是 | 库存数量 | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/store/search-list
门店零管商品条码搜索接口
门店零管商品条码列表搜索接口
OperationId: search
调用方法
POST /api/goods-barcode/store/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreListItemBarcodeVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.barcode.model.vo.StoreListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreListItemBarcodeVO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/shelf/search-processing-barcode
商品条码上下架业务接口
搜索正在处理中的零管商品条码ID
OperationId: filterProcessingBarcode
调用方法
POST /api/goods-barcode/shelf/search-processing-barcode
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64)[] | 否 | 返回数据 | |
POST
/api/goods-barcode/search/import-result
零管商品条码扩展搜索接口
搜索公司商品条码导入结果
OperationId: shearchCompanyGoodsBarcodeImportResult
调用方法
POST /api/goods-barcode/search/import-result
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeImportResultSearchDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeImportResultSearchDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 | "xxx" |
| barcodeList | integer(int64)[] | 否 | 条码集合 | [] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: BarcodeImportResultVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.barcode.model.vo.BarcodeImportResultVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | BarcodeImportResultVO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/search-price-list
零管商品条码扩展搜索接口
搜索零管商品条码价目表接口
OperationId: search_1
调用方法
POST /api/goods-barcode/search-price-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodePriceSearchDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodePriceSearchDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 是 | 零管商品ID | 1 |
| resources | string | 否 | 来源 【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城 】 | "MALL" |
| customerId | integer(int64) | 否 | 客户ID | 1 |
| customerContactPersonId | integer(int64) | 否 | 客户联系人ID | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsBarcodePriceListBO com.leadwaycloud.core.model.RJava.util.CollectionCom.leadwaycloud.rm.common.business.goods.model.bo.GoodsBarcodePriceListBO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsBarcodePriceListBO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/onshelf/update
商品条码上下架业务接口
商品条码上架申请修改接口
OperationId: updateOnshelfApply
调用方法
POST /api/goods-barcode/onshelf/update
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeOnShelfApplyUpdateReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeOnShelfApplyUpdateReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| applyId | integer(int64) | 是 | 申请ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| reason | string | 是 | 理由 | "xxx" |
| itemBarcodeList | integer(int64)[] | 是 | 零管商品条码ID(如果为null则上架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/onshelf/create
商品条码上下架业务接口
商品条码上架申请创建接口
OperationId: createOnshelfApply
调用方法
POST /api/goods-barcode/onshelf/create
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeOnShelfApplyCreateReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeOnShelfApplyCreateReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| reason | string | 是 | 理由 | "xxx" |
| itemBarcodeList | integer(int64)[] | 否 | 零管商品条码ID(如果为null则上架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/offshelf
商品条码上下架业务接口
商品条码下架申请创建接口
OperationId: createOffshelfApply
调用方法
POST /api/goods-barcode/offshelf
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeOffShelfApplyCreateReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeOffShelfApplyCreateReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| reason | string | 是 | 理由 | "xxx" |
| itemBarcodeList | integer(int64)[] | 否 | 零管商品条码ID(如果为null则下架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/offshelf/update
商品条码上下架业务接口
商品条码下架申请修改接口
OperationId: updateOffshelfApply
调用方法
POST /api/goods-barcode/offshelf/update
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeOffShelfApplyUpdateReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeOffShelfApplyUpdateReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| applyId | integer(int64) | 是 | 申请ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| channel | string | 否 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| reason | string | 否 | 理由 | "xxx" |
| itemBarcodeList | integer(int64)[] | 否 | 零管商品条码ID(如果为null则下架所有商品) | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/mobile/search-list
移动端零管商品条码搜索接口
移动端零管商品条码列表搜索接口
OperationId: search_2
调用方法
POST /api/goods-barcode/mobile/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: MobileListItemBarcodeVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.barcode.model.vo.MobileListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MobileListItemBarcodeVO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/mall/search-list
商城零管商品条码搜索接口
商城零管商品条码列表搜索接口
OperationId: search_3
调用方法
POST /api/goods-barcode/mall/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: MallListItemBarcodeVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.barcode.model.vo.MallListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MallListItemBarcodeVO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/import
零管商品条码业务接口
公司商品条码导入公司指定渠道
OperationId: importStockGoodsBarcode
控制只允许单个商品下的条码导入
调用方法
POST /api/goods-barcode/import
参数
无
请求体
Content-Type: application/json 必填: 是 类型: BarcodeImportReqDTO com.leadwaycloud.rm.goods.business.barcode.model.dto.BarcodeImportReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| rmItemNameMap | object | 否 | 零管商品名称,例:{商品ID:零管商品自定义名称} | {} |
| channelList | string[] | 是 | 渠道 | [] |
| barcodeList | BarcodeImportReqDTO$BarcodeImportDTO[] | 是 | 需要导入的商品条码 | [] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-barcode/erp/search-list
ERP零管商品条码搜索接口
ERP零管商品条码列表搜索接口
OperationId: search_4
调用方法
POST /api/goods-barcode/erp/search-list
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpListItemBarcodeVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.barcode.model.vo.ErpListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpListItemBarcodeVO[] | 否 | 返回数据 | |
POST
/api/goods-barcode/cache
零管商品条码业务接口
缓存指定零管商品条码接口
OperationId: cache
调用方法
POST /api/goods-barcode/cache
参数
无
请求体
Content-Type: application/json 必填: 是 类型: CacheBarcodeInfoReqDTO com.leadwaycloud.rm.common.business.goods.model.dto.CacheBarcodeInfoReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| barcodeList | integer(int64)[] | 否 | 条码集合 | |
| companyId | integer(int64) | 否 | 公司ID | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-adjust-price/verify
商品零售价格调整计划管理接口
门店审核变价接口
OperationId: reject
调用方法
POST /api/goods-adjust-price/verify
参数
无
请求体
Content-Type: application/json 必填: 是 类型: CompanyVerifyGoodsPriceAdjustPlanDTO com.leadwaycloud.rm.goods.business.history.model.DTO.CompanyVerifyGoodsPriceAdjustPlanDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsPriceAdjustPlanDetailList | integer(int64)[] | 是 | 变价计划明细ID集合 | [1] |
| isReject | boolean | 是 | 是否拒绝 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/api/goods-adjust-price/add
商品零售价格调整计划管理接口
添加商品零售价格调整计划接口
OperationId: add_3
调用方法
POST /api/goods-adjust-price/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddGoodsPriceAdjustPlanDTO com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustPlanDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| goodsPriceAdjustPlanDetailList | AddGoodsPriceAdjustPlanDetailDTO[] | 是 | 零管商品条码价格调整计划详情 | |
| remarks | string | 否 | 备注 | "..." |
| lastConfirmTime | string | 否 | 最后确认时间(必须小于开始调整时间半个小时) | "2020-10-11 13:09:11" |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
POST
/api/goods-adjust-price/add/goods-to-company
商品零售价格调整计划管理接口
添加商品零售价格调整计划(商品下发到公司)接口
OperationId: add_4
调用方法
POST /api/goods-adjust-price/add/goods-to-company
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddGoodsPriceAdjustByGoodsToCompanyDTO com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsToCompanyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 创建计划公司ID | 1 |
| goodsName | string | 是 | 商品名称 | "矿泉水" |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| detailList | AddGoodsPriceAdjustByGoodsToCompanyDetailDTO[] | 是 | 详情 | |
| remarks | string | 否 | 备注 | "..." |
| lastConfirmTime | string | 否 | 最后确认时间(必须小于开始调整时间半个小时) | "2020-10-11 13:09:11" |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
POST
/api/goods-adjust-price/add/goods-form-company
商品零售价格调整计划管理接口
添加商品零售价格调整计划(商品来源与公司)接口
OperationId: add_5
调用方法
POST /api/goods-adjust-price/add/goods-form-company
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddGoodsPriceAdjustByGoodsFormCompanyDTO com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsFormCompanyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 创建计划公司ID | 1 |
| companyId | integer(int64) | 是 | 公司ID(二选一) | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| detailList | AddGoodsPriceAdjustByGoodsFormCompanyDetailDTO[] | 是 | 详情 | |
| remarks | string | 否 | 备注 | "..." |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
POST
/api/barcode/query-sku
零管商品条码管理接口
查询零管商品条码SKU属性
OperationId: querySku
调用方法
POST /api/barcode/query-sku
参数
无
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: MultipleBarcodesSpecificationVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.MultipleBarcodesSpecificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MultipleBarcodesSpecificationVO | 否 | | |
POST
/api/barcode/add/{itemId}
零管商品条码管理接口
添加零管商品条码接口
OperationId: add_8
调用方法
POST /api/barcode/add/{itemId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| itemId | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: AddItemBarcodeDTO[] com.leadwaycloud.rm.goods.business.history.model.DTO.AddItemBarcodeDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | AddItemBarcodeDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcode com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmItemBarcode
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcode[] | 否 | 返回数据 | |
GET
/api/rm-goods-category/search/{id}
零管商品分类搜索接口
零管商品分类ID搜索接口
OperationId: searchCategory
调用方法
GET /api/rm-goods-category/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商品分类ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategoryRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.RmGoodsCategoryRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategoryRespVO | 否 | | |
GET
/api/rm-goods-category/search/chain/{idChain}
零管商品分类搜索接口
零管商品分类(id chain)搜索接口
OperationId: searchCategory_1
调用方法
GET /api/rm-goods-category/search/chain/{idChain}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| idChain | path | 是 | integer(int64) | ID链 | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CategoryVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.CategoryVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CategoryVO | 否 | | |
GET
/api/rm-goods-category/search-parallel-stratification
零管商品分类搜索接口
平行分层零管商品分类搜索接口
OperationId: searchCategoryForParallelStratification
调用方法
GET /api/rm-goods-category/search-parallel-stratification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "ONLINE" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategoryParallelStratificationVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.RmGoodsCategoryParallelStratificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategoryParallelStratificationVO | 否 | | |
GET
/api/rm-goods-category/search-page
零管商品分类搜索接口
零管商品分类分页搜索接口
OperationId: searchCategory_2
调用方法
GET /api/rm-goods-category/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "ONLINE" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategoryListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.category.model.vo.RmGoodsCategoryListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategoryListRespVO | 否 | | |
GET
/api/rm-goods-category/search-nesting-stratification
零管商品分类搜索接口
嵌套分层零管商品分类搜索接口
OperationId: searchCategoryForNestingStratification
调用方法
GET /api/rm-goods-category/search-nesting-stratification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "ONLINE" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategoryNestingStratificationVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.category.model.vo.RmGoodsCategoryNestingStratificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategoryNestingStratificationVO[] | 否 | 返回数据 | |
GET
/api/rm-goods-category/search-list
零管商品分类搜索接口
零管商品分类列表搜索接口
OperationId: searchCategory_3
调用方法
GET /api/rm-goods-category/search-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "ONLINE" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsCategoryListRespVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.category.model.vo.RmGoodsCategoryListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsCategoryListRespVO[] | 否 | 返回数据 | |
GET
/api/quick-item/query
零管POS首页快捷商品布局接口
查询POS首页快捷商品布局
OperationId: query_1
调用方法
GET /api/quick-item/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "ONLINE" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmQuickItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmQuickItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmQuickItem | 否 | | |
GET
/api/monitor/version
服务监控管理
获取服务版本信息
OperationId: version
调用方法
GET /api/monitor/version
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/monitor/health
服务监控管理
心跳检查
OperationId: health
调用方法
GET /api/monitor/health
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/api/item/query/{id}
零管商品管理接口
查询零管商品(ID)接口
OperationId: query_2
调用方法
GET /api/item/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
GET
/api/item/query/{companyId}/{channel}/{goodsId}
零管商品管理接口
查询零管商品(公司&渠道&商品ID)接口
OperationId: query_3
调用方法
GET /api/item/query/{companyId}/{channel}/{goodsId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| channel | path | 是 | integer(int64) | 渠道ID | 1 |
| goodsId | path | 是 | integer(int64) | 商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
GET
/api/item/query/company/channel/item-category/{merchantId}/{companyId}/{channel}
零管商品管理接口
查询零管商品分类接口(没有可用的商品(已上架且公司可操作的商品)则不被查询出来)
OperationId: queryItemCategory
调用方法
GET /api/item/query/company/channel/item-category/{merchantId}/{companyId}/{channel}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 1 |
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| channel | path | 是 | string | 渠道 | "POS" |
| parentGoodsCategoryId | query | 否 | integer(int64) | 上级商品分类ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StockGoodsCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.StockGoodsCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StockGoodsCategory[] | 否 | 返回数据 | |
GET
/api/item/query-page
零管商品管理接口
查询零管商品(分页)接口
OperationId: query_4
调用方法
GET /api/item/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "ONLINE" |
| goodsId | query | 否 | long | 商品ID | 1 |
| companyGoodsId | query | 否 | long | 公司商品ID | 1 |
| companyGoodsBarcodeStatus | query | 否 | string | 公司商品条码状态 | "ACTIVE" |
| itemBarcodeActive | query | 否 | boolean | 零管商品条码是否可用 | true |
| shelf | query | 否 | boolean | 是否上架 | false |
| status | query | 否 | string | 状态 | "ACTIVE" |
| categoryId | query | 否 | long | 商品分类 | 1 |
| categoryCode | query | 否 | string | 商品分类编号 | "C01" |
| text | query | 否 | string | 商品编码/商品条码/商品名称/商品标签 | "纸巾" |
| brandCode | query | 否 | string | 品牌编号 | "XXY" |
| itemIdList | query | 否 | List | 商品ID | |
| sortSaleQty | query | 否 | string | 是否根据销量排序 | "ACTIVE" |
| sortPriceType | query | 否 | string | 价格排序类型 | "ASC" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem | 否 | | |
GET
/api/item/query-page/update-log
零管商品管理接口
查询零管商品变更日志(分页)接口
OperationId: queryUpdateLog
调用方法
GET /api/item/query-page/update-log
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| itemId | query | 是 | long | 零管商品ID | 1 |
| updateType | query | 否 | string | 变更类型 | "UPDATE_CHANNEL" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemUpdateLog com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmItemUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemUpdateLog | 否 | | |
GET
/api/item/query-page-optimization
零管商品管理接口
分页零管商品数据查询接口(查询优化)
OperationId: optimizationItemPageQuery
调用方法
GET /api/item/query-page-optimization
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "ONLINE" |
| goodsId | query | 否 | long | 商品ID | 1 |
| companyGoodsId | query | 否 | long | 公司商品ID | 1 |
| companyGoodsBarcodeStatus | query | 否 | string | 公司商品条码状态 | "ACTIVE" |
| itemBarcodeActive | query | 否 | boolean | 零管商品条码是否可用 | true |
| shelf | query | 否 | boolean | 是否上架 | false |
| status | query | 否 | string | 状态 | "ACTIVE" |
| categoryId | query | 否 | long | 商品分类 | 1 |
| categoryCode | query | 否 | string | 商品分类编号 | "C01" |
| text | query | 否 | string | 商品编码/商品条码/商品名称/商品标签 | "纸巾" |
| brandCode | query | 否 | string | 品牌编号 | "XXY" |
| itemIdList | query | 否 | List | 商品ID | |
| sortSaleQty | query | 否 | string | 是否根据销量排序 | "ACTIVE" |
| sortPriceType | query | 否 | string | 价格排序类型 | "ASC" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemVO | 否 | | |
GET
/api/item/query-page-optimization/detail
零管商品管理接口
分页零管商品详情数据查询接口(查询优化)
OperationId: optimizationItemDetailPageQuery
调用方法
GET /api/item/query-page-optimization/detail
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "ONLINE" |
| goodsId | query | 否 | long | 商品ID | 1 |
| companyGoodsId | query | 否 | long | 公司商品ID | 1 |
| companyGoodsBarcodeStatus | query | 否 | string | 公司商品条码状态 | "ACTIVE" |
| itemBarcodeActive | query | 否 | boolean | 零管商品条码是否可用 | true |
| shelf | query | 否 | boolean | 是否上架 | false |
| status | query | 否 | string | 状态 | "ACTIVE" |
| categoryId | query | 否 | long | 商品分类 | 1 |
| categoryCode | query | 否 | string | 商品分类编号 | "C01" |
| text | query | 否 | string | 商品编码/商品条码/商品名称/商品标签 | "纸巾" |
| brandCode | query | 否 | string | 品牌编号 | "XXY" |
| itemIdList | query | 否 | List | 商品ID | |
| sortSaleQty | query | 否 | string | 是否根据销量排序 | "ACTIVE" |
| sortPriceType | query | 否 | string | 价格排序类型 | "ASC" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemDetailVO | 否 | | |
GET
/api/item/query-list
零管商品管理接口
查询零管商品(列表)接口(谨慎使用)
OperationId: query_5
调用方法
GET /api/item/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| arg0 | query | 是 | QueryRmItemDTO | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItem com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmItem
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItem[] | 否 | 返回数据 | |
GET
/api/item/query-goods-specification
零管商品管理接口
查询商品属性
OperationId: queryGoodsSpecification
调用方法
GET /api/item/query-goods-specification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| goodsId | query | 是 | integer(int64) | 商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemSpecificationVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.ItemSpecificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemSpecificationVO | 否 | | |
GET
/api/item/query-all/company/channel/item-category/{merchantId}/{companyId}/{channel}
零管商品管理接口
查询全部零管商品分类接口(没有可用的商品(已上架且公司可操作的商品)则不被查询出来)
OperationId: queryAllItemCategory
调用方法
GET /api/item/query-all/company/channel/item-category/{merchantId}/{companyId}/{channel}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 1 |
| companyId | path | 是 | integer(int64) | 公司ID | 1 |
| channel | path | 是 | string | 渠道 | "POS" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StockGoodsCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.StockGoodsCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StockGoodsCategory[] | 否 | 返回数据 | |
GET
/api/item/preloading
零管商品管理接口
预加载商品
OperationId: preloading
调用方法
GET /api/item/preloading
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| barcodeIdList | query | 是 | string | 条码集合 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64)[] | 否 | 返回数据 | |
GET
/api/item/pos-sync
零管商品提供POS同步商品主数据接口
POS同步商品查询接口
OperationId: queryItem
调用方法
GET /api/item/pos-sync
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| companyId | query | 是 | long | 公司ID | 948513515844539 |
| channel | query | 否 | string | 渠道 | "STORE_POS" |
| shelf | query | 否 | boolean | 是否上架 | false |
| itemIdList | query | 否 | List | 商品ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PosSyncItemResponse com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.PosSyncItemResponse
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PosSyncItemResponse | 否 | | |
GET
/api/item/pos-sync/simplify
零管商品提供POS同步商品主数据接口
POS同步商品(精简版本)查询接口
OperationId: querySimplifyItem
调用方法
GET /api/item/pos-sync/simplify
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| companyId | query | 是 | long | 公司ID | 948513515844539 |
| channel | query | 否 | string | 渠道 | "STORE_POS" |
| shelf | query | 否 | boolean | 是否上架 | false |
| itemIdList | query | 否 | List | 商品ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PosSyncSimplifyItemResponse com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemResponse
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PosSyncSimplifyItemResponse | 否 | | |
GET
/api/item/load-home-item
零管商品管理接口
加载商城首页商品
OperationId: loadHomeItem
调用方法
GET /api/item/load-home-item
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| barcodeIdList | query | 是 | string | 条码集合 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemBarcodeVO | 否 | | |
GET
/api/item-shelf/query/shelf-stock/{id}
零管商品货架管理接口
查询零管商品线上库存信息接口
OperationId: queryItemShelfStock
调用方法
GET /api/item-shelf/query/shelf-stock/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemStockVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.ItemStockVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemStockVO | 否 | | |
GET
/api/item-shelf/query/item-shelf-record/{id}
零管商品货架管理接口
查询零管商品上下线记录接口
OperationId: queryItemShelfRecord
调用方法
GET /api/item-shelf/query/item-shelf-record/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemShelfRecord com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmItemShelfRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemShelfRecord | 否 | | |
GET
/api/goods-presale-active/page
商品预售活动管理接口
商品预售活动列表(分页)
OperationId: query_6
调用方法
GET /api/goods-presale-active/page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| createCompanyId | query | 否 | long | 创建计划的公司ID | 1 |
| companyId | query | 否 | long | 参与活动公司ID | 1 |
| status | query | 否 | string | 状态 | ["DRAFT"] |
| time | query | 否 | string | 时间 | "2020-10-11 13:09:11" |
| name | query | 否 | string | 名称 | "活动名称" |
| supplierId | query | 否 | long | 供应商ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPresaleActive com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPresaleActive
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPresaleActive | 否 | | |
GET
/api/goods-presale-active/get/{id}
商品预售活动管理接口
查询商品预售活动详情
OperationId: get
调用方法
GET /api/goods-presale-active/get/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPresaleActive com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPresaleActive
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPresaleActive | 否 | | |
GET
/api/goods-item/store/search/{id}
门店零管商品搜索接口
门店零管商品ID搜索接口
OperationId: searchItemForStore_1
调用方法
GET /api/goods-item/store/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreDetailItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.item.model.vo.StoreDetailItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreDetailItemVO | 否 | | |
GET
/api/goods-item/store/search-page
门店零管商品搜索接口
门店零管商品分页搜索接口
OperationId: searchItemForStore_2
调用方法
GET /api/goods-item/store/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "xxx" |
| goods | query | 否 | string | 商品货号/条码 | "xxx" |
| brandId | query | 否 | long | 品牌ID | 1 |
| brandName | query | 否 | long | 品牌名称 | "xxx" |
| categoryId | query | 否 | long | 分类ID | 1 |
| categoryName | query | 否 | long | 分类名称 | "xxx" |
| rmCategoryId | query | 否 | long | 零管分类ID | 1 |
| rmCategoryName | query | 否 | long | 零管分类名称 | "xxx" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreListItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.item.model.vo.StoreListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreListItemVO | 否 | | |
GET
/api/goods-item/mobile/search-page
移动端零管商品搜索接口
移动端零管商品分页搜索接口
OperationId: searchItemForMobile_2
调用方法
GET /api/goods-item/mobile/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "xxx" |
| memberId | query | 否 | long | 会员ID | 1 |
| goods | query | 否 | string | 商品名称/货号/条码/分类名称/零管分类名称/品牌名称 | "xxx" |
| brandId | query | 否 | long | 品牌ID | 1 |
| categoryId | query | 否 | long | 分类ID | 1 |
| rmCategoryId | query | 否 | long | 零管分类ID | 1 |
| minPrice | query | 否 | string | 最小价格 | 1 |
| maxPrice | query | 否 | string | 最大价格 | 1000 |
| sortSaleQtyType | query | 否 | string | 销量排序类型 | "ASC" |
| sortPriceType | query | 否 | string | 价格排序类型 | "ASC" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MobileListItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.item.model.vo.MobileListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MobileListItemVO | 否 | | |
GET
/api/goods-item/mall/search-page
商城零管商品搜索接口
商城零管商品分页搜索接口
OperationId: searchItemForMall_2
调用方法
GET /api/goods-item/mall/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "xxx" |
| memberId | query | 否 | long | 会员ID | 1 |
| goods | query | 否 | string | 商品名称/货号/条码/分类名称/零管分类名称/品牌名称 | "xxx" |
| brandId | query | 否 | long | 品牌ID | 1 |
| categoryId | query | 否 | long | 分类ID | 1 |
| rmCategoryId | query | 否 | long | 零管分类ID | 1 |
| minPrice | query | 否 | string | 最小价格 | 1 |
| maxPrice | query | 否 | string | 最大价格 | 1000 |
| sortSaleQtyType | query | 否 | string | 销量排序类型 | "ASC" |
| sortPriceType | query | 否 | string | 价格排序类型 | "ASC" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MallListItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.item.model.vo.MallListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MallListItemVO | 否 | | |
GET
/api/goods-item/erp/search/{id}
ERP零管商品搜索接口
ERP零管商品ID搜索接口
OperationId: searchItemForERP_1
调用方法
GET /api/goods-item/erp/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpDetailItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.item.model.vo.ErpDetailItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpDetailItemVO | 否 | | |
GET
/api/goods-item/erp/search-page
ERP零管商品搜索接口
ERP零管商品分页搜索接口
OperationId: searchItemForERP_2
调用方法
GET /api/goods-item/erp/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "xxx" |
| shelf | query | 否 | boolean | 是否上架 | false |
| allowSale | query | 否 | boolean | 是否允许销售 | false |
| status | query | 否 | string | 状态 | "ACTIVE" |
| goods | query | 否 | string | 商品名称/货号/条码 | "xxx" |
| brandId | query | 否 | long | 品牌ID | 1 |
| brandName | query | 否 | long | 品牌名称 | "xxx" |
| categoryId | query | 否 | long | 分类ID | 1 |
| categoryName | query | 否 | long | 分类名称 | "xxx" |
| rmCategoryId | query | 否 | long | 零管分类ID | 1 |
| rmCategoryName | query | 否 | long | 零管分类名称 | "xxx" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpListItemVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.item.model.vo.ErpListItemVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpListItemVO | 否 | | |
GET
/api/goods-category/search/{id}
商品分类搜索接口
商品分类ID搜索接口
OperationId: searchCategory_4
调用方法
GET /api/goods-category/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商品分类ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsCategoryRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.GoodsCategoryRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsCategoryRespVO | 否 | | |
GET
/api/goods-category/search/chain/{idChain}
商品分类搜索接口
商品分类(id chain)搜索接口
OperationId: searchCategory_5
调用方法
GET /api/goods-category/search/chain/{idChain}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| idChain | path | 是 | integer(int64) | ID链 | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CategoryVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.CategoryVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CategoryVO | 否 | | |
GET
/api/goods-category/search-parallel-stratification
商品分类搜索接口
平行分层商品分类搜索接口
OperationId: searchCategoryForParallelStratification_1
调用方法
GET /api/goods-category/search-parallel-stratification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | long | 商户ID | "xxx" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| boutique | query | 否 | boolean | 是否在商城展示 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsCategoryParallelStratificationVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.category.model.vo.GoodsCategoryParallelStratificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsCategoryParallelStratificationVO | 否 | | |
GET
/api/goods-category/search-page
商品分类搜索接口
商品分类分页搜索接口
OperationId: searchCategory_6
调用方法
GET /api/goods-category/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | "xxx" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| boutique | query | 否 | boolean | 是否在商城展示 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsCategoryListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.category.model.vo.GoodsCategoryListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsCategoryListRespVO | 否 | | |
GET
/api/goods-category/search-nesting-stratification
商品分类搜索接口
嵌套分层商品分类搜索接口
OperationId: searchCategoryForNestingStratification_1
调用方法
GET /api/goods-category/search-nesting-stratification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | long | 商户ID | "xxx" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| boutique | query | 否 | boolean | 是否在商城展示 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsCategoryNestingStratificationVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.category.model.vo.GoodsCategoryNestingStratificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsCategoryNestingStratificationVO[] | 否 | 返回数据 | |
GET
/api/goods-category/search-list
商品分类搜索接口
商品分类列表搜索接口
OperationId: searchCategory_7
调用方法
GET /api/goods-category/search-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | long | 商户ID | "xxx" |
| goodsCategoryId | query | 否 | long | 商品分类ID(查询不含该分类下的子级分类) | 1 |
| queryLevel | query | 否 | int | 查询分类层级 | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| boutique | query | 否 | boolean | 是否在商城展示 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsCategoryListRespVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.category.model.vo.GoodsCategoryListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsCategoryListRespVO[] | 否 | 返回数据 | |
GET
/api/goods-brand/search/{id}
商品品牌搜索接口
商品品牌ID搜索接口
OperationId: searchBrand
调用方法
GET /api/goods-brand/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商品品牌ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsBrandRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.brand.model.GoodsBrandRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsBrandRespVO | 否 | | |
GET
/api/goods-brand/search-page
商品品牌搜索接口
商品品牌分页搜索接口
OperationId: searchBrand_1
调用方法
GET /api/goods-brand/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| cooperative | query | 否 | boolean | 是否合作品牌 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsBrandListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.brand.model.GoodsBrandListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsBrandListRespVO | 否 | | |
GET
/api/goods-brand/search-list
商品品牌搜索接口
商品品牌列表搜索接口
OperationId: searchBrand_2
调用方法
GET /api/goods-brand/search-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | query | 是 | long | 商户ID | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
| cooperative | query | 否 | boolean | 是否合作品牌 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsBrandListRespVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.goods.business.brand.model.GoodsBrandListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsBrandListRespVO[] | 否 | 返回数据 | |
GET
/api/goods-barcode/store/search/{id}
门店零管商品条码搜索接口
门店零管商品条码ID搜索接口
OperationId: search_5
调用方法
GET /api/goods-barcode/store/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.barcode.model.vo.StoreItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/store/search-page
门店零管商品条码搜索接口
门店零管商品条码分页搜索接口
OperationId: search_6
调用方法
GET /api/goods-barcode/store/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "xxx" |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
| category | query | 否 | string | 商品分类编号/名称 | "xx" |
| brand | query | 否 | string | 商品品牌编号/名称 | "xx" |
| active | query | 否 | boolean | 是否可用 | true |
| shelf | query | 否 | boolean | 是否已上架 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StoreListItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.StoreListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StoreListItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/shelf/search/{id}
商品条码上下架业务接口
商品条码上下架申请ID搜索接口
OperationId: searchShelfApply
调用方法
GET /api/goods-barcode/shelf/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 交易理由ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: BarcodeShelfApplyRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.barcode.model.vo.BarcodeShelfApplyRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | BarcodeShelfApplyRespVO | 否 | | |
GET
/api/goods-barcode/shelf/search-page
商品条码上下架业务接口
商品条码上下架申请分页搜索接口
OperationId: searchShelfApply_1
调用方法
GET /api/goods-barcode/shelf/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| channel | query | 否 | string | 渠道 | "ONLINE" |
| type | query | 否 | string | 类型 | "ON_SHELF" |
| beLaunch | query | 否 | boolean | 待发起 | false |
| beVerify | query | 否 | boolean | 待审核 | false |
| finish | query | 否 | boolean | 已审核 | false |
| verifyResult | query | 否 | string | 审核结果 | "PASS" |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: BarcodeShelfApplyListRespVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.BarcodeShelfApplyListRespVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | BarcodeShelfApplyListRespVO | 否 | | |
GET
/api/goods-barcode/search/un-import-compnay-barcode
零管商品条码扩展搜索接口
搜索未导入的公司商品条码接口
OperationId: searchUnImportGoodsBarcode
调用方法
GET /api/goods-barcode/search/un-import-compnay-barcode
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 是 | string | 渠道 | "xxx" |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
| category | query | 否 | string | 商品分类编号/名称 | "xx" |
| brand | query | 否 | string | 商品品牌编号/名称 | "xx" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StockGoodsBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.StockGoodsBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StockGoodsBarcodeVO | 否 | | |
GET
/api/goods-barcode/mobile/search/{id}
移动端零管商品条码搜索接口
移动端零管商品条码ID搜索接口
OperationId: search_7
调用方法
GET /api/goods-barcode/mobile/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MobileItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.barcode.model.vo.MobileItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MobileItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/mobile/search-page
移动端零管商品条码搜索接口
移动端零管商品条码分页搜索接口
OperationId: search_8
调用方法
GET /api/goods-barcode/mobile/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "xxx" |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
| category | query | 否 | string | 商品分类编号/名称 | "xx" |
| brand | query | 否 | string | 商品品牌编号/名称 | "xx" |
| active | query | 否 | boolean | 是否可用 | true |
| shelf | query | 否 | boolean | 是否已上架 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MobileListItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.MobileListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MobileListItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/mall/search/{id}
商城零管商品条码搜索接口
商城零管商品条码ID搜索接口
OperationId: search_9
调用方法
GET /api/goods-barcode/mall/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MallItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.barcode.model.vo.MallItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MallItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/mall/search-page
商城零管商品条码搜索接口
商城零管商品条码分页搜索接口
OperationId: search_10
调用方法
GET /api/goods-barcode/mall/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
| category | query | 否 | string | 商品分类编号/名称 | "xx" |
| brand | query | 否 | string | 商品品牌编号/名称 | "xx" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MallListItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.MallListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MallListItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/erp/search/{id}
ERP零管商品条码搜索接口
ERP零管商品条码ID搜索接口
OperationId: search_11
调用方法
GET /api/goods-barcode/erp/search/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.barcode.model.vo.ErpItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpItemBarcodeVO | 否 | | |
GET
/api/goods-barcode/erp/search-page
ERP零管商品条码搜索接口
ERP零管商品条码分页搜索接口
OperationId: search_12
调用方法
GET /api/goods-barcode/erp/search-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 搜索页码 | 0 |
| size | query | 是 | integer(int32) | 搜索页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| channel | query | 否 | string | 渠道 | "xxx" |
| goods | query | 否 | string | 商品编号/条码/名称 | "xxx" |
| category | query | 否 | string | 商品分类编号/名称 | "xx" |
| brand | query | 否 | string | 商品品牌编号/名称 | "xx" |
| active | query | 否 | boolean | 是否可用 | true |
| shelf | query | 否 | boolean | 是否已上架 | false |
| allowSale | query | 否 | boolean | 是否允许销售 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ErpListItemBarcodeVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.barcode.model.vo.ErpListItemBarcodeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ErpListItemBarcodeVO | 否 | | |
GET
/api/goods-adjust-price/query/{id}
商品零售价格调整计划管理接口
查询商品零售价格调整计划(ID)接口
OperationId: query_7
调用方法
GET /api/goods-adjust-price/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商品零售价格调整计划ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
GET
/api/goods-adjust-price/query-page
商品零售价格调整计划管理接口
查询商品零售价格调整计划(分页)接口
OperationId: query_8
调用方法
GET /api/goods-adjust-price/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| createCompanyId | query | 否 | long | 创建计划的公司ID | 1 |
| type | query | 否 | string | 调整的类型 | "NOW" |
| status | query | 否 | string | 状态 | "DRAFT" |
| time | query | 否 | string | 时间 | "2020-10-11 13:09:11" |
| companyId | query | 否 | long | 公司ID | 1 |
| channel | query | 否 | string | 调整的渠道 | "ONLINE" |
| goodsId | query | 否 | long | 商品ID | 1 |
| goodsBarcodeId | query | 否 | long | 商品条码ID | 1 |
| isFuel | query | 否 | boolean | 是否油品变价单 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlan com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlan
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlan | 否 | | |
GET
/api/goods-adjust-price/query-page/detail
商品零售价格调整计划管理接口
查询商品零售价格调整计划详情(分页)接口
OperationId: query_9
调用方法
GET /api/goods-adjust-price/query-page/detail
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | long | 商户ID | 1 |
| priceAdjustPlanId | query | 否 | long | 计划ID | 1 |
| type | query | 否 | string | 调整的类型 | "NOW" |
| status | query | 否 | string | 状态 | ["DRAFT"] |
| time | query | 否 | string | 时间 | "2020-10-11 13:09:11" |
| companyId | query | 否 | long | 公司ID | 1 |
| channel | query | 否 | string | 调整的渠道 | "ONLINE" |
| goodsId | query | 否 | long | 商品ID | 1 |
| goodsBarcodeId | query | 否 | long | 商品条码ID | 1 |
| confirm | query | 否 | boolean | 是否已确认 | 1 |
| isFuel | query | 否 | boolean | 是否油品变价单 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmGoodsPriceAdjustPlanDetail com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmGoodsPriceAdjustPlanDetail
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmGoodsPriceAdjustPlanDetail | 否 | | |
GET
/api/common-goods/query
商品管理接口
查询公司商品(分页)接口
OperationId: query_14
调用方法
GET /api/common-goods/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 574533689957252 |
| categoryId | query | 否 | long | 商品分类ID | 1 |
| brandId | query | 否 | long | 商品品牌ID | 1 |
| name | query | 否 | string | 名称 | "飞天茅台" |
| code | query | 否 | string | 货号 | 101001 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: GoodsVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.GoodsVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | GoodsVO | 否 | | |
GET
/api/common-goods/query/category/{merchantId}
商品管理接口
查询商户商品分类接口
OperationId: query_15
调用方法
GET /api/common-goods/query/category/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: StockGoodsCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.StockGoodsCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | StockGoodsCategory[] | 否 | 返回数据 | |
GET
/api/barcode/query/{id}
零管商品条码管理接口
查询零管商品条码(ID)接口
OperationId: query_16
调用方法
GET /api/barcode/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcode com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmItemBarcode
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcode | 否 | | |
GET
/api/barcode/query-page/update-log
零管商品条码管理接口
查询零管商品条码变更日志(分页)接口
OperationId: queryUpdateLog_1
调用方法
GET /api/barcode/query-page/update-log
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| itemBarcodeId | query | 是 | long | 零管商品条码ID | 1 |
| updateType | query | 否 | string | 变更类型 | "UPDATE_CHECK_STOCK" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcodeUpdateLog com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmItemBarcodeUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcodeUpdateLog | 否 | | |
GET
/api/barcode/query-page/adjust-price-record/{id}
零管商品条码管理接口
查询零管商品条码价格调整记录(分页)接口
OperationId: queryUpdateLog_2
调用方法
GET /api/barcode/query-page/adjust-price-record/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 零管商品条码ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcodePriceAdjustRecord com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmItemBarcodePriceAdjustRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcodePriceAdjustRecord | 否 | | |
GET
/api/barcode/query-page/adjust-price-record-by-goodsBacode
零管商品条码管理接口
查询商品条码价格调整记录(分页)接口
OperationId: queryUpdateLogByGoodsBacode
调用方法
GET /api/barcode/query-page/adjust-price-record-by-goodsBacode
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | integer(int64) | 公司ID | 1 |
| goodsBarcodeId | query | 是 | integer(int64) | 商品条码ID | 1 |
| channel | query | 是 | string | 渠道 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcodePriceAdjustRecord com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.model.po.entity.RmItemBarcodePriceAdjustRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcodePriceAdjustRecord | 否 | | |
GET
/api/barcode/query-list/{itemId}
零管商品条码管理接口
查询零管商品条码(列表)接口
OperationId: queryList_2
调用方法
GET /api/barcode/query-list/{itemId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| itemId | path | 是 | integer(int64) | 零管商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RmItemBarcode com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmItemBarcode
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RmItemBarcode[] | 否 | 返回数据 | |
GET
/api/barcode/query-barcode-specification
零管商品条码管理接口
查询商品条码属性
OperationId: queryGoodsBarcodeSpecification
调用方法
GET /api/barcode/query-barcode-specification
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| goodsId | query | 是 | integer(int64) | 商品ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ItemSpecificationVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.ItemSpecificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemSpecificationVO | 否 | | |
DELETE
/api/rm-goods-category/remove/{categoryId}
零管商品分类业务接口
删除零管商品分类接口
OperationId: removeRmGoodsCategory
向下级联删除
调用方法
DELETE /api/rm-goods-category/remove/{categoryId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| categoryId | 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 | 否 | 返回数据 | |
DELETE
/api/quick-item/remove/{id}
零管POS首页快捷商品布局接口
删除POS首页快捷商品布局(物理删除)
OperationId: remove_2
调用方法
DELETE /api/quick-item/remove/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 布局记录ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/api/goods-presale-active/delete/{id}
商品预售活动管理接口
删除活动
OperationId: update_5
调用方法
DELETE /api/goods-presale-active/delete/{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 | 否 | 返回数据 | |
DELETE
/api/goods-adjust-price/delete/{id}
商品零售价格调整计划管理接口
删除商品零售价格调整计划接口
OperationId: delete
调用方法
DELETE /api/goods-adjust-price/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 | 否 | 返回数据 | |
GET
/error
main-site-error-handler
-
OperationId: handleError
调用方法
GET /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/error
main-site-error-handler
-
OperationId: handleError_1
调用方法
POST /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/error
main-site-error-handler
-
OperationId: handleError_2
调用方法
PUT /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
DELETE
/error
main-site-error-handler
-
OperationId: handleError_3
调用方法
DELETE /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PATCH
/error
main-site-error-handler
-
OperationId: handleError_4
调用方法
PATCH /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
OPTIONS
/error
main-site-error-handler
-
OperationId: handleError_6
调用方法
OPTIONS /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
HEAD
/error
main-site-error-handler
-
OperationId: handleError_5
调用方法
HEAD /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
模型定义
com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateItemGraphicTextDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsDetailGraphicText | string | 否 | 商品图文(未作修改请不传) | |
| goodsServerGraphicText | string | 否 | 商品服务图文(未作修改请不传) | |
com.leadwaycloud.rm.goods.business.history.model.DTO.RmItemShelvesDTO
零管商品上/下架数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| rmItemIdList | integer(int64)[] | 否 | 零管商品ID(如果为null则上/下架所有商品) | [1] |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustPlanDetailDTO
零管商品条码价格调整详情数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 调整的渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| goodsName | string | 是 | 商品名称 | "矿泉水" |
| goodsId | integer(int64) | 否 | 商品ID(二选一) | 1 |
| goodsBarcodeId | integer(int64) | 否 | 商品条码ID(二选一) | 1 |
| goodsBarcode | string | 否 | 商品条码(选择商品条码时需要提供) | "6912341218163" |
| adjustPrice | number(double) | 是 | 调整后价格 | 20 |
com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateGoodsPriceAdjustPlanDTO
修改零管商品条码价格调整
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 否 | 调整类型 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| goodsPriceAdjustPlanDetailList | AddGoodsPriceAdjustPlanDetailDTO[] | 否 | 零管商品条码价格调整计划详情 | |
| remarks | string | 否 | 备注 | "..." |
| isFuel | boolean | 否 | 是否油品变价单 | false |
com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateRmItemBarcodeDTO
修改零管商品条码数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| checkStock | boolean | 否 | 是否检查库存 | false |
| price | number(double) | 否 | 售价 | 100 |
| shelfQty | number(double) | 否 | 上架数量(此数量不作为商品库存数量。在渠道销售终端不可展示。库存需在通过单独接口获取) | 100 |
| orderMinQty | number(double) | 否 | 单次最小购买数量 | 1 |
| orderMaxQty | number(double) | 否 | 单次最大购买数量 | 999999 |
| active | boolean | 否 | 是否可用 | false |
| spec | string | 否 | 规格 | "xxx" |
com.leadwaycloud.rm.goods.business.history.model.DTO.SaveRmQuickItemLayoutDTO
保存POS首页快捷商品布局数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| itemsLayout | string | 是 | POS首页商品布局JSON | "{\"rows\":4,\"cols\":5,\"cells\":[]}" |
| active | boolean | 否 | 是否启用,默认 true | true |
com.leadwaycloud.rm.goods.business.history.model.DTO.QueryItemByChangeOrderDTO
查询零管商品模型(变价单)
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsId | integer(int64) | 否 | 商品ID | 1 |
| goodsBarcodeId | integer(int64) | 否 | 条码ID | 1 |
| companyIdList | integer(int64)[] | 是 | 公司ID集合 | |
com.leadwaycloud.rm.goods.business.history.model.VO.ChangeOrderItemVO
变价单商品返回数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 否 | 零管商品ID | 1 |
| channel | string | 否 | 渠道 | |
| goodsId | integer(int64) | 否 | 商品ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| goodsBarcodeId | integer(int64) | 否 | 条码ID | 1 |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddItemBarcodeDTO
条码
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| stockGoodsBarcodeId | integer(int64) | 是 | 商品条码ID | |
| companyGoodsBarcodeId | integer(int64) | 是 | 公司商品条码ID | |
| checkStock | boolean | 是 | 是否检查库存 | false |
| price | number(double) | 是 | 单价 | 10 |
| orderMinQty | number(double) | 是 | 单次最小购买数量 | 1 |
| orderMaxQty | number(double) | 是 | 单次最大购买数量 | 999999 |
| shelfQty | number(double) | 否 | 上架数量(此数量不作为商品库存数量。在渠道销售终端不可展示。库存需在通过单独接口获取) | 100 |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddItemDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| stockGoodsId | integer(int64) | 是 | 商品ID | |
| companyGoodsId | integer(int64) | 是 | 公司商品ID | |
| detailContent | string | 否 | 详细内容(商品图文消息) | |
| serverContent | string | 否 | 服务内容(商品服务详情图文) | "..." |
| itemBarcodeList | AddItemBarcodeDTO[] | 否 | 条码 | |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPresaleActiveLineDTO
商品预售活动明细模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 否 | ID | 6912341218163 |
| goodsId | integer(int64) | 否 | 商品ID | 6912341218163 |
| goodsBarcodeId | integer(int64) | 否 | 条码ID | 6912341218163 |
| goodsCode | string | 否 | 商品名称 | "矿泉水" |
| goodsName | string | 否 | 商品名称 | "矿泉水" |
| goodsBarcode | string | 否 | 商品条码 | "6912341218163" |
com.leadwaycloud.rm.goods.business.history.model.DTO.UpdateGoodsPresaleActiveDTO
添加商品预售活动模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | "预售活动" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| joinCompany | integer(int64)[] | 否 | 参与公司 | [1] |
| deliveryMode | object | 否 | 发货方式(供应商自提点自提包含自提点信息) | {} |
| description | string | 否 | 描述 | |
| addGoodsPresaleActiveLineList | AddGoodsPresaleActiveLineDTO[] | 否 | 添加预售活动明细 | |
| deleteLineIdList | integer(int64)[] | 否 | 删除活动明细行ID | |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPresaleActiveDTO
添加商品预售活动模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | "预售活动" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| status | string | 是 | 状态 【 DRAFT : 草稿 PREPARING : 准备中 IN_EXECUTION : 执行中 COMPLETED : 已完成 TERMINATED : 已停用 DELETED : 已删除 】 | "DRAFT" |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| joinCompany | integer(int64)[] | 是 | 参与公司 | 1 |
| deliveryMode | object | 是 | 发货方式(供应商自提点自提包含自提点信息) | {} |
| createCompanyId | integer(int64) | 是 | 创建公司 | 1 |
| description | string | 否 | 描述 | |
| addGoodsPresaleActiveLineList | AddGoodsPresaleActiveLineDTO[] | 否 | 预售活动明细 | |
com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextReqDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 | "xxx" |
| memberId | integer(int64) | 否 | 会员ID | 1 |
| keyword | string | 否 | 关键词 | "xxx" |
| brandList | integer(int64)[] | 否 | 品牌ID集合 | [] |
| categoryList | integer(int64)[] | 否 | 分类ID集合 | [] |
| rmCategoryList | integer(int64)[] | 否 | 零管分类ID集合 | [] |
| itemSpecMap | object | 否 | 规格 | {} |
| minPrice | string | 否 | 最小价格 | "1" |
| maxPrice | string | 否 | 最大价格 | "1000" |
| sortSaleQtyType | string | 否 | 销量排序类型 【 ASC : 升序 DESC : 降序 】 | "ASC" |
| sortPriceType | string | 否 | 价格排序类型 【 ASC : 升序 DESC : 降序 】 | "ASC" |
| page | integer(int32) | 否 | 搜索页码 | 0 |
| size | integer(int32) | 否 | 搜索页行数 | 50 |
com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextRespDTO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| success | boolean | 否 | 是否成功 | false |
| brandList | ItemSmartSearchForFullTextRespDTO$BrandInfo[] | 否 | 商品列表中品牌合集 | |
| categoryList | ItemSmartSearchForFullTextRespDTO$CategoryInfo[] | 否 | 商品列表中分类合集 | |
| specList | ItemSmartSearchForFullTextRespDTO$GoodsSpecInfo[] | 否 | 商品列表中规格合集 | |
| goodsPage | SmartSearchListItemVO | 否 | | |
com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextRespDTO$BrandInfo
商品列表中品牌合集
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextRespDTO$CategoryInfo
商品列表中分类合集
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | |
| name | string | 是 | 名称 | |
com.leadwaycloud.rm.goods.business.item.model.dto.ItemSmartSearchForFullTextRespDTO$GoodsSpecInfo
商品列表中规格合集
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | |
| valueList | string | 否 | 值 | |
com.leadwaycloud.rm.goods.business.history.model.DTO.CompanyVerifyGoodsPriceAdjustPlanDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsPriceAdjustPlanDetailList | integer(int64)[] | 是 | 变价计划明细ID集合 | [1] |
| isReject | boolean | 是 | 是否拒绝 | true |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustPlanDTO
添加零管商品条码价格调整计划数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 公司ID | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| goodsPriceAdjustPlanDetailList | AddGoodsPriceAdjustPlanDetailDTO[] | 是 | 零管商品条码价格调整计划详情 | |
| remarks | string | 否 | 备注 | "..." |
| lastConfirmTime | string | 否 | 最后确认时间(必须小于开始调整时间半个小时) | "2020-10-11 13:09:11" |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsToCompanyDTO
添加商品价格调整计划1数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 创建计划公司ID | 1 |
| goodsName | string | 是 | 商品名称 | "矿泉水" |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| detailList | AddGoodsPriceAdjustByGoodsToCompanyDetailDTO[] | 是 | 详情 | |
| remarks | string | 否 | 备注 | "..." |
| lastConfirmTime | string | 否 | 最后确认时间(必须小于开始调整时间半个小时) | "2020-10-11 13:09:11" |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsToCompanyDetailDTO
添加公司商品价格调整计划详情数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 调整的渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| adjustPrice | number(double) | 是 | 调整后价格 | 20 |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsFormCompanyDTO
添加商品价格调整计划2数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| createCompanyId | integer(int64) | 是 | 创建计划公司ID | 1 |
| companyId | integer(int64) | 是 | 公司ID(二选一) | 1 |
| type | string | 是 | 调整的渠道 【 NOW : 即时调整 PLANNING_TIME : 计划时间调整 PLANNING_TIME_PERIOD : 计划段调整 】 | "NOW" |
| startTime | string | 否 | 开始调整时间 | "2020-10-11 13:09:11" |
| endTime | string | 否 | 结束调整时间 | "2020-10-11 13:09:11" |
| detailList | AddGoodsPriceAdjustByGoodsFormCompanyDetailDTO[] | 是 | 详情 | |
| remarks | string | 否 | 备注 | "..." |
| isFuel | boolean | 否 | 是否油品变价单,默认 false | false |
com.leadwaycloud.rm.goods.business.history.model.DTO.AddGoodsPriceAdjustByGoodsFormCompanyDetailDTO
添加公司商品价格调整计划详情数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsName | string | 是 | 商品名称 | "矿泉水" |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| channel | string | 是 | 调整的渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| adjustPrice | number(double) | 是 | 调整后价格 | 20 |
com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.MultipleBarcodesSpecificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MultipleBarcodesSpecificationVO | 否 | | |
com.leadwaycloud.rm.goods.business.history.model.VO.MultipleBarcodesSpecificationVO
多条码属性
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| specificationMap | object | 否 | 商品条码属性(Map<SpecificationId,StockGoodsSpecification>) | |
| goodsBarcodeSpecificationParamMap | object | 否 | 商品条码属性值(Map<StockGoodsBarcodeId,GoodsBarcodeSpecificationParamList>) | |
com.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | ItemVO[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemVO
当前页数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 否 | 零管商品ID | 1 |
| goodsName | string | 否 | 商品名称 | "抽纸" |
| categoryName | string | 否 | 分类名称 | |
| brandName | string | 否 | 品牌名称 | |
| images | string | 否 | 图片 | "..." |
| salesQty | number(double) | 否 | 销售数量 | 1 |
| goodsCode | string | 否 | 商品货号 | |
| otherName | string | 否 | 别名 | |
| virtual | boolean | 否 | 虚拟商品 | |
| itemStatus | string | 否 | 零管商品状态 | |
| shelf | boolean | 否 | 是否上架 | false |
| channel | string | 否 | 渠道 | |
com.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemDetailVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | ItemDetailVO[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemDetailPriceVO
价格
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 否 | 零管商品ID | 1 |
| itemBarcodeId | integer(int64) | 否 | 零管商品条码ID | 1 |
| price | number(double) | 否 | 价格 | |
| price2 | number(double) | 否 | 价格 | |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemDetailVO
当前页数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 否 | 零管商品ID | 1 |
| goodsName | string | 否 | 商品名称 | "抽纸" |
| categoryName | string | 否 | 分类名称 | |
| brandName | string | 否 | 品牌名称 | |
| images | string | 否 | 图片 | "..." |
| salesQty | integer(int64) | 否 | 销售数量 | 1 |
| goodsCode | string | 否 | 商品货号 | |
| otherName | string | 否 | 别名 | |
| virtual | boolean | 否 | 虚拟商品 | |
| itemStatus | string | 否 | 零管商品状态 | |
| shelf | boolean | 否 | 是否上架 | false |
| channel | string | 否 | 渠道 | |
| barcodePriceList | ItemDetailPriceVO[] | 否 | 价格 | |
com.leadwaycloud.rm.goods.business.history.model.DTO.QueryRmItemDTO
查询零管商品数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 否 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| goodsId | integer(int64) | 否 | 商品ID | 1 |
| companyGoodsId | integer(int64) | 否 | 公司商品ID | 1 |
| companyGoodsBarcodeStatus | string | 否 | 公司商品条码状态 【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除 】 | "ACTIVE" |
| itemBarcodeActive | boolean | 否 | 零管商品条码是否可用 | true |
| shelf | boolean | 否 | 是否上架 | false |
| status | string | 否 | 状态 【 ACTIVE : 可用 DEACTIVATE : 停用 】 | "ACTIVE" |
| categoryId | integer(int64) | 否 | 商品分类 | 1 |
| categoryCode | string | 否 | 商品分类编号 | "C01" |
| text | string | 否 | 商品编码/商品条码/商品名称/商品标签 | "纸巾" |
| brandCode | string | 否 | 品牌编号 | "XXY" |
| itemIdList | integer(int64)[] | 否 | 商品ID | |
| sortSaleQty | string | 否 | 是否根据销量排序 | "ACTIVE" |
| sortPriceType | string | 否 | 价格排序类型 【 ASC : 升序 DESC : 降序 】 | "ASC" |
com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.ItemSpecificationVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemSpecificationVO | 否 | | |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemSpecificationVO
商品属性
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsSpecificationList | StockGoodsSpecification[] | 否 | 商品属性 | |
| goodsSpecificationParamMap | object | 否 | 商品属性值(Map<SpecificationID,GoodsSpecificationParamList>) | |
| goodsBarcodeSpecificationParamMap | object | 否 | 商品条码属性值(Map<SpecificationID,GoodsBarcodeSpecificationParamList>) | |
com.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.PosSyncItemResponse
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | PosSyncItemResponse[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncCompanyGoodsBarcodeResponse
公司商品条码
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| goodsBarcodeId | integer(int64) | 是 | 商品条码ID | 1 |
| companyGoodsId | integer(int64) | 是 | 公司商品ID | 1 |
| tags | string | 否 | 标签 | "[\"123\"]" |
| cost | number(double) | 是 | 成本价格(不含税) | 0 |
| price | number(double) | 是 | 销售底价 | 10 |
| saleGuidePrice | number(double) | 否 | 建议销售价 | 10 |
| salePrice | number(double) | 否 | 零售价 | 10 |
| saleTax | FinanceTax | 是 | | |
| status | string | 是 | 状态 【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除 】 | "ACTIVE" |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncItemBarcodeResponse
零管销售商品条码
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| itemId | integer(int64) | 是 | 零管销售商品ID | |
| stockGoodsBarcodeId | integer(int64) | 是 | 商品条码ID | |
| companyGoodsBarcodeId | integer(int64) | 是 | 公司商品条码ID | |
| spec | string | 否 | 零管商品条码规格 | |
| shelf | boolean | 是 | 是否上架 | false |
| checkStock | boolean | 是 | 是否检查库存 | false |
| shelfQty | number(double) | 是 | 当前货架库存 | 100 |
| price | number(double) | 是 | 单价 | 10 |
| price2 | number(double) | 否 | 单价2 | 10 |
| orderMinQty | number(double) | 是 | 单次最小购买数量 | 1 |
| orderMaxQty | number(double) | 是 | 单次最大购买数量 | 999999 |
| active | boolean | 是 | 是否可用 | true |
| stockGoodsBarcode | StockGoodsBarcode | 是 | | |
| companyGoodsBarcode | PosSyncCompanyGoodsBarcodeResponse | 是 | | |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncItemResponse
当前页数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| stockGoodsId | integer(int64) | 是 | 商品ID | |
| companyGoodsId | integer(int64) | 是 | 公司商品ID | |
| name | string | 否 | 零管商品名称 | |
| shelf | boolean | 是 | 是否上架 | false |
| detailContent | string | 否 | 详细内容(商品详情图文) | "..." |
| serverContent | string | 否 | 服务内容(商品服务详情图文) | "..." |
| status | string | 是 | 状态 【 ACTIVE : 可用 DEACTIVATE : 停用 】 | "ACTIVE" |
| salesQty | number(double) | 是 | 销售数量 | 1 |
| stockGoods | PosSyncStockGoodsResponse | 是 | | |
| companyGoods | PosSyncCompanyGoods | 是 | | |
| itemBarcodeList | PosSyncItemBarcodeResponse[] | 否 | 零管销售商品条码 | |
| company | SimpleResCompany | 否 | | |
| distribution | boolean | 否 | 是否是零管分销商品 | false |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncStockGoodsResponse
商品
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| 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.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemResponse
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | PosSyncSimplifyItemResponse[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemBarcodeResponse
零管销售商品条码
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| itemId | integer(int64) | 是 | 零管商品ID | |
| stockGoodsBarcodeId | integer(int64) | 是 | 商品条码ID | |
| barcode | string | 是 | 条码 | "6914068029184" |
| otherBarcode | string | 否 | 其他条码 | "6914068029184" |
| images | string | 否 | 图片 | |
| defSettlement | boolean | 是 | 是否是结算默认条码 | |
| shelf | boolean | 是 | 是否上架 | false |
| checkStock | boolean | 是 | 是否检查库存 | false |
| cost | number(double) | 是 | 成本价格(不含税) | 0 |
| price | number(double) | 是 | 单价 | 10 |
| price2 | number(double) | 否 | 单价2 | 10 |
| orderMinQty | number(double) | 是 | 单次最小购买数量 | 1 |
| orderMaxQty | number(double) | 是 | 单次最大购买数量 | 999999 |
| active | boolean | 是 | 是否可用 | true |
| status | string | 是 | 状态 【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除 】 | "ACTIVE" |
| saleTaxId | integer(int64) | 是 | 销售税 | 1 |
| saleTax | PosSyncSimplifyItemTaxResponse | 是 | | |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemBrandResponse
品牌
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| code | string | 是 | 编号 | "xxx" |
| name | string | 是 | 名称 | "xxx" |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemResponse
当前页数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| stockGoodsId | integer(int64) | 是 | 商品ID | |
| companyGoodsId | integer(int64) | 是 | 公司商品ID | |
| name | string | 是 | 名称 | "抽纸" |
| otherName | string | 否 | 别名 | "..." |
| code | string | 是 | 货号 | "KDED24123123" |
| status | string | 是 | 状态 【 ACTIVE : 可用 DEACTIVATE : 停用 】 | "ACTIVE" |
| categoryId | integer(int64) | 是 | 分类ID | |
| brandId | integer(int64) | 否 | 公司商品ID | |
| uomId | integer(int64) | 否 | 计量单位ID | |
| weight | boolean | 是 | 非标售卖商品 | true |
| fuel | boolean | 是 | 油品 | true |
| make | boolean | 是 | 自制品 | true |
| barcodeSettlement | boolean | 是 | 商品结算方式 false(商品结算,默认) true(条码结算) | |
| allowSale | boolean | 是 | 允许销售 | true |
| allowDiscount | boolean | 是 | 允许折扣 | true |
| allowManualPrice | boolean | 是 | 允许手工变价(POS手工变价) | true |
| allowRefund | boolean | 是 | 允许退货 | true |
| brand | PosSyncSimplifyItemBrandResponse | 否 | | |
| uom | PosSyncSimplifyItemUomResponse | 否 | | |
| barcodeList | PosSyncSimplifyItemBarcodeResponse[] | 否 | 零管销售商品条码 | |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemTaxResponse
销售税
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| name | string | 是 | 名称 | "13%销售税" |
| value | boolean | 是 | 税值 | false |
com.leadwaycloud.rm.goods.business.history.model.VO.PosSyncSimplifyItemUomResponse
计量单位
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| id | integer(int64) | 是 | ID | 1 |
| code | string | 是 | 编号 | "1" |
| name | string | 是 | 名称 | "公斤" |
| shortName | string | 否 | 简称 | |
| symbol | string | 是 | 符号 | "kg" |
com.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.ItemBarcodeVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | ItemBarcodeVO[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemBarcodeVO
当前页数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemId | integer(int64) | 否 | 零管商品ID | 1 |
| itemBarcodeId | integer(int64) | 否 | 零管商品条码ID | 1 |
| goodsName | string | 否 | 商品名称 | "抽纸" |
| categoryName | string | 否 | 分类名称 | |
| brandName | string | 否 | 品牌名称 | |
| images | string | 否 | 图片 | "..." |
| price | number(double) | 否 | 单价 | 10 |
| salesQty | number(double) | 否 | 销售数量 | 1 |
| orderMaxQty | number(double) | 否 | 单次最大购买数量 | 999 |
| goodsCode | string | 否 | 商品货号 | |
| otherName | string | 否 | 别名 | |
| virtual | boolean | 否 | 虚拟商品 | |
| itemStatus | string | 否 | 零管商品状态 | |
| shelf | boolean | 否 | 是否上架 | false |
| channel | string | 否 | 渠道 | |
com.leadwaycloud.core.model.RCom.leadwaycloud.rm.goods.business.history.model.VO.ItemStockVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ItemStockVO | 否 | | |
com.leadwaycloud.rm.goods.business.history.model.VO.BarcodeStockVO
商品条码线上库存情况数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| itemBarcodeId | integer(int64) | 是 | 零管商品条码ID | 1 |
| barcodeId | integer(int64) | 是 | 条码ID | 1 |
| saleQty | integer(int64) | 是 | 已销售数量(过往30天) | 1 |
| stockQty | integer(int64) | 是 | 线上库存数量 | 1 |
com.leadwaycloud.rm.goods.business.history.model.VO.ItemStockVO
商品线上库存情况数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyId | integer(int64) | 是 | 公司ID | 1 |
| channel | string | 是 | 渠道 【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下 】 | "ONLINE" |
| itemId | integer(int64) | 是 | 零管商品ID | 1 |
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| saleQty | integer(int64) | 是 | 已销售数量(过往30天) | 1 |
| barcodeStockList | BarcodeStockVO[] | 否 | 商品条码线上库存数量 | |
com.leadwaycloud.core.model.PCom.leadwaycloud.rm.goods.business.history.model.VO.GoodsVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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 | GoodsVO[] | 否 | 当前页数据 | |
com.leadwaycloud.rm.goods.business.history.model.VO.CompanyGoodsBarcodeVO
公司商品条码数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyGoodsId | integer(int64) | 是 | 公司商品ID | 1 |
| goodsBarcodeId | integer(int64) | 是 | 商品条码ID | 1 |
| companyGoodsBarcodeId | integer(int64) | 是 | 公司商品条码ID | 1 |
| barcode | string | 是 | 条码 | "6914068029184" |
| type | string | 是 | 条码类型 | "EN13" |
| images | string | 否 | 图片 | |
| price | number(double) | 是 | 零售价(含税) | 10 |
| defSettlement | boolean | 是 | 是否是结算默认条码 | |
com.leadwaycloud.rm.goods.business.history.model.VO.CompanyGoodsVO
公司商品数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| companyGoodsId | integer(int64) | 是 | 公司商品ID | 1 |
| companyGoodsBarcodeList | CompanyGoodsBarcodeVO[] | 是 | 公司商品条码 | |
com.leadwaycloud.rm.goods.business.history.model.VO.GoodsVO
商品数据模版
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| goodsId | integer(int64) | 是 | 商品ID | 1 |
| name | string | 是 | 名称 | "抽纸" |
| code | string | 是 | 货号 | "KDED24123123" |
| virtual | boolean | 是 | 是否是虚拟产品 | true |
| images | string | 否 | 图片 | |
| origin | string | 否 | 来源 | |
| description | string | 否 | 描述 | |
| otherName | string | 否 | 别名 | |
| mark | string | 否 | 标记 | "ENERGY" |
| barcodeSettlement | boolean | 是 | 商品结算方式 false(商品结算,默认) true(条码结算) | |
| uomId | integer(int64) | 是 | 计量单位ID | 1 |
| goodsCategoryId | integer(int64) | 否 | 分类ID | 1 |
| goodsBrandId | integer(int64) | 否 | 品牌ID | 1 |
| companyGoodsId | integer(int64) | 否 | 公司商品ID | 1 |
| uom | SysUom | 是 | | |
| goodsCategory | StockGoodsCategory | 否 | | |
| goodsBrand | StockGoodsBrand | 否 | | |
| goodsEnergy | StockGoodsEnergy | 否 | | |
| companyGoods | CompanyGoodsVO | 否 | | |