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

服务地址

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

接口详情

PUT

/api/view/update/{id}

商城视图配置接口修改商城视图配置接口 OperationId: update

调用方法

PUT /api/view/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城视图ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateViewDTO com.leadwaycloud.rm.mall.business.view.dto.UpdateViewDTO

名称	类型	必填	说明	示例
version	string	否	版本号	"V1"
content	string	否	视图配置	"..."

响应

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

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

PUT

/api/self-pickup-outlets/update/{id}

商城自提网点接口修改商城自提网点接口 OperationId: updateWechatConfig

调用方法

PUT /api/self-pickup-outlets/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城应用ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateSelfPickupOutletsDTO com.leadwaycloud.rm.mall.business.pickup.outlets.dto.UpdateSelfPickupOutletsDTO

名称	类型	必填	说明	示例
name	string	否	名称	"银泰城永辉超市"
code	string	否	标识	"...."
type	string	否	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	否	联络人	"张三"
phone	string	否	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	否	是否可用	true
latLon	string	否	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

响应

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

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

PUT

/api/refund-address/update/{id}

商城退货地址接口商城退货地址接口 OperationId: updateWechatConfig_1

调用方法

PUT /api/refund-address/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城退货地址ID	1

请求体

Content-Type: application/json 必填: 是 类型: RefundAddressDTO com.leadwaycloud.rm.mall.business.refund.address.dto.RefundAddressDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
country	integer(int64)	是	国家	1
province	integer(int64)	是	省份	1
city	integer(int64)	是	城市	1
area	integer(int64)	是	区	1
street	integer(int64)	是	街道	1
detailAddress	string	是	详细地址	"..."
receiver	string	是	收货人
phone	string	是	电话

响应

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

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

PUT

/api/express/update/{id}

合作快递公司管理接口修改合作快递公司接口 OperationId: update_1

调用方法

PUT /api/express/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	合作快递公司ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateExpressDTO com.leadwaycloud.rm.mall.business.express.dto.UpdateExpressDTO

名称	类型	必填	说明	示例
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

响应

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

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

PUT

/api/express/update/express-scope/{expressScopeId}

合作快递公司管理接口修改配送范围接口 OperationId: updateExpressScope

调用方法

PUT /api/express/update/express-scope/{expressScopeId}

参数

名称	位置	必填	类型	说明	示例
expressScopeId	path	是	integer(int64)	配送范围ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateExpressScopeDTO com.leadwaycloud.rm.mall.business.express.dto.UpdateExpressScopeDTO

名称	类型	必填	说明	示例
minFreeFareOrderAmount	number(double)	否	最小免费配送订单金额	100
fare	number(double)	否	运费	10

响应

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

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

PUT

/api/express/stop/{id}

合作快递公司管理接口停用合作快递公司接口 OperationId: stop

调用方法

PUT /api/express/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/express/start/{id}

合作快递公司管理接口启用合作快递公司接口 OperationId: start

调用方法

PUT /api/express/start/{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/distribution-rule/update/{id}

分销规则接口修改分销规则接口 OperationId: update_2

调用方法

PUT /api/distribution-rule/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateDistributionRuleDTO com.leadwaycloud.rm.mall.business.distribution.dto.UpdateDistributionRuleDTO

名称	类型	必填	说明	示例
openApplyExamine	boolean	否	是否开启分销申请审核	false
specifyItem	boolean	否	是否开放店铺指定分销商品	false
rebateExtractExamine	boolean	否	是否开启佣金提取审核	false
settlementCycle	string	否	结算周期【 WEEK : 周 MONTH : 月】	"WEEK"
settlementDay	integer(int32)	否	结算日	1
distributionMethod	string	否	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
rebatePercent1	number(double)	否	一级提成比例
rebatePercent2	number(double)	否	二级提成比例
rebatePercent3	number(double)	否	三级提成比例
memberAccountTypeId	integer(int64)	否	佣金提取账户类型ID	1
distributionExplain	string	否	分销说明	"..."

响应

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

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

PUT

/api/distribution-rule/open/{id}

分销规则接口开启分销接口 OperationId: openDistribution

调用方法

PUT /api/distribution-rule/open/{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/distribution-rule/close/{id}

分销规则接口关闭分销接口 OperationId: closeDistribution

调用方法

PUT /api/distribution-rule/close/{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/distribution-member/merchant/read-rule-to-false/{id}

分销成员接口变更分销成员已阅读分销规则接口 OperationId: changeDistributionMemberReadRuleToTrue

调用方法

PUT /api/distribution-member/merchant/read-rule-to-false/{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/article/update/{id}

商城图文修改商城图文接口 OperationId: updateArticle

调用方法

PUT /api/article/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	图文ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateArticleDTO com.leadwaycloud.rm.mall.business.article.dto.UpdateArticleDTO

名称	类型	必填	说明	示例
title	object	是	主题	"今日美味特供"
categoryId	string	是	图文分类
config	JSONObject	否
content	JSONObject	是
startDate	string	是	开始日期	"2021-11-01"
endDate	string	是	结束日期	"2021-11-11"
startTime	string	否	开始时间	"08:00:00"
endTime	string	否	结束时间	"10:00:00"
active	boolean	是	是否启用	true

响应

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

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

PUT

/api/article/category/update/{id}

商城图文修改商城图文分类接口 OperationId: updateArticleCategory

调用方法

PUT /api/article/category/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	图文分类ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateArticleCategoryDTO com.leadwaycloud.rm.mall.business.article.dto.UpdateArticleCategoryDTO

名称	类型	必填	说明	示例
name	string	是	分类名	"Child Today"
images	string	否	图片
icon	string	否	图标
orderSequence	integer(int32)	否	排序	1
status	string	否	状态	"ACTIVE"

响应

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

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

PUT

/api/application/update/{id}

商城应用配置接口修改商城应用接口 OperationId: updateWechatConfig_2

调用方法

PUT /api/application/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城应用ID	1

请求体

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

名称	类型	必填	说明	示例
arg1	UpdateApplicationDTO	是
certificateFile	string(binary)	否

响应

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

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

PUT

/api/application-deploy-config/update/{id}

应用部署配置接口修改应用配置 OperationId: update_3

调用方法

PUT /api/application-deploy-config/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	应用配置ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateApplicationDeployConfigDTO com.leadwaycloud.rm.mall.business.application.dto.UpdateApplicationDeployConfigDTO

名称	类型	必填	说明	示例
config	string	是	配置

响应

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

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

PUT

/api/active/update/vote/{id}

商城活动修改商城投票活动接口 OperationId: updateActive

调用方法

PUT /api/active/update/vote/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateVoteActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.vote.UpdateVoteActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	VoteActiveConfigBO	是

响应

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

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

PUT

/api/active/update/sign/{id}

商城活动修改商城签到活动接口 OperationId: updateActive_1

调用方法

PUT /api/active/update/sign/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateSignActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.sign.UpdateSignActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	SignActiveConfigBO	是

响应

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

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

PUT

/api/active/update/scratch-card/{id}

商城活动修改商城刮刮卡活动接口 OperationId: updateActive_2

调用方法

PUT /api/active/update/scratch-card/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateScratchCardActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.scratch.card.UpdateScratchCardActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	ScratchCardActiveConfigBO	是

响应

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

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

PUT

/api/active/update/roulette/{id}

商城活动修改商城轮盘活动接口 OperationId: updateActive_3

调用方法

PUT /api/active/update/roulette/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateRouletteActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.roulette.UpdateRouletteActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	RouletteActiveConfigBO	是

响应

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

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

PUT

/api/active/update/questionnaire/{id}

商城活动修改商城问卷调查活动接口 OperationId: updateActive_4

调用方法

PUT /api/active/update/questionnaire/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateQuestionnaireActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.questionnaire.UpdateQuestionnaireActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	QuestionnaireActiveConfigBO	是

响应

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

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

PUT

/api/active/update/questionnaire/vote/{id}

商城活动修改商城问卷调查活动项目接口 OperationId: updateActiveItem

调用方法

PUT /api/active/update/questionnaire/vote/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateQuestionnaireActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.questionnaire.UpdateQuestionnaireActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	QuestionnaireActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/punch-clock/{id}

商城活动修改商城打卡活动接口 OperationId: updateActive_5

调用方法

PUT /api/active/update/punch-clock/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdatePunchClockActiveDTO com.leadwaycloud.rm.mall.business.active.dto.update.punch.clock.UpdatePunchClockActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	PunchClockActiveConfigBO	是

响应

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

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

PUT

/api/active/update/item/vote/{id}

商城活动修改商城投票活动项目接口 OperationId: updateActiveItem_1

调用方法

PUT /api/active/update/item/vote/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateVoteActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.vote.UpdateVoteActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	VoteActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/item/sign/{id}

商城活动修改商城签到活动项目接口 OperationId: updateActiveItem_2

调用方法

PUT /api/active/update/item/sign/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateSignActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.sign.UpdateSignActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	SignActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/item/scratch-card/{id}

商城活动修改商城刮刮卡活动项目接口 OperationId: updateActiveItem_3

调用方法

PUT /api/active/update/item/scratch-card/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateScratchCardActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.scratch.card.UpdateScratchCardActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	ScratchCardActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/item/roulette/{id}

商城活动修改商城轮盘活动项目接口 OperationId: updateActiveItem_4

调用方法

PUT /api/active/update/item/roulette/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateRouletteActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.roulette.UpdateRouletteActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	RouletteActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/item/punch-clock/{id}

商城活动修改商城打卡活动项目接口 OperationId: updateActiveItem_5

调用方法

PUT /api/active/update/item/punch-clock/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动项目ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdatePunchClockActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.update.punch.clock.UpdatePunchClockActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	PunchClockActiveItemConfigBO	是

响应

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

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

PUT

/api/active/update/condition/{id}

商城活动修改活动条件接口 OperationId: updateCondition

调用方法

PUT /api/active/update/condition/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动条件ID	1

请求体

Content-Type: application/json 必填: 是 类型: UpdateActiveConditionDTO com.leadwaycloud.rm.mall.business.active.dto.update.UpdateActiveConditionDTO

名称	类型	必填	说明	示例
type	string	是	类型【 ACTIVE : 活动 ORDER_AMOUNT : 订单交易金额 MEMBER : 会员 MEMBER_TYPE : 会员类型】	"ACTIVE"
value	string	是	值
attachment	string	否	自定义数据(json格式)

响应

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

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

PUT

/api/active/sort/item

商城活动活动项目排序接口 OperationId: sortActiveItem

调用方法

PUT /api/active/sort/item

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SortActiveItemDTO[] com.leadwaycloud.rm.mall.business.active.dto.update.SortActiveItemDTO

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

响应

状态码: 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/active/publish/{id}

商城活动发布商城活动接口 OperationId: publishActive

调用方法

PUT /api/active/publish/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

PUT

/api/active/delete

商城活动下架商城活动接口 OperationId: deleteActive

调用方法

PUT /api/active/delete

参数

无

请求体

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/active/delete/item

商城活动删除活动项目接口 OperationId: deleteActiveItem

调用方法

PUT /api/active/delete/item

参数

无

请求体

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

POST

/api/wechat/generate/url-scheme

微信接口生成微信小程序URL Scheme接口 OperationId: generateWxMiniAppUrlScheme

生成 scheme 码前请仔细确认生成类型，微信有相关限制

调用方法

POST /api/wechat/generate/url-scheme

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GenerateWxMiniAppUrlSchemeDTO com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppUrlSchemeDTO

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
expire	boolean	是	是否永久有效	false
expireTime	string	否	到期时间	"2020-10-11 13:09:11"
jumpWxaBO	JumpWxaBO	否

响应

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

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

POST

/api/wechat/generate/url-link

微信接口生成微信小程序URL Link接口 OperationId: generateWxMiniAppUrlLink

生成 scheme 码前请仔细确认生成类型，微信有相关限制

调用方法

POST /api/wechat/generate/url-link

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GenerateWxMiniAppUrlLinkDTO com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppUrlLinkDTO

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
path	string	否	通过 URL Link 进入的小程序页面路径
query	string	否	通过 URL Link 进入小程序时的query
envVersion	string	否	要打开的小程序版本
expire	boolean	是	是否永久有效	false
expireType	integer(int32)	否	小程序 URL Link 失效类型	0
expireTime	string	否	到期时间(expireType=0必填)	"2020-10-11 13:09:11"
expireInterval	integer(int32)	否	到期失效的URL Link的失效间隔天数(expireType=1必填)	1
cloudBaseBO	CloudBaseBO	否

响应

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

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

POST

/api/wechat/generate/short-link

微信接口生成微信小程序Short Link接口 OperationId: generateWxMiniAppShortLink

调用方法

POST /api/wechat/generate/short-link

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GenerateWxMiniAppShortLinkDTO com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppShortLinkDTO

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
pageUrl	string	是	通过 Short Link 进入的小程序页面路径
pageTitle	string	是	页面标题
isPermanent	boolean	否	生成的 Short Link 类型	false

响应

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

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

POST

/api/wechat/generate/mini-app-qrcode

微信接口生成微信小程序二维码接口 OperationId: generateWxMiniAppQRCode

调用方法

POST /api/wechat/generate/mini-app-qrcode

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GenerateWxMiniAppQRCodeDTO com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppQRCodeDTO

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"wx49f5154e812da61d"
path	string	是	通过二维码进入的小程序页面路径	"pages/index/index"

响应

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

无

POST

/api/view/create

商城视图配置接口创建商城视图配置接口 OperationId: create

调用方法

POST /api/view/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CreateViewDTO com.leadwaycloud.rm.mall.business.view.dto.CreateViewDTO

名称	类型	必填	说明	示例
merchantId	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"
type	string	是	视图类型【 GLOBAL_PARAMETERS : 全局设置 START_PAGE : 启动页 LANDING_PAGE : 引导页 LOGIN_PAGE : 登陆页 HOME_PAGE : 首页 QA_PAGE : QA TRIP_PAGE : 旅程 ITEM_DETAIL_PAGE : 商品详情页 PAYMENT_PAGE : 付款页 PERSON_CENTER_PAGE : 个人中心 MY_BILLS : 账单 MIX_PAGE : 混合页】	"FRONT_PAGE"
version	string	是	版本号	"V1"
content	string	是	视图配置	"..."

响应

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

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

POST

/api/shopping-cart/submit-item/{shoppingCartId}

购物车管理接口购物车品项变更接口(以商品条码为基础。已有则更新,否则新增,数量为0则删除) OperationId: submitItem

调用方法

POST /api/shopping-cart/submit-item/{shoppingCartId}

参数

名称	位置	必填	类型	说明	示例
shoppingCartId	path	是	integer(int64)	购物车ID	1

请求体

Content-Type: application/json 必填: 是 类型: SubmitItemDTO[] com.leadwaycloud.rm.mall.business.history.dto.shoppingCart.SubmitItemDTO

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

响应

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

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

POST

/api/self-pickup-outlets/add

商城自提网点接口创建商城自提网点接口 OperationId: addWechatConfig

调用方法

POST /api/self-pickup-outlets/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CreateSelfPickupOutletsDTO com.leadwaycloud.rm.mall.business.pickup.outlets.dto.CreateSelfPickupOutletsDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"银泰城永辉超市"
code	string	是	标识	"...."
type	string	是	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	是	联络人	"张三"
phone	string	是	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	是	是否可用	true
latLon	string	是	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

响应

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

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

POST

/api/refund-address/add

商城退货地址接口添加商城退货地址接口 OperationId: addWechatConfig_1

调用方法

POST /api/refund-address/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: RefundAddressDTO com.leadwaycloud.rm.mall.business.refund.address.dto.RefundAddressDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
country	integer(int64)	是	国家	1
province	integer(int64)	是	省份	1
city	integer(int64)	是	城市	1
area	integer(int64)	是	区	1
street	integer(int64)	是	街道	1
detailAddress	string	是	详细地址	"..."
receiver	string	是	收货人
phone	string	是	电话

响应

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

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

POST

/api/mall-shopping-cart/update

购物车业务接口购物车列表商品变更接口 OperationId: update_4

调用方法

POST /api/mall-shopping-cart/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ShoppingCartUpdateReqDTO com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartUpdateReqDTO

名称	类型	必填	说明	示例
shoppingCartId	integer(int64)	是	购物车ID	1
customerId	integer(int64)	否	客户ID	1
customerContactPersonId	integer(int64)	否	客户联系人ID	1
itemBarcodeList	ShoppingCartUpdateReqDTO$UpdateItemBarcodeDTO[]	是	变更零管商品条码(为空表示清空购物车)

响应

状态码: 200 说明: OK Content-Type: */* 类型: ShoppingCartVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO

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

POST

/api/mall-shopping-cart/create

购物车业务接口购物车创建接口 OperationId: create_1

调用方法

POST /api/mall-shopping-cart/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ShoppingCartCreateReqDTO com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartCreateReqDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
memberId	integer(int64)	是	会员ID	1

响应

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

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

POST

/api/mall-shopping-cart/append-item

购物车业务接口购物车追加商品接口 OperationId: appendItem

调用方法

POST /api/mall-shopping-cart/append-item

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ShoppingCartAppendItemReqDTO com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartAppendItemReqDTO

名称	类型	必填	说明	示例
shoppingCartId	integer(int64)	是	购物车ID	1
itemBarcodeId	integer(int64)	是	零管商品条码	1
qty	integer(int32)	否	商品数量	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/mall-logistics/query

物流查询接口物流查询接口 OperationId: query

调用方法

POST /api/mall-logistics/query

参数

无

请求体

Content-Type: application/json 必填: 是 类型: LogisticsQueryReqDTO com.leadwaycloud.rm.mall.business.logistics.model.LogisticsQueryReqDTO

名称	类型	必填	说明	示例
expressOrderCode	string	是	快递单号	"SALE"

响应

状态码: 200 说明: OK Content-Type: */* 类型: LogisticsVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.logistics.model.LogisticsVO

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

POST

/api/mall-controller/update

收藏业务接口商品收藏变更接口 OperationId: update_5

调用方法

POST /api/mall-controller/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CollectUpdateItemDTO com.leadwaycloud.rm.mall.business.collect.model.dto.CollectUpdateItemDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
memberType	string	是	会员类型	"INTERNAL"
itemId	integer(int64)	是	零管商品ID	1
itemBarcodeId	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/mall-controller/delete

收藏业务接口商品收藏删除接口 OperationId: delete

调用方法

POST /api/mall-controller/delete

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CollectDeleteItemDTO com.leadwaycloud.rm.mall.business.collect.model.dto.CollectDeleteItemDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
itemList	integer(int64)[]	否	需要删除的零管商品或条码(未提供清空全部)

响应

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

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

POST

/api/express/add

合作快递公司管理接口新增合作快递公司接口 OperationId: add

调用方法

POST /api/express/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddExpressDTO com.leadwaycloud.rm.mall.business.express.dto.AddExpressDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
sysExpressId	integer(int64)	是	快递公司ID	1
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

响应

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

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

POST

/api/express/add/express-scope

合作快递公司管理接口新增配送范围接口 OperationId: addExpressScope

调用方法

POST /api/express/add/express-scope

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddExpressScopeDTO com.leadwaycloud.rm.mall.business.express.dto.AddExpressScopeDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
countryId	integer(int64)	是	国家ID	1
provinceId	integer(int64)	否	省份ID	1
cityId	integer(int64)	否	城市ID	1
minFreeFareOrderAmount	number(double)	是	最小免费配送订单金额	100
fare	number(double)	是	运费	10

响应

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

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

POST

/api/distribution-rule/add

分销规则接口添加分销规则接口 OperationId: add_1

调用方法

POST /api/distribution-rule/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddDistributionRuleDTO com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionRuleDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
active	boolean	是	是否开启分销	false
openApplyExamine	boolean	是	是否开启分销申请审核	false
specifyItem	boolean	是	是否开放店铺指定分销商品	false
rebateExtractExamine	boolean	是	是否开启佣金提取审核	false
settlementCycle	string	是	结算周期【 WEEK : 周 MONTH : 月】	"WEEK"
settlementDay	integer(int32)	是	结算日	1
distributionMethod	string	是	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
rebatePercent1	number(double)	是	一级提成比例
rebatePercent2	number(double)	是	二级提成比例
rebatePercent3	number(double)	是	三级提成比例
memberAccountTypeId	integer(int64)	是	佣金提取账户类型ID	1
distributionExplain	string	否	分销说明	"..."

响应

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

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

POST

/api/distribution-member/manual-distribution-settlement/{distributionMemberId}

分销成员接口手工发起分销成员分销结算操作接口 OperationId: manualDistributionSettlement

分销成员在分销日结束后系统没有自动结算时可使用此接口

调用方法

POST /api/distribution-member/manual-distribution-settlement/{distributionMemberId}

参数

名称	位置	必填	类型	说明	示例
distributionMemberId	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/distribution-member/get/initiator-code/{id}

分销成员接口获取分销成员分销邀请码接口 OperationId: getMemberDistributionInitiatorCode

调用方法

POST /api/distribution-member/get/initiator-code/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

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

POST

/api/distribution-item/add

分销商品接口添加分销商品接口 OperationId: add_2

调用方法

POST /api/distribution-item/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddDistributionItemDTO com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionItemDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
itemList	integer(int64)[]	是	零管商品ID

响应

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

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

POST

/api/distribution-apply/process/distribution-extract-rebate/{id}

分销申请接口处理会员佣金提取申请接口 OperationId: processDistributionApply

调用方法

POST /api/distribution-apply/process/distribution-extract-rebate/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: ProcessDistributionExtractRebateApplyDTO com.leadwaycloud.rm.mall.business.distribution.dto.ProcessDistributionExtractRebateApplyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否审核通过	false
message	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/distribution-apply/process/distribution-apply/{id}

分销申请接口处理分销申请接口 OperationId: processDistributionApply_1

调用方法

POST /api/distribution-apply/process/distribution-apply/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: ProcessDistributionApplyDTO com.leadwaycloud.rm.mall.business.distribution.dto.ProcessDistributionApplyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否审核通过	false
message	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/distribution-apply/apply/join-distribution

分销申请接口申请加入分销计划接口 OperationId: joinDistributionApply

调用方法

POST /api/distribution-apply/apply/join-distribution

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddDistributionApplyDTO com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionApplyDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
memberId	integer(int64)	是	会员ID	1
initiatorCode	string	否	邀请码	"D723N2WD"

响应

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

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

POST

/api/distribution-apply/apply/distribution-extract-rebate

分销申请接口申请分销佣金提取接口 OperationId: distributionExtractRebateApply

调用方法

POST /api/distribution-apply/apply/distribution-extract-rebate

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddDistributionExtractRebateApplyDTO com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionExtractRebateApplyDTO

名称	类型	必填	说明	示例
distributionMemberId	integer(int64)	是	分销成员ID	1
extractVal	number(double)	是	提取佣金额度	100

响应

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

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

POST

/api/common/get/api-connection-token/{merchantId}/{companyId}

商城公共接口获取商城接口通讯Token接口(Token 24小时有效) OperationId: getAPIConnectionToken

调用方法

POST /api/common/get/api-connection-token/{merchantId}/{companyId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
companyId	path	是	integer(int64)	公司ID	1

请求体

无

响应

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

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

POST

/api/collect/add

收藏管理接口添加会员收藏接口 OperationId: add_3

调用方法

POST /api/collect/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddCollectDTO com.leadwaycloud.rm.mall.business.history.dto.collect.AddCollectDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
memberType	string	是	会员类型	"INTERNAL"
itemId	integer(int64)	是	零管商品ID	1
notes	string	否	备注

响应

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

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

POST

/api/article/create

商城图文创建商城图文接口 OperationId: createArticle

调用方法

POST /api/article/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CreateArticleDTO com.leadwaycloud.rm.mall.business.article.dto.CreateArticleDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
title	object	是	主题	"今日美味特供"
categoryId	string	是	图文分类
config	JSONObject	否
content	JSONObject	是
startDate	string	是	开始日期	"2021-11-01"
endDate	string	是	结束日期	"2021-11-11"
startTime	string	否	开始时间	"08:00:00"
endTime	string	否	结束时间	"10:00:00"
active	boolean	是	是否启用	true

响应

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

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

POST

/api/article/category/create

商城图文创建商城图文分类接口 OperationId: createArticleCategory

调用方法

POST /api/article/category/create

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CreateArticleCategoryDTO com.leadwaycloud.rm.mall.business.article.dto.CreateArticleCategoryDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	分类名	"Child Today"
type	string	是	分类类型	"NEWS"
images	string	否	图片
icon	string	否	图片
orderSequence	integer(int32)	否	排序	1
status	string	否	状态	"ACTIVE"
parentId	integer(int64)	否	父级分类ID

响应

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

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

POST

/api/application/add

商城应用配置接口创建商城应用接口 OperationId: addWechatConfig_2

调用方法

POST /api/application/add

参数

无

请求体

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

名称	类型	必填	说明	示例
arg0	CreateApplicationDTO	是
certificateFile	string(binary)	否

响应

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

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

POST

/api/application-deploy-config/query-multi-application

应用部署配置接口查询多个应用配置 OperationId: queryMultiApplication

调用方法

POST /api/application-deploy-config/query-multi-application

参数

无

请求体

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

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

响应

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

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

POST

/api/application-deploy-config/add

应用部署配置接口创建应用配置 OperationId: add_4

调用方法

POST /api/application-deploy-config/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CreateApplicationDeployConfigDTO com.leadwaycloud.rm.mall.business.application.dto.CreateApplicationDeployConfigDTO

名称	类型	必填	说明	示例
config	string	是	配置
applicationId	integer(int64)	是	应用ID	1
merchantId	integer(int64)	是	商户ID	1

响应

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

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

POST

/api/active/submit/vote/member-active-item-record

商城活动提交会员参与投票活动项目记录接口 OperationId: submitMemberActiveItemRecord

调用方法

POST /api/active/submit/vote/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddVoteActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemInfo	AddVoteActiveItemRecordDTO$ActiveItemInfoBO[]	是	活动项目信息

响应

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

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

POST

/api/active/submit/sign/member-active-item-record

商城活动提交会员参与签到活动项目记录接口 OperationId: submitMemberActiveItemRecord_1

调用方法

POST /api/active/submit/sign/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddSignActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
isAbandon	boolean	否	是否放弃奖品	false
giftGoodsOrderId	integer(int64)	否	赠品订单ID(页面引导创建赠品订单)，连续签到与单日签到都是发放赠品需要合并成一个订单

响应

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

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

POST

/api/active/submit/scratch_card/member-active-item-record

商城活动提交会员参与刮刮卡活动项目记录接口 OperationId: submitMemberActiveItemRecord_2

提供任意一个活动项目，接口会回传中奖的信息

调用方法

POST /api/active/submit/scratch_card/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddScratchCardActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1

响应

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

POST

/api/active/submit/roulette/member-active-item-record

商城活动提交会员参与轮盘活动项目记录接口 OperationId: submitMemberActiveItemRecord_3

提供任意一个活动项目，接口会回传中奖的信息

调用方法

POST /api/active/submit/roulette/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddRouletteActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1

响应

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

POST

/api/active/submit/questionnaire/member-active-item-record

商城活动提交会员参与问卷调查活动项目记录接口 OperationId: submitMemberActiveItemRecord_4

调用方法

POST /api/active/submit/questionnaire/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddQuestionnaireActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
answerContent	string	是	答题内容	"{}"

响应

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

POST

/api/active/submit/punch_clock/member-active-item-record

商城活动提交会员参与打卡活动项目记录接口 OperationId: submitMemberActiveItemRecord_5

调用方法

POST /api/active/submit/punch_clock/member-active-item-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddPunchClockActiveItemRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
images	string	否	照片	"[]"
notes	string	否	文字描述	"1"
lon	number(double)	是	经度	104.064737
lat	number(double)	是	纬度	32.684897

响应

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

POST

/api/active/submit/member-active-record

商城活动提交会员参与活动记录接口 OperationId: submitMemberActiveRecord

调用方法

POST /api/active/submit/member-active-record

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddActiveMemberRecordDTO com.leadwaycloud.rm.mall.business.active.dto.add.AddActiveMemberRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
isAbandon	boolean	否	是否放弃奖品	false
giftGoodsOrderId	integer(int64)	否	赠品订单ID(页面引导创建赠品订单)

响应

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

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

POST

/api/active/create/vote

商城活动创建商城投票活动接口 OperationId: createActive

调用方法

POST /api/active/create/vote

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddVoteActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	VoteActiveConfigBO	是

响应

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

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

POST

/api/active/create/sign

商城活动创建商城签到活动接口 OperationId: createActive_1

调用方法

POST /api/active/create/sign

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddSignActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	SignActiveConfigBO	是

响应

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

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

POST

/api/active/create/scratch-card

商城活动创建商城刮刮卡活动接口 OperationId: createActive_2

调用方法

POST /api/active/create/scratch-card

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddScratchCardActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	ScratchCardActiveConfigBO	是

响应

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

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

POST

/api/active/create/roulette

商城活动创建商城轮盘活动接口 OperationId: createActive_3

调用方法

POST /api/active/create/roulette

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddRouletteActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	RouletteActiveConfigBO	是

响应

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

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

POST

/api/active/create/questionnaire

商城活动创建问卷调查活动接口 OperationId: createActive_4

调用方法

POST /api/active/create/questionnaire

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddQuestionnaireActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	QuestionnaireActiveConfigBO	是

响应

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

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

POST

/api/active/create/questionnaire/vote

商城活动创建商城问卷调查活动项目接口 OperationId: createActiveItem

调用方法

POST /api/active/create/questionnaire/vote

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddQuestionnaireActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	QuestionnaireActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/punch-clock

商城活动创建商城打卡活动接口 OperationId: createActive_5

调用方法

POST /api/active/create/punch-clock

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddPunchClockActiveDTO com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	PunchClockActiveConfigBO	是

响应

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

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

POST

/api/active/create/item/vote

商城活动创建商城投票活动项目接口 OperationId: createActiveItem_1

调用方法

POST /api/active/create/item/vote

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddVoteActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	VoteActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/item/sign

商城活动创建商城签到活动项目接口 OperationId: createActiveItem_2

调用方法

POST /api/active/create/item/sign

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddSignActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	SignActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/item/scratch-card

商城活动创建商城刮刮卡活动项目接口 OperationId: createActiveItem_3

调用方法

POST /api/active/create/item/scratch-card

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddScratchCardActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	ScratchCardActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/item/roulette

商城活动创建商城轮盘活动项目接口 OperationId: createActiveItem_4

调用方法

POST /api/active/create/item/roulette

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddRouletteActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	RouletteActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/item/punch-clock

商城活动创建商城打卡活动项目接口 OperationId: createActiveItem_5

调用方法

POST /api/active/create/item/punch-clock

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddPunchClockActiveItemDTO com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	PunchClockActiveItemConfigBO	是

响应

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

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

POST

/api/active/create/condition

商城活动添加活动条件接口 OperationId: addCondition

调用方法

POST /api/active/create/condition

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddActiveConditionDTO com.leadwaycloud.rm.mall.business.active.dto.add.AddActiveConditionDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
type	string	是	类型【 ACTIVE : 活动 ORDER_AMOUNT : 订单交易金额 MEMBER : 会员 MEMBER_TYPE : 会员类型】	"ACTIVE"
value	string	是	值
attachment	string	否	自定义数据(json格式)

响应

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

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

POST

/api/active/calc/lon-lat/distance

商城活动计算坐标距离接口 OperationId: calcLonLatDistance

调用方法

POST /api/active/calc/lon-lat/distance

参数

无

请求体

Content-Type: application/json 必填: 是 类型: DistanceDTO[] com.leadwaycloud.rm.mall.business.active.dto.query.DistanceDTO

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

响应

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

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

GET

/api/wechat/verify/{mpName}

微信接口验证文件 OperationId: verify

验证文件Mp-

调用方法

GET /api/wechat/verify/{mpName}

参数

名称	位置	必填	类型	说明	示例
mpName	path	是	string

请求体

无

响应

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

无

GET

/api/wechat/userInfo

微信接口获取微信用户信息 OperationId: userInfo

商户号、公司ID为可选项。独立部署可不提供，会从配置文件中抓取微信配置信息；非独立部署则需要提供商户号或者公司ID供接口查询微信配置信息(如果提供了公司ID则优先查询该公司的微信配置，提供商户号则查询总部公司的微信配置)

调用方法

GET /api/wechat/userInfo

参数

名称	位置	必填	类型	说明
code	query	是	string	微信返回的Code
merchantCode	query	否	string	商户号
companyId	query	否	integer(int64)	公司ID

请求体

无

响应

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

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

GET

/api/wechat/codeUrl

微信接口生成验证跳转地址 OperationId: codeUrl

调用方法

GET /api/wechat/codeUrl

参数

名称	位置	必填	类型	说明
redirectUri	query	是	string	地址
merchantCode	query	否	string	商户号
companyId	query	否	integer(int64)	公司ID

请求体

无

响应

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

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

GET

/api/view/query/{id}

商城视图配置接口查询商城视图配置(ID)接口 OperationId: query_1

调用方法

GET /api/view/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城视图ID	1

请求体

无

响应

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

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

GET

/api/view/query/{companyId}/{channel}/{type}

商城视图配置接口查询公司渠道下指定类型可用的商城视图配置接口 OperationId: queryCompanyChannelTypeView

调用方法

GET /api/view/query/{companyId}/{channel}/{type}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
channel	path	是	string	渠道	"ONLINE"
type	path	是	string	类型	"FRONT_PAGE"

请求体

无

响应

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

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

GET

/api/view/query/setting-active-start-page-company/{merchantId}/{channel}

商城视图配置接口查询配置并启用了商城启动页的公司接口 OperationId: querySettingActiveStartPageCompany

调用方法

GET /api/view/query/setting-active-start-page-company/{merchantId}/{channel}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
channel	path	是	string	渠道	"WECHAT_MINI_APPS"

请求体

无

响应

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

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

GET

/api/view/query-page

商城视图配置接口查询商城视图配置(分页)接口 OperationId: query_2

调用方法

GET /api/view/query-page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
channel	query	否	string	渠道	"ONLINE"
type	query	否	string	视图类型	"FRONT_PAGE"
version	query	否	string	版本号	"V1"
active	query	否	boolean	是否启用	false

请求体

无

响应

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

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

GET

/api/view/query-list/{merchantId}/{channel}/{type}

商城视图配置接口查询商户所有公司指定渠道下的可用商城视图配置接口 OperationId: queryMerchantChannelTypeView

调用方法

GET /api/view/query-list/{merchantId}/{channel}/{type}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
channel	path	是	string	渠道	"ONLINE"
type	path	是	string	类型	"FRONT_PAGE"

请求体

无

响应

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

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

GET

/api/shopping-cart/query/{merchantId}/{companyId}/{memberId}/{channel}

购物车管理接口查询会员购物车接口 OperationId: query_3

调用方法

GET /api/shopping-cart/query/{merchantId}/{companyId}/{memberId}/{channel}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	integer(int64)	会员ID	1
channel	path	是	string	渠道	"ONLINE"

请求体

无

响应

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

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

GET

/api/shopping-cart/query-item/{shoppingCartId}

购物车管理接口查询会员购物车内品项接口 OperationId: queryItem

调用方法

GET /api/shopping-cart/query-item/{shoppingCartId}

参数

名称	位置	必填	类型	说明	示例
shoppingCartId	path	是	integer(int64)	购物车ID	1

请求体

无

响应

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

GET

/api/self-pickup-outlets/query/{id}

商城自提网点接口查询商城自提网点(ID)接口 OperationId: query_4

调用方法

GET /api/self-pickup-outlets/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城自提网点ID	1

请求体

无

响应

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

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

GET

/api/self-pickup-outlets/query/by-code/{merchantId}/{code}

商城自提网点接口查询商城自提网点(Code)接口 OperationId: queryByCode

调用方法

GET /api/self-pickup-outlets/query/by-code/{merchantId}/{code}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
code	path	是	string	网点标识	"CD01"

请求体

无

响应

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

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

GET

/api/self-pickup-outlets/query-page

商城自提网点接口查询商城自提网点(分页)接口 OperationId: queryPage

调用方法

GET /api/self-pickup-outlets/query-page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
name	query	否	string	名称	"银泰城永辉超市"
code	query	否	string	标识	"...."
type	query	否	string	类型	"OUTLETS"
contactPerson	query	否	string	联络人	"张三"
phone	query	否	string	电话	13888888888
address	query	否	string	地址	"银泰城负一楼永辉超市"
active	query	否	boolean	是否可用	true

请求体

无

响应

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

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

GET

/api/self-pickup-outlets/query-list/{companyId}

商城自提网点接口查询公司可用的商城自提网点接口 OperationId: queryList

调用方法

GET /api/self-pickup-outlets/query-list/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1

请求体

无

响应

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

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

GET

/api/refund-address/query/{id}

商城退货地址接口查询商城退货地址(ID)接口 OperationId: query_5

调用方法

GET /api/refund-address/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	查询商城退货地址ID	1

请求体

无

响应

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

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

GET

/api/refund-address/query/company/{companyId}

商城退货地址接口查询公司商城退货地址接口 OperationId: queryCompanyAddress

调用方法

GET /api/refund-address/query/company/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1

请求体

无

响应

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

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

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/mall-shopping-cart/search

购物车业务接口购物车搜索接口 OperationId: search

调用方法

GET /api/mall-shopping-cart/search

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	long	公司ID	1
memberId	query	是	long	会员ID	1
customerId	query	否	long	客户ID	1
customerContactPersonId	query	否	long	客户联系人ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ShoppingCartVO com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO

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

GET

/api/mall-controller/search

收藏业务接口商品收藏搜索接口 OperationId: search_1

调用方法

GET /api/mall-controller/search

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	long	公司ID	1
memberId	query	是	long	会员ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CollectItemVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.business.collect.model.vo.CollectItemVO

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

GET

/api/express/query/{id}

合作快递公司管理接口查询合作快递公司(ID)接口 OperationId: query_6

调用方法

GET /api/express/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	合作快递公司ID	1

请求体

无

响应

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

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

GET

/api/express/query/order/express-fare

合作快递公司管理接口查询订单配送费接口 OperationId: queryOrderFare

调用方法

GET /api/express/query/order/express-fare

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	long	公司ID	1
orderAmount	query	是	double	订单金额	100
countryId	query	是	long	国家ID	1
provinceId	query	是	long	省份ID	1
cityId	query	是	long	城市ID	1

请求体

无

响应

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

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

GET

/api/express/query/order-delivery-logistics/{expressOrderCode}

合作快递公司管理接口根据快递单号查询订单配送信息接口 OperationId: queryOrderDeliveryLogistics

调用方法

GET /api/express/query/order-delivery-logistics/{expressOrderCode}

参数

名称	位置	必填	类型	说明	示例
expressOrderCode	path	是	string	快递单号	"SF0000000000"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: JSONObject com.leadwaycloud.core.model.RCom.alibaba.fastjson2.JSONObject

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

GET

/api/express/query/express-scope/{expressScopeId}

合作快递公司管理接口查询配送范围(ID)接口 OperationId: queryExpressScope

调用方法

GET /api/express/query/express-scope/{expressScopeId}

参数

名称	位置	必填	类型	说明	示例
expressScopeId	path	是	integer(int64)	配送范围ID	1

请求体

无

响应

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

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

GET

/api/express/query/administrative-divisions

合作快递公司管理接口获取五级联动数据接口 OperationId: getAdministrativeDivisions

调用方法

GET /api/express/query/administrative-divisions

参数

名称	位置	必填	类型	说明	示例
type	query	是	string	类型	"COUNTRY"
parentId	query	否	long	上一级ID(国家/地区类型时,可不提供)	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.business.express.vo.AddressVO

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

GET

/api/express/query-page/sys

合作快递公司管理接口查询系统快递公司(分页)接口 OperationId: querySysExpress

调用方法

GET /api/express/query-page/sys

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/express/query-page/express-scope

合作快递公司管理接口查询配送范围(分页)接口 OperationId: queryExpressScope_1

调用方法

GET /api/express/query-page/express-scope

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
companyId	query	是	long	公司ID	1

请求体

无

响应

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

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

GET

/api/express/query-list

合作快递公司管理接口查询合作快递公司(列表)接口 OperationId: query_7

调用方法

GET /api/express/query-list

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	long	公司ID	1
active	query	否	boolean	是否开放	true

请求体

无

响应

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

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

GET

/api/distribution-rule/query/{id}

分销规则接口查询分销规则(ID)接口 OperationId: query_8

调用方法

GET /api/distribution-rule/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

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

GET

/api/distribution-rule/query/merchant/{merchantId}

分销规则接口查询分销规则(商户ID)接口 OperationId: queryByMerchant

调用方法

GET /api/distribution-rule/query/merchant/{merchantId}

参数

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

请求体

无

响应

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

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

GET

/api/distribution-rule/query-page/change-log/{id}

分销规则接口查询分销规则变更日志接口 OperationId: queryChangeLog

调用方法

GET /api/distribution-rule/query-page/change-log/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/distribution-member/query/{id}

分销成员接口查询分销成员(ID)接口 OperationId: query_9

调用方法

GET /api/distribution-member/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

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

GET

/api/distribution-member/query/merchant/{merchantId}

分销成员接口查询商户分销成员(商户ID)接口 OperationId: queryByMember

调用方法

GET /api/distribution-member/query/merchant/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/distribution-member/query/member/{memberId}

分销成员接口查询分销成员(会员ID)接口 OperationId: queryByMember_1

调用方法

GET /api/distribution-member/query/member/{memberId}

参数

名称	位置	必填	类型	说明	示例
memberId	path	是	integer(int64)	会员ID	1

请求体

无

响应

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

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

GET

/api/distribution-member/query/distribution-member-order/{id}

分销成员接口查询分销成员分销订单接口 OperationId: queryDistributionMemberOrder

注意非对应级别的分销成员数据不可呈现在页面

调用方法

GET /api/distribution-member/query/distribution-member-order/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/distribution-member/query/distribution-group/{id}/{level}

分销成员接口查询分销团队成员接口 OperationId: queryDistributionGroup

调用方法

GET /api/distribution-member/query/distribution-group/{id}/{level}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1
level	path	是	integer(int32)	分销级别(只会存在三级)	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/distribution-member/query/distribution-group-member-count/{id}

分销成员接口查询分销团队成员人数接口 OperationId: queryDistributionGroupMemberCount

调用方法

GET /api/distribution-member/query/distribution-group-member-count/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

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

GET

/api/distribution-item/query/{companyId}

分销商品接口查询公司分销商品接口 OperationId: queryCompanyDistributionItem

调用方法

GET /api/distribution-item/query/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/distribution-apply/query-page/join-distribution-apply

分销申请接口查询商户会员分销申请接口 OperationId: queryDistributionApply

调用方法

GET /api/distribution-apply/query-page/join-distribution-apply

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
arg2	query	是	QueryDistributionApplyDTO

请求体

无

响应

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

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

GET

/api/distribution-apply/query-page/distribution-extract-rebate

分销申请接口查询商户会员佣金提取申请接口 OperationId: queryDistributionExtractRebateApply

调用方法

GET /api/distribution-apply/query-page/distribution-extract-rebate

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
arg2	query	是	QueryDistributionExtractRebateApplyDTO

请求体

无

响应

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

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

GET

/api/common/get/open-mini-apps-company/{merchantId}/{method}

商城公共接口查询商户开启了小程序商城的门店接口 OperationId: getOpenMiniAppsCompany

调用方法

GET /api/common/get/open-mini-apps-company/{merchantId}/{method}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
method	path	是	string	识别方式(APPLICATION:应用 MALL_VIEW:商城启动页)	"MALL_VIEW"

请求体

无

响应

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

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

GET

/api/collect/query/collect-item/{itemId}/{memberId}

收藏管理接口查询商品收藏情况接口 OperationId: queryCollectItem

调用方法

GET /api/collect/query/collect-item/{itemId}/{memberId}

参数

名称	位置	必填	类型	说明	示例
itemId	path	是	integer(int64)	商品ID	1
memberId	path	是	string	会员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

/api/collect/query-page/{companyId}/{memberId}

收藏管理接口查询会员收藏(分页)接口 OperationId: query_10

调用方法

GET /api/collect/query-page/{companyId}/{memberId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	string	会员ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
memberType	query	否	long	会员类型默认内部	"INTERNAL"
itemId	query	否	long	零管销售商品

请求体

无

响应

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

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

GET

/api/article/query/{id}

商城图文查询商城图文(ID)接口 OperationId: queryArticle

调用方法

GET /api/article/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	图文ID	1

请求体

无

响应

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

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

GET

/api/article/query-page

商城图文查询商城图文(分页)接口 OperationId: queryPagedArticle

调用方法

GET /api/article/query-page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
categoryId	query	否	string	图文分类
type	query	否	string	图文类型	"today"
title	query	否	string	图文主题
startDate	query	否	string	开始日期	"2021-11-01"
startTime	query	否	string	开始时间	"15:30:29"
endDate	query	否	string	结束日期	"2021-11-11"
endTime	query	否	string	结束时间	"15:30:29"
active	query	否	boolean	是否启用	true
sort	query	否	string	排序	"date,asc"

请求体

无

响应

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

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

GET

/api/article/dynamic-query

商城图文动态查询商城图文接口 OperationId: dynamicQueryPagedArticle

调用方法

GET /api/article/dynamic-query

参数

名称	位置	必填	类型	说明	示例
page	query	否	integer(int32)	查询页码	0
size	query	否	integer(int32)	查询页行数	10
search	query	否	string	动态查询参数
sort	query	否	string	动态排序	"startDate,asc"

请求体

无

响应

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

GET

/api/article/category/query/{id}

商城图文查询商城图文分类(ID)接口 OperationId: queryArticleCategory

调用方法

GET /api/article/category/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	图文分类ID	1

请求体

无

响应

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

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

GET

/api/article/category/query/company/{companyId}

商城图文查询公司图文分类接口 OperationId: queryCompanyArticleCategory

调用方法

GET /api/article/category/query/company/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
type	query	否	string	分类类型	"today"
status	query	否	string	状态	"ACTIVE"
parentId	query	否	integer(int64)	位置

请求体

无

响应

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

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

GET

/api/application/query/{id}

商城应用配置接口查询商城应用(ID)接口 OperationId: query_11

调用方法

GET /api/application/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城应用ID	1

请求体

无

响应

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

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

GET

/api/application/query/setting-application-company/{merchantId}/{type}

商城应用配置接口查询配置了应用的公司接口 OperationId: querySettingApplicationCompany

调用方法

GET /api/application/query/setting-application-company/{merchantId}/{type}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
type	path	是	string	应用类型	"MINI_APPS"

请求体

无

响应

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

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

GET

/api/application/query/by-code/{code}

商城应用配置接口查询商城应用(Code)接口 OperationId: queryByCode_1

调用方法

GET /api/application/query/by-code/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是	string	应用标识	"..."

请求体

无

响应

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

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

GET

/api/application/query-list/{companyId}

商城应用配置接口查询商城应用(列表)接口 OperationId: queryList_1

调用方法

GET /api/application/query-list/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1

请求体

无

响应

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

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

GET

/api/application/export-mp-check-file/{id}

商城应用配置接口下载商城应用公众号校验文件接口 OperationId: export

调用方法

GET /api/application/export-mp-check-file/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	商城应用ID	1

请求体

无

响应

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

无

GET

/api/application-deploy-config/query/{applicationId}

应用部署配置接口查询应用配置 OperationId: query_12

调用方法

GET /api/application-deploy-config/query/{applicationId}

参数

名称	位置	必填	类型	说明	示例
applicationId	path	是	integer(int64)	应用ID	1

请求体

无

响应

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

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

GET

/api/active/query

商城活动查询商城活动接口(分页) OperationId: queryActive

调用方法

GET /api/active/query

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
type	query	否	string	类型	"PUNCH_CLOCK"
title	query	否	string	主题	"..."
activeDate	query	否	string	活动日期	"2021-11-01"
active	query	否	boolean	是否启用	true

请求体

无

响应

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

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

GET

/api/active/query/{id}

商城活动查询商城活动接口(单个) OperationId: queryActive_1

调用方法

GET /api/active/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

GET

/api/active/query/{id}/{memberId}

商城活动查询商城会员活动接口(单个) OperationId: queryActive_2

调用方法

GET /api/active/query/{id}/{memberId}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1
memberId	path	是	integer(int64)	会员ID	1

请求体

无

响应

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

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

GET

/api/active/query/{companyId}/{memberId}/{type}

商城活动查询会员可参与的指定类型活动接口 OperationId: queryMemberJoinActive

调用方法

GET /api/active/query/{companyId}/{memberId}/{type}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	integer(int64)	会员ID	1
type	path	是	string	活动类型

请求体

无

响应

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

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

GET

/api/active/query/member-active-record/{memberId}/{activeId}

商城活动查询会员参与活动记录接口 OperationId: queryMemberActiveRecord

调用方法

GET /api/active/query/member-active-record/{memberId}/{activeId}

参数

名称	位置	必填	类型	说明	示例
memberId	path	是	integer(int64)	会员ID	1
activeId	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

GET

/api/active/query/list

商城活动查询商城活动接口(分页) OperationId: queryActive_3

调用方法

GET /api/active/query/list

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	long	商户ID	1
companyId	query	否	long	公司ID	1
type	query	否	string	类型	"PUNCH_CLOCK"
title	query	否	string	主题	"..."
activeDate	query	否	string	活动日期	"2021-11-01"
active	query	否	boolean	是否启用	true
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/active/query/item/{id}

商城活动查询活动项目 OperationId: deleteActive_1

调用方法

GET /api/active/query/item/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

GET

/api/active/query/gift-order/{id}

商城活动查询活动奖品订单接口 OperationId: queryActiveGiftOrder

调用方法

GET /api/active/query/gift-order/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

GET

/api/active/query/count/{companyId}/{memberId}

商城活动查询会员未参与的所有类型活动数量接口 OperationId: queryMemberUnJoinActiveCount

调用方法

GET /api/active/query/count/{companyId}/{memberId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	integer(int64)	会员ID	1

请求体

无

响应

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

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

GET

/api/active/query/condition/{id}

商城活动查询活动条件接口 OperationId: queryCondition

调用方法

GET /api/active/query/condition/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动条件ID	1

请求体

无

响应

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

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

GET

/api/active/query/active/condition/{id}

商城活动查询活动条件接口 OperationId: queryActiveCondition

调用方法

GET /api/active/query/active/condition/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

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

GET

/api/active/query/active-member-record/{memberId}/{activeItemId}

商城活动查询会员参与活动项目记录接口 OperationId: queryActiveMemberRecord

调用方法

GET /api/active/query/active-member-record/{memberId}/{activeItemId}

参数

名称	位置	必填	类型	说明	示例
memberId	path	是	integer(int64)	会员ID	1
activeItemId	path	是	integer(int64)	活动项目ID	1

请求体

无

响应

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

GET

/api/active/query/active-member-record/{activeId}

商城活动查询活动会员参与记录接口 OperationId: queryActiveMemberRecord_1

调用方法

GET /api/active/query/active-member-record/{activeId}

参数

名称	位置	必填	类型	说明	示例
activeId	path	是	integer(int64)	活动ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

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

GET

/api/active/query/active-item-join-member-count/{activeId}

商城活动查询活动各个项目参与人数接口 OperationId: queryActiveItemJoinMemberCount

调用方法

GET /api/active/query/active-item-join-member-count/{activeId}

参数

名称	位置	必填	类型	说明	示例
activeId	path	是	integer(int64)	活动ID	1

请求体

无

响应

状态码: 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	否	返回数据

GET

/api/active/query/active-all-member-active-item-record/{memberId}/{activeId}

商城活动查询会员参与活动项目记录接口 OperationId: queryActiveAllMemberActiveItemRecord

调用方法

GET /api/active/query/active-all-member-active-item-record/{memberId}/{activeId}

参数

名称	位置	必填	类型	说明	示例
memberId	path	是	integer(int64)	会员ID	1
activeId	path	是	integer(int64)	活动ID	1

请求体

无

响应

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

DELETE

/api/view/remove/{id}

商城视图配置接口删除商城视图配置接口(物理删除) OperationId: remove

调用方法

DELETE /api/view/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/view/enable/{id}

商城视图配置接口启用商城视图配置接口(启用时会停用相同渠道下相同类型的其他视图) OperationId: enable

调用方法

DELETE /api/view/enable/{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/express/remove/{id}

合作快递公司管理接口删除合作快递公司接口(物理删除) OperationId: remove_1

调用方法

DELETE /api/express/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/express/remove/express-scope/{expressScopeId}

合作快递公司管理接口删除配送范围接口(物理删除) OperationId: removeExpressScope

调用方法

DELETE /api/express/remove/express-scope/{expressScopeId}

参数

名称	位置	必填	类型	说明	示例
expressScopeId	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/distribution-item/remove

分销商品接口删除分销商品接口 OperationId: remove_2

物理删除

调用方法

DELETE /api/distribution-item/remove

参数

无

请求体

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

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

响应

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

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

DELETE

/api/distribution-item/clear/merchant/{merchantId}

分销商品接口清除商户分销商品接口 OperationId: clearByMerchant

物理删除

调用方法

DELETE /api/distribution-item/clear/merchant/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	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/distribution-item/clear/company/{companyId}

分销商品接口清除公司分销商品接口 OperationId: clearByCompany

物理删除

调用方法

DELETE /api/distribution-item/clear/company/{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	否	返回数据

DELETE

/api/collect/delete/{companyId}/{memberId}/{itemId}

收藏管理接口删除会员收藏接口(物理删除) OperationId: remove_3

调用方法

DELETE /api/collect/delete/{companyId}/{memberId}/{itemId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	string	会员ID	1
itemId	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/collect/clear/{companyId}/{memberId}

收藏管理接口清空会员收藏接口(物理删除) OperationId: clear

调用方法

DELETE /api/collect/clear/{companyId}/{memberId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	公司ID	1
memberId	path	是	string	会员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/article/delete

商城图文删除商城图文接口 OperationId: deleteArticles

调用方法

DELETE /api/article/delete

参数

无

请求体

无

响应

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

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

DELETE

/api/application/remove/{id}

商城应用配置接口删除商城应用接口(物理删除) OperationId: remove_4

调用方法

DELETE /api/application/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/active/delete/condition

商城活动删除活动条件接口 OperationId: deleteCondition

调用方法

DELETE /api/active/delete/condition

参数

无

请求体

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

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.mall.business.view.dto.UpdateViewDTO

修改商城视图配置数据模版

名称	类型	必填	说明	示例
version	string	否	版本号	"V1"
content	string	否	视图配置	"..."

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallView

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallView

商城视图配置

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	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"
type	string	是	视图类型【 GLOBAL_PARAMETERS : 全局设置 START_PAGE : 启动页 LANDING_PAGE : 引导页 LOGIN_PAGE : 登陆页 HOME_PAGE : 首页 QA_PAGE : QA TRIP_PAGE : 旅程 ITEM_DETAIL_PAGE : 商品详情页 PAYMENT_PAGE : 付款页 PERSON_CENTER_PAGE : 个人中心 MY_BILLS : 账单 MIX_PAGE : 混合页】	"FRONT_PAGE"
version	string	是	版本号	"V1"
content	string	是	视图配置	"..."
active	boolean	是	是否启用	false

com.leadwaycloud.rm.mall.business.pickup.outlets.dto.UpdateSelfPickupOutletsDTO

修改商城自提点数据模版

名称	类型	必填	说明	示例
name	string	否	名称	"银泰城永辉超市"
code	string	否	标识	"...."
type	string	否	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	否	联络人	"张三"
phone	string	否	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	否	是否可用	true
latLon	string	否	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

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

com.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

商城自提点

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"银泰城永辉超市"
code	string	是	标识	"...."
type	string	是	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	是	联络人	"张三"
phone	string	是	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	是	是否可用	true
latLon	string	是	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

com.leadwaycloud.rm.mall.business.refund.address.dto.RefundAddressDTO

退货地址数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
country	integer(int64)	是	国家	1
province	integer(int64)	是	省份	1
city	integer(int64)	是	城市	1
area	integer(int64)	是	区	1
street	integer(int64)	是	街道	1
detailAddress	string	是	详细地址	"..."
receiver	string	是	收货人
phone	string	是	电话

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMallRefundAddress

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

com.leadwaycloud.rm.common.model.po.entity.RmMallRefundAddress

商城退货地址

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
country	SysCountry	是
province	SysProvince	是
city	SysCity	是
area	SysArea	是
street	SysStreet	是
detailAddress	string	是	详细地址
receiver	string	是	收货人
phone	string	是	电话

com.leadwaycloud.rm.common.model.po.entity.SysArea

区/县

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	区/县代号
name	string	是	名称	"东城区"

com.leadwaycloud.rm.common.model.po.entity.SysCity

城市

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	城市代号
name	string	是	名称	"市辖区"

com.leadwaycloud.rm.common.model.po.entity.SysCountry

国家/地区

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	国际代码	"CN"
name	string	是	名称	"中国"

com.leadwaycloud.rm.common.model.po.entity.SysProvince

省/州/自治区/直辖市

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	省/州/自治区/直辖市代号
name	string	是	名称	"北京市"

com.leadwaycloud.rm.common.model.po.entity.SysStreet

街道/乡镇

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	街道/镇代号
name	string	是	名称	"东华门街道"

com.leadwaycloud.rm.mall.business.express.dto.UpdateExpressDTO

名称	类型	必填	说明	示例
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmExpress

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

com.leadwaycloud.rm.common.model.po.entity.RmExpress

合作快递公司

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
express	SysExpress	是
active	boolean	是	是否开放	true
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

com.leadwaycloud.rm.common.model.po.entity.SysExpress

系统快递公司

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	参数code	"ems"
name	string	是	名称	"EMS快递"

com.leadwaycloud.rm.mall.business.express.dto.UpdateExpressScopeDTO

名称	类型	必填	说明	示例
minFreeFareOrderAmount	number(double)	否	最小免费配送订单金额	100
fare	number(double)	否	运费	10

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmExpressScope

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

com.leadwaycloud.rm.common.model.po.entity.RmExpressFare

快递运费配置

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
expressScopeId	integer(int64)	是	快递配送范围ID
minFreeFareOrderAmount	number(double)	是	最小免费配送订单金额	100
fare	number(double)	是	运费	10

com.leadwaycloud.rm.common.model.po.entity.RmExpressScope

快递可发范围

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
scopeType	string	是	地址类型【 COUNTRY : 国家/地区 PROVINCE : 省/州/自治区/直辖市 CITY : 城市 AREA : 区/县 STREET : 街道/镇】	"COUNTRY"
countryId	integer(int64)	是	国家ID
provinceId	integer(int64)	否	省份ID
cityId	integer(int64)	否	城市ID
country	SysCountry	是
province	SysProvince	否
city	SysCity	否
expressFare	RmExpressFare	是

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

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

com.leadwaycloud.rm.mall.business.distribution.dto.UpdateDistributionRuleDTO

名称	类型	必填	说明	示例
openApplyExamine	boolean	否	是否开启分销申请审核	false
specifyItem	boolean	否	是否开放店铺指定分销商品	false
rebateExtractExamine	boolean	否	是否开启佣金提取审核	false
settlementCycle	string	否	结算周期【 WEEK : 周 MONTH : 月】	"WEEK"
settlementDay	integer(int32)	否	结算日	1
distributionMethod	string	否	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
rebatePercent1	number(double)	否	一级提成比例
rebatePercent2	number(double)	否	二级提成比例
rebatePercent3	number(double)	否	三级提成比例
memberAccountTypeId	integer(int64)	否	佣金提取账户类型ID	1
distributionExplain	string	否	分销说明	"..."

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmDistributionRule

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionRule

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
active	boolean	是	是否开启分销	false
openApplyExamine	boolean	是	是否开启分销申请审核	false
specifyItem	boolean	是	是否开放店铺指定分销商品	false
rebateExtractExamine	boolean	是	是否开启佣金提取审核	false
settlementCycle	string	是	结算周期【 WEEK : 周 MONTH : 月】	"WEEK"
settlementDay	integer(int32)	是	结算日	1
distributionMethod	string	是	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
rebatePercent1	number(double)	是	一级提成比例
rebatePercent2	number(double)	是	二级提成比例
rebatePercent3	number(double)	是	三级提成比例
memberAccountTypeId	integer(int64)	否	佣金提取账户类型	1
distributionExplain	string	否	分销说明	"..."
merchantInitiatorCode	string	是	商户邀请码	"V3FEWF32"

com.alibaba.fastjson2.JSONObject

主题

名称	类型	必填	说明	示例
empty	boolean	否

com.leadwaycloud.rm.mall.business.article.dto.UpdateArticleDTO

更新商城静态图文

名称	类型	必填	说明	示例
title	object	是	主题	"今日美味特供"
categoryId	string	是	图文分类
config	JSONObject	否
content	JSONObject	是
startDate	string	是	开始日期	"2021-11-01"
endDate	string	是	结束日期	"2021-11-11"
startTime	string	否	开始时间	"08:00:00"
endTime	string	否	结束时间	"10:00:00"
active	boolean	是	是否启用	true

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallArticle

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallArticle

商城图文

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
articleCategory	RmMallArticleCategory	是
articleCategoryId	integer(int64)	是	分类ID	1
title	object	是	主题	"..."
titleStr	string	是	主题	"..."
config	JSONObject	是
content	JSONObject	是
startDate	string	是	开始日期	"2021-11-01"
endDate	string	是	结束日期	"2021-11-11"
startTime	string	否	开始时间	"08:00:00"
endTime	string	否	结束时间	"10:00:00"
active	boolean	是	是否启用	true

com.leadwaycloud.rm.mall.model.po.entity.RmMallArticleCategory

商城图文分类

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"Child Today"
type	string	是	分类类型	"NEWS"
images	string	否	图片
icon	string	否	图标
orderSequence	integer(int32)	否	排序	1
status	string	否	状态	"ACTIVE"
parentId	integer(int64)	否	父级分类ID
articleCategory	RmMallArticleCategory	否

com.leadwaycloud.rm.mall.business.article.dto.UpdateArticleCategoryDTO

修改商城静态图文分类

名称	类型	必填	说明	示例
name	string	是	分类名	"Child Today"
images	string	否	图片
icon	string	否	图标
orderSequence	integer(int32)	否	排序	1
status	string	否	状态	"ACTIVE"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallArticleCategory

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

com.leadwaycloud.rm.mall.business.application.dto.UpdateApplicationDTO

修改商城应用数据模版

名称	类型	必填	说明	示例
name	string	否	名称	"...."
code	string	否	标识	"...."
type	string	否	类型【 MP : 公众号 MINI_APPS : 小程序】	"MP"
key	string	否	密钥	"...."
colorStyle	string	否	应用配色	"...."
openMemberRegister	boolean	否	是否开放会员注册	false

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmMallApplication

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

com.leadwaycloud.rm.common.model.po.entity.RmMallApplication

商城应用

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"...."
code	string	是	标识	"...."
type	string	是	类型【 MP : 公众号 MINI_APPS : 小程序】	"MP"
key	string	是	密钥	"...."
mpCheckFileName	string	否	公众号校验文件名称(类型为公众号时必须提供校验文件)	"xxxx.txt"
colorStyle	string	否	应用配色	"...."
openMemberRegister	boolean	否	是否开放会员注册	false

com.leadwaycloud.rm.mall.business.application.dto.UpdateApplicationDeployConfigDTO

修改应用部署配置模板

名称	类型	必填	说明	示例
config	string	是	配置

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmApplicationDeployConfig

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

com.leadwaycloud.rm.mall.model.po.entity.RmApplicationDeployConfig

应用部署配置

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

com.leadwaycloud.rm.mall.business.active.bo.AccountTypeBO

会员账户

名称	类型	必填	说明	示例
accountTypeId	integer(int64)	是	会员账户类型	1
accountTypeName	string	是	会员账户类型名称

com.leadwaycloud.rm.mall.business.active.bo.GiftBO

赠品

名称	类型	必填	说明	示例
type	string	是	赠品类型【 NONE : 感谢参与 AGAIN : 再来一次 GOODS : 商品 RIGHTS : 会员权益】
key	string	是	key	"UUID"
goods	OrderItemBO	否
giftGoodsQty	integer(int32)	否	赠送商品数量	1
memberAccount	AccountTypeBO	否
giftAccountValue	number(double)	否	赠送会员账户权益值	1

com.leadwaycloud.rm.mall.business.active.bo.OrderItemBO

商品

名称	类型	必填	说明	示例
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
brandId	integer(int64)	否	商品品牌ID	1
snapshot	string	否	商品快照
rmItemId	integer(int64)	是	零售商品ID	1
rmItemBarcodeId	integer(int64)	是	零售商品条码ID	1

com.leadwaycloud.rm.mall.business.active.bo.vote.VoteActiveConfigBO

活动配置

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片
canChooseItemCount	integer(int32)	是	可票投项数	1
itemMaxVoteCount	integer(int32)	是	每项可投票数	1
giftList	GiftBO[]	否	赠品

com.leadwaycloud.rm.mall.business.active.dto.update.vote.UpdateVoteActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	VoteActiveConfigBO	是

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallActive

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

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

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

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

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

地址联系关系

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

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

商户

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallActive

商城活动

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	创建公司ID	1
joinCompany	integer(int64)[]	是	参与公司	1
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
config	JSONObject	是
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
active	boolean	是	是否启用	true
titleStr	string	是	主题
joinCompanyStr	string	是	参与公司
company	ResCompany	否
joinCompanyList	ResCompany[]	是	参与公司	1

com.leadwaycloud.rm.mall.business.active.bo.sign.ContinuousSignGiftBO

连续签到赠品

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片
signDay	integer(int32)	是	连续签到天数	1
gift	GiftBO	是

com.leadwaycloud.rm.mall.business.active.bo.sign.SignActiveConfigBO

活动配置

名称	类型	必填	说明	示例
continuousSignGiftList	ContinuousSignGiftBO[]	否	连续签到赠品

com.leadwaycloud.rm.mall.business.active.dto.update.sign.UpdateSignActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	SignActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.scratch.card.ScratchCardActiveConfigBO

活动配置

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片

com.leadwaycloud.rm.mall.business.active.dto.update.scratch.card.UpdateScratchCardActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	ScratchCardActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.roulette.RouletteActiveConfigBO

活动配置

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片

com.leadwaycloud.rm.mall.business.active.dto.update.roulette.UpdateRouletteActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	RouletteActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.questionnaire.QuestionnaireActiveConfigBO

活动配置

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片
giftList	GiftBO[]	否	赠品

com.leadwaycloud.rm.mall.business.active.dto.update.questionnaire.UpdateQuestionnaireActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	QuestionnaireActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.questionnaire.QuestionnaireActiveItemConfigBO

活动项目配置

名称	类型	必填	说明	示例
finishImages	string	否	项目完成图片
questionContent	JSONObject	是

com.leadwaycloud.rm.mall.business.active.dto.update.questionnaire.UpdateQuestionnaireActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	QuestionnaireActiveItemConfigBO	是

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItem

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItem

商城活动项目

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
activeId	integer(int64)	是	活动ID	1
sortIndex	integer(int32)	是	序号	1
title	object	是	标题	{}
config	JSONObject	是
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
active	boolean	是	是否启用	true

com.leadwaycloud.rm.mall.business.active.bo.punch.clock.PunchClockActiveConfigBO

活动配置

名称	类型	必填	说明	示例
finishImages	string	否	活动完成图片
order	boolean	否	是否按序完成活动项目	false
giftList	GiftBO[]	是	赠品

com.leadwaycloud.rm.mall.business.active.dto.update.punch.clock.UpdatePunchClockActiveDTO

名称	类型	必填	说明	示例
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型	"2021-11-01"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	PunchClockActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.vote.VoteActiveItemConfigBO

活动项目配置

名称	类型	必填	说明	示例
finishImages	string	否	项目完成图片
name	string	是	名称	"张三"
sex	string	否	性别	"李四"
age	integer(int32)	否	年龄	29
image	string	是	照片	"29"
notes	string	否	简介	"29"

com.leadwaycloud.rm.mall.business.active.dto.update.vote.UpdateVoteActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	VoteActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.sign.SignActiveItemConfigBO

活动项目配置

名称	类型	必填	说明	示例
finishImages	string	否	项目完成图片
gift	GiftBO	否

com.leadwaycloud.rm.mall.business.active.dto.update.sign.UpdateSignActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	SignActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.scratch.card.ScratchCardActiveItemConfigBO

活动项目配置

名称	类型	必填	说明
finishImages	string	否	项目完成图片
probability	number	是	中奖概率
giftBO	GiftBO	是

com.leadwaycloud.rm.mall.business.active.dto.update.scratch.card.UpdateScratchCardActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	ScratchCardActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.roulette.RouletteActiveItemConfigBO

活动项目配置

名称	类型	必填	说明
finishImages	string	否	项目完成图片
probability	number	是	中奖概率
giftBO	GiftBO	是

com.leadwaycloud.rm.mall.business.active.dto.update.roulette.UpdateRouletteActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	RouletteActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.bo.punch.clock.PunchClockActiveItemConfigBO

活动项目配置

名称	类型	必填	说明	示例
finishImages	string	否	项目完成图片
lon	number(double)	是	经度	106.781562
lat	number(double)	是	纬度	32.684897
radiusScope	number(double)	是	打卡半径(米)	10
uploadImage	boolean	是	是否需要上传照片	false
submitNotes	boolean	是	是否需要提交文字描述	false

com.leadwaycloud.rm.mall.business.active.dto.update.punch.clock.UpdatePunchClockActiveItemDTO

名称	类型	必填	说明	示例
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	PunchClockActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.update.UpdateActiveConditionDTO

名称	类型	必填	说明	示例
type	string	是	类型【 ACTIVE : 活动 ORDER_AMOUNT : 订单交易金额 MEMBER : 会员 MEMBER_TYPE : 会员类型】	"ACTIVE"
value	string	是	值
attachment	string	否	自定义数据(json格式)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveCondition

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

com.leadwaycloud.rm.mall.model.bo.ConditionValueBO

值

名称	类型	必填	说明
activeValue	integer(int64)[]	否	必须参与过的某些活动ID集合
orderAmountValue	number(double)	否	活动生效期间累计交易金额必须要大于的金额
memberValue	integer(int64)[]	否	可参与活动的会员ID集合
memberTypeValue	integer(int64)[]	否	可参与活动的会员类型ID集合

com.leadwaycloud.rm.mall.model.po.entity.RmMallActiveCondition

商城活动条件

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
activeId	integer(int64)	是	活动ID	1
type	string	是	类型【 ACTIVE : 活动 ORDER_AMOUNT : 订单交易金额 MEMBER : 会员 MEMBER_TYPE : 会员类型】	"ACTIVE"
value	ConditionValueBO	是
attachment	string	否	自定义数据

com.leadwaycloud.rm.mall.business.active.dto.update.SortActiveItemDTO

名称	类型	必填	说明	示例
activeItemId	integer(int64)	是	活动项目ID	1
sortIndex	integer(int32)	是	序号	1

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

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

com.leadwaycloud.rm.mall.business.wechat.bo.JumpWxaBO

跳转到的目标小程序信息

名称	类型	必填	说明	示例
path	string	否		"。。。"
query	string	否		"..."

com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppUrlSchemeDTO

生成微信小程序分享URL Scheme数据模版

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
expire	boolean	是	是否永久有效	false
expireTime	string	否	到期时间	"2020-10-11 13:09:11"
jumpWxaBO	JumpWxaBO	否

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

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

com.leadwaycloud.rm.mall.business.wechat.bo.CloudBaseBO

云开发静态网站自定义 H5 配置参数

名称	类型	必填	示例
env	string	是	"。。。"
domain	string	否	"..."
path	string	否	"..."
query	string	否	"..."
resourceAppId	string	否	"..."

com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppUrlLinkDTO

生成微信小程序分享URL Link数据模版

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
path	string	否	通过 URL Link 进入的小程序页面路径
query	string	否	通过 URL Link 进入小程序时的query
envVersion	string	否	要打开的小程序版本
expire	boolean	是	是否永久有效	false
expireType	integer(int32)	否	小程序 URL Link 失效类型	0
expireTime	string	否	到期时间(expireType=0必填)	"2020-10-11 13:09:11"
expireInterval	integer(int32)	否	到期失效的URL Link的失效间隔天数(expireType=1必填)	1
cloudBaseBO	CloudBaseBO	否

com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppShortLinkDTO

生成微信小程序分享Short Link数据模版

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"Wx...."
pageUrl	string	是	通过 Short Link 进入的小程序页面路径
pageTitle	string	是	页面标题
isPermanent	boolean	否	生成的 Short Link 类型	false

com.leadwaycloud.rm.mall.business.wechat.dto.GenerateWxMiniAppQRCodeDTO

生成微信小程序二维码数据模版

名称	类型	必填	说明	示例
appId	string	是	应用code(appId)	"wx49f5154e812da61d"
path	string	是	通过二维码进入的小程序页面路径	"pages/index/index"

com.leadwaycloud.rm.mall.business.view.dto.CreateViewDTO

创建商城视图配置数据模版

名称	类型	必填	说明	示例
merchantId	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"
type	string	是	视图类型【 GLOBAL_PARAMETERS : 全局设置 START_PAGE : 启动页 LANDING_PAGE : 引导页 LOGIN_PAGE : 登陆页 HOME_PAGE : 首页 QA_PAGE : QA TRIP_PAGE : 旅程 ITEM_DETAIL_PAGE : 商品详情页 PAYMENT_PAGE : 付款页 PERSON_CENTER_PAGE : 个人中心 MY_BILLS : 账单 MIX_PAGE : 混合页】	"FRONT_PAGE"
version	string	是	版本号	"V1"
content	string	是	视图配置	"..."

com.leadwaycloud.rm.mall.business.history.dto.shoppingCart.SubmitItemDTO

提交购物车品项数据模版

名称	类型	必填	说明	示例
itemId	integer(int64)	是	零管销售商品ID	1
itemBarcodeId	integer(int64)	是	零管销售商品条码ID	1
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
amount	number(double)	是	金额	35

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallShoppingCartItem

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

com.leadwaycloud.rm.common.model.po.entity.FinanceTax

税率

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称	"13%销售税"
value	boolean	是	税值	false
status	string	是	状态【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除】	"ACTIVE"
note	string	否	备注

com.leadwaycloud.rm.common.model.po.entity.ResCompanyGoods

公司商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
allowSale	boolean	是	允许销售	true
allowPurchase	boolean	是	允许采购	true
allowDiscount	boolean	是	允许折扣	true
allowManualPrice	boolean	是	允许手工变价(POS手工变价)	true
changePrice	boolean	是	允许变价单变价	true
allowRefund	boolean	是	允许退货	true
negativeDiscount	boolean	是	允许负毛利折扣	true
allowMarkdown	boolean	是	允许报损	true
orderedLocally	boolean	是	允许直接采购	true
thirdPartyDelivery	boolean	否	允许第三方直送	true
stockGoodsId	integer(int64)	是	商品ID

com.leadwaycloud.rm.common.model.po.entity.ResCompanyGoodsBarcode

公司商品条码

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
goodsId	integer(int64)	是	商品ID	1
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	是
purchaseTax	FinanceTax	是
status	string	是	状态【 ACTIVE : 可用 DEACTIVATE : 停用 DELETE : 删除】	"ACTIVE"

com.leadwaycloud.rm.common.model.po.entity.RmItem

零管销售商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
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	StockGoods	是
companyGoods	ResCompanyGoods	是
itemBarcodeList	RmItemBarcode[]	否	零管销售商品条码
distribution	boolean	否	是否是零管分销商品	false

com.leadwaycloud.rm.common.model.po.entity.RmItemBarcode

零管销售商品条码

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

com.leadwaycloud.rm.common.model.po.entity.StockGoods

商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称	"抽纸"
code	string	是	货号	"KDED24123123"
virtual	boolean	是	是否是虚拟产品	true
images	string	否	图片	"..."
origin	string	否	来源	"..."
description	string	否	描述	"..."
otherName	string	否	别名	"..."
mark	string	否	标记	"ENERGY"
place	string	否	产地
grade	string	否	等级
externalCode	string	否	外部编号
weight	boolean	是	非标售卖商品	true
fuel	boolean	是	油品	true
make	boolean	是	自制品	true
barcodeSettlement	boolean	是	商品结算方式 false(商品结算,默认) true(条码结算)
carwash	boolean	是	洗车商品	true
goodsCategoryId	integer(int64)	是	分类ID
goodsBrandId	integer(int64)	否	品牌ID
spec	string	否	规格
uomId	string	是	计量单位ID
saleUomId	string	否	销售单位ID
goodsCategory	StockGoodsCategory	是
uom	SysUom	是
saleUom	SysUom	否
goodsBrand	StockGoodsBrand	否
goodsEnergy	StockGoodsEnergy	否

com.leadwaycloud.rm.common.model.po.entity.StockGoodsBarcode

商品条码

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
goodsId	integer(int64)	是	商品ID
barcode	string	是	条码	"6914068029184"
type	string	是	条码类型	"EN13"
otherBarcode	string	否	其他条码	"6914068029184"
defSettlement	boolean	是	是否是结算默认条码
images	string	否	图片
spec	string	否	规格

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

商品品牌

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

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

商品分类

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

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

商品能源属性

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

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

计量单位

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallShoppingCartItem

商城购物车商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
shoppingCartId	integer(int64)	是	微信商城购物车ID
itemId	integer(int64)	是	零管销售商品ID
itemBarcodeId	integer(int64)	是	零管销售商品条码ID	1
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
amount	number(double)	是	金额	35
choose	boolean	否	是否选中	false
name	string	否	商品名称	"xxx"
images	string	否	商品条码图片	"xx"
item	RmItem	是

com.leadwaycloud.rm.mall.business.pickup.outlets.dto.CreateSelfPickupOutletsDTO

创建商城自提点数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"银泰城永辉超市"
code	string	是	标识	"...."
type	string	是	类型【 STORE : 门店 OUTLETS : 网点】	"OUTLETS"
contactPerson	string	是	联络人	"张三"
phone	string	是	电话	"13888888888"
address	string	否	地址	"银泰城负一楼永辉超市"
active	boolean	是	是否可用	true
latLon	string	是	经纬度(纬度,经度)	"104.064737,30.547256"
openingTime	string	否	开店时间	"08:00:00"
closingTime	string	否	关店时间	"20:00:00"
image	string	否	图片

com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartUpdateReqDTO

名称	类型	必填	说明	示例
shoppingCartId	integer(int64)	是	购物车ID	1
customerId	integer(int64)	否	客户ID	1
customerContactPersonId	integer(int64)	否	客户联系人ID	1
itemBarcodeList	ShoppingCartUpdateReqDTO$UpdateItemBarcodeDTO[]	是	变更零管商品条码(为空表示清空购物车)

com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartUpdateReqDTO$UpdateItemBarcodeDTO

变更零管商品条码(为空表示清空购物车)

名称	类型	必填	说明	示例
itemBarcodeId	integer(int64)	是	零管销售商品条码ID	1
qty	integer(int32)	是	商品数量(数量==0表示删除)	1
weight	number(double)	否	商品重量
choose	boolean	否	是否选中	false

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO

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

com.leadwaycloud.rm.common.business.goods.model.vo.SpecVO

商品条码规格属性

名称	类型	必填	说明	示例
id	integer(int64)	是	规格ID
groupName	string	是	属性组名称	"1"
sequence	integer(int32)	是	排序	1
name	string	是	名称
value	string	是	值

com.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	是	购物车ID	1
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	优惠金额	0
amount	number(double)	是	金额(=总金额-优惠金额)	100
promList	ShoppingCartVO$ItemPromVO[]	否	促销信息
shoppingCartItemList	ShoppingCartVO$ShoppingCartItemVO[]	否	购物车商品金额明细

com.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO$ItemPromVO

促销信息

名称	类型	必填	说明	示例
promDisc	string	是	促销描述	"xxx"
promAmount	number(double)	是	优惠金额	0

com.leadwaycloud.rm.mall.business.shopping.cart.model.vo.ShoppingCartVO$ShoppingCartItemVO

购物车商品金额明细

名称	类型	必填	说明	示例
id	integer(int64)	是	购物车商品项ID	1
itemId	integer(int64)	是	零管商品ID	1
itemBarcodeId	integer(int64)	是	零管商品条码ID	1
stockGoodsSpec	string	否	商品规格	"xxx"
stockGoodsBarcode	string	是	商品条码	"xxx"
stockGoodsBarcodeSpecList	SpecVO[]	否	商品条码规格属性	[]
orderMinQty	number(double)	是	单次最小购买数量	1
orderMaxQty	number(double)	是	单次最大购买数量	999999
qty	integer(int32)	是	数量	1
weight	number(double)	否	重量	1
name	string	是	商品名称	"xxx"
spec	string	否	商品条码规格	"xxx"
images	string	是	商品条码图片	"xx"
orderedLocally	boolean	否	允许直接采购	true
thirdPartyDelivery	boolean	否	允许第三方直送	true
choose	boolean	否	是否选中	false
offShelf	boolean	否	是否已经下架	false
price	number(double)	是	商品条码单价
vatRatio	number(double)	是	商品税率
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	否	优惠金额	0
amount	number(double)	是	金额(=总金额-优惠金额)	100
promList	ShoppingCartVO$ItemPromVO[]	否	促销信息

com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartCreateReqDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
memberId	integer(int64)	是	会员ID	1

com.leadwaycloud.core.model.RJava.lang.Long

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

com.leadwaycloud.rm.mall.business.shopping.cart.model.dto.ShoppingCartAppendItemReqDTO

名称	类型	必填	说明	示例
shoppingCartId	integer(int64)	是	购物车ID	1
itemBarcodeId	integer(int64)	是	零管商品条码	1
qty	integer(int32)	否	商品数量	1

com.leadwaycloud.rm.mall.business.logistics.model.LogisticsQueryReqDTO

名称	类型	必填	说明	示例
expressOrderCode	string	是	快递单号	"SALE"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.logistics.model.LogisticsVO

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

com.leadwaycloud.rm.mall.business.logistics.model.LogisticsVO

返回数据

名称	类型	必填	说明	示例
expressName	string	是	快递公司名称	"xxx"
expressOrderCode	string	是	快递单号	"xxx"
routeList	LogisticsVO$RouteVO[]	是	路线信息

com.leadwaycloud.rm.mall.business.logistics.model.LogisticsVO$RouteVO

路线信息

名称	类型	必填	说明	示例
time	string	是	时间	"2022-05-17 21:26:31"
address	string	否	地址	"成都市"
context	string	是	内容	"【四川省成都市大丰公司】已打包"

com.leadwaycloud.rm.mall.business.collect.model.dto.CollectUpdateItemDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
memberType	string	是	会员类型	"INTERNAL"
itemId	integer(int64)	是	零管商品ID	1
itemBarcodeId	integer(int64)	否	零管商品条码ID	1

com.leadwaycloud.rm.mall.business.collect.model.dto.CollectDeleteItemDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
itemList	integer(int64)[]	否	需要删除的零管商品或条码(未提供清空全部)

com.leadwaycloud.rm.mall.business.express.dto.AddExpressDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
sysExpressId	integer(int64)	是	快递公司ID	1
linkPerson	string	否	联系人	"张三"
linkPhone	string	否	联系电话	"13888888888"

com.leadwaycloud.rm.mall.business.express.dto.AddExpressScopeDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
countryId	integer(int64)	是	国家ID	1
provinceId	integer(int64)	否	省份ID	1
cityId	integer(int64)	否	城市ID	1
minFreeFareOrderAmount	number(double)	是	最小免费配送订单金额	100
fare	number(double)	是	运费	10

com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionRuleDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
active	boolean	是	是否开启分销	false
openApplyExamine	boolean	是	是否开启分销申请审核	false
specifyItem	boolean	是	是否开放店铺指定分销商品	false
rebateExtractExamine	boolean	是	是否开启佣金提取审核	false
settlementCycle	string	是	结算周期【 WEEK : 周 MONTH : 月】	"WEEK"
settlementDay	integer(int32)	是	结算日	1
distributionMethod	string	是	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
rebatePercent1	number(double)	是	一级提成比例
rebatePercent2	number(double)	是	二级提成比例
rebatePercent3	number(double)	是	三级提成比例
memberAccountTypeId	integer(int64)	是	佣金提取账户类型ID	1
distributionExplain	string	否	分销说明	"..."

com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionItemDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
itemList	integer(int64)[]	是	零管商品ID

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmDistributionItem

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionItem

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
item	SimpleRmItem	是

com.leadwaycloud.rm.common.model.po.entity.SimpleRmItem

零管商品

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

com.leadwaycloud.rm.mall.business.distribution.dto.ProcessDistributionExtractRebateApplyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否审核通过	false
message	string	否	审核结果	"会员累计消费不达标,不能加入分销计划"

com.leadwaycloud.rm.mall.business.distribution.dto.ProcessDistributionApplyDTO

名称	类型	必填	说明	示例
pass	boolean	是	是否审核通过	false
message	string	否	审核结果	"会员累计消费不达标,不能加入分销计划"

com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionApplyDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
memberId	integer(int64)	是	会员ID	1
initiatorCode	string	否	邀请码	"D723N2WD"

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmDistributionApply

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

com.leadwaycloud.rm.common.model.po.entity.CrmMember

会员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	否	公司ID	1
barcode	string	是	会员编号	"002391117577753472"
status	string	是	会员状态【 ACTIVE : 活跃的 LOCK : 锁定的】	"ACTIVE"
name	string	是	名称	"张三"
mobilePhone	string	是	手机号码	"张三"
realName	string	否	真实名称
otherBarcode	string	否	第三方条码
source	string	是	会员来源
typeId	integer(int64)	是	会员类型
partnerId	integer(int64)	是	关系ID
sex	string	是	性别
birthday	string	否	出生日期
birthYear	string	否	出生年
company	ResCompany	否

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

用户

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionApply

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
member	CrmMember	是
initiator	RmDistributionMember	否
status	string	是	申请状态	"APPLY"
reviewer	ResUser	否
reviewTime	string	否	审核时间	"2020-10-11 13:09:11"
message	string	否	审核结果	"允许加入分销计划"

com.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

邀请人

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
member	CrmMember	是
readRule	boolean	是	是否已经阅读分销规则	true
superior1Member	RmDistributionMember	否
superior2Member	RmDistributionMember	否
superior3Member	RmDistributionMember	否
effectiveRebate	number(double)	是	可提取的佣金	0
totalExtractRebate	number(double)	是	累计提取的佣金	0
initiatorCode	string	是	邀请码	"V3FEWF32"

com.leadwaycloud.rm.mall.business.distribution.dto.AddDistributionExtractRebateApplyDTO

名称	类型	必填	说明	示例
distributionMemberId	integer(int64)	是	分销成员ID	1
extractVal	number(double)	是	提取佣金额度	100

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmDistributionExtractRebateApply

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionExtractRebateApply

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
distributionMember	RmDistributionMember	是
extractVal	number(double)	是	提取佣金额度	100
status	string	是	申请状态【 APPLY : 申请中 PASS : 通过 REJECT : 拒绝】	"APPLY"
reviewer	ResUser	否
reviewTime	string	否	审核时间	"2020-10-11 13:09:11"
message	string	否	审核结果	"允许提取佣金"
grant	boolean	是	是否已经发放佣金	false

com.leadwaycloud.rm.mall.business.history.dto.collect.AddCollectDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
memberType	string	是	会员类型	"INTERNAL"
itemId	integer(int64)	是	零管商品ID	1
notes	string	否	备注

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallCollect

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallCollect

商城会员收藏

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
memberId	string	是	会员ID	"1"
memberType	string	是	会员类型默认内部	"INTERNAL"
itemId	integer(int64)	是	零管销售商品
itemBarcodeId	integer(int64)	否	零管销售商品条码
notes	string	否	备注
name	string	否	商品名称
images	string	否	商品图片
item	RmItem	否

com.leadwaycloud.rm.mall.business.article.dto.CreateArticleDTO

创建商城静态图文

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
title	object	是	主题	"今日美味特供"
categoryId	string	是	图文分类
config	JSONObject	否
content	JSONObject	是
startDate	string	是	开始日期	"2021-11-01"
endDate	string	是	结束日期	"2021-11-11"
startTime	string	否	开始时间	"08:00:00"
endTime	string	否	结束时间	"10:00:00"
active	boolean	是	是否启用	true

com.leadwaycloud.rm.mall.business.article.dto.CreateArticleCategoryDTO

创建商城静态图文分类

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	分类名	"Child Today"
type	string	是	分类类型	"NEWS"
images	string	否	图片
icon	string	否	图片
orderSequence	integer(int32)	否	排序	1
status	string	否	状态	"ACTIVE"
parentId	integer(int64)	否	父级分类ID

com.leadwaycloud.rm.mall.business.application.dto.CreateApplicationDTO

创建商城应用数据模版

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
name	string	是	名称	"...."
code	string	是	标识	"...."
type	string	是	类型【 MP : 公众号 MINI_APPS : 小程序】	"MP"
key	string	是	密钥	"...."
colorStyle	string	否	应用配色	"...."
openMemberRegister	boolean	否	是否开放会员注册	false

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmApplicationDeployConfig

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

com.leadwaycloud.rm.mall.business.application.dto.CreateApplicationDeployConfigDTO

创建应用部署配置模版

名称	类型	必填	说明	示例
config	string	是	配置
applicationId	integer(int64)	是	应用ID	1
merchantId	integer(int64)	是	商户ID	1

com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemInfo	AddVoteActiveItemRecordDTO$ActiveItemInfoBO[]	是	活动项目信息

com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveItemRecordDTO$ActiveItemInfoBO

活动项目信息

名称	类型	必填	说明	示例
activeItemId	integer(int64)	是	活动项目ID	1
voteCount	integer(int64)	是	投票数	1

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItemMemberRecord

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItemMemberRecord

商城活动项目会员参与记录

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
result	boolean	是	参与结果	true
resultVal	string	否	参与结果值

com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
isAbandon	boolean	否	是否放弃奖品	false
giftGoodsOrderId	integer(int64)	否	赠品订单ID(页面引导创建赠品订单)，连续签到与单日签到都是发放赠品需要合并成一个订单

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItemMemberRecord

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

com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1

com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1

com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
answerContent	string	是	答题内容	"{}"

com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveItemRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
activeItemId	integer(int64)	是	活动项目ID	1
images	string	否	照片	"[]"
notes	string	否	文字描述	"1"
lon	number(double)	是	经度	104.064737
lat	number(double)	是	纬度	32.684897

com.leadwaycloud.rm.mall.business.active.dto.add.AddActiveMemberRecordDTO

名称	类型	必填	说明	示例
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
isAbandon	boolean	否	是否放弃奖品	false
giftGoodsOrderId	integer(int64)	否	赠品订单ID(页面引导创建赠品订单)

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveMemberRecord

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallActiveMemberRecord

商城活动会员参与记录

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
memberId	integer(int64)	是	会员ID	1
activeId	integer(int64)	是	活动ID	1
result	boolean	是	参与结果	true
resultVal	string	否	参与结果值
member	CrmMember	否

com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	VoteActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	SignActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	ScratchCardActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	RouletteActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	QuestionnaireActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.questionnaire.AddQuestionnaireActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	QuestionnaireActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
joinCompanyList	integer(int64)[]	是	参与公司	[]
type	string	是	类型【 PUNCH_CLOCK : 打卡 SIGN : 签到 ROULETTE : 轮盘 SCRATCH_CARD : 刮刮卡 VOTE : 投票 QUESTIONNAIRE : 问卷调查】	"PUNCH_CLOCK"
title	object	是	主题	"..."
webConfig	JSONObject	是
content	JSONObject	是
startTime	string	是	开始时间	"2021-11-01 00:00:00"
endTime	string	是	结束时间	"2021-11-11 00:00:00"
config	PunchClockActiveConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.vote.AddVoteActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	VoteActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.sign.AddSignActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	SignActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.scratch.card.AddScratchCardActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	ScratchCardActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.roulette.AddRouletteActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	RouletteActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.punch.clock.AddPunchClockActiveItemDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
title	object	是	标题	{}
webConfig	JSONObject	是
content	JSONObject	是
mustJoin	boolean	是	是否必须参加	true
config	PunchClockActiveItemConfigBO	是

com.leadwaycloud.rm.mall.business.active.dto.add.AddActiveConditionDTO

名称	类型	必填	说明	示例
activeId	integer(int64)	是	活动ID	1
type	string	是	类型【 ACTIVE : 活动 ORDER_AMOUNT : 订单交易金额 MEMBER : 会员 MEMBER_TYPE : 会员类型】	"ACTIVE"
value	string	是	值
attachment	string	否	自定义数据(json格式)

com.leadwaycloud.rm.mall.business.active.dto.query.DistanceDTO

名称	类型	必填	说明	示例
key	string	是	UUID	"UUID"
longitude1	number(double)	是	第一点的经度	106.781028
latitude1	number(double)	是	第一点的纬度	32.684301
longitude2	number(double)	是	第二点的经度	106.781562
latitude2	number(double)	是	第二点的纬度	32.684897

com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Integer

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

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.wechat.vo.WeiXinUserInfoVO

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

com.leadwaycloud.rm.mall.business.wechat.bo.WeiXinUserInfoBO

名称	类型	必填
country	string	否
province	string	否
city	string	否
openid	string	否
sex	string	否
nickname	string	否
headimgurl	string	否
language	string	否
privilege	object[]	否

com.leadwaycloud.rm.mall.business.wechat.vo.WeiXinUserInfoVO

返回数据

名称	类型	必填
userId	integer(int64)	否
openId	string	是
userType	string	否
token	string	否
userInfo	WeiXinUserInfoBO	是

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.ResCompany

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

PageableObject

名称	类型	必填
paged	boolean	否
pageNumber	integer(int32)	否
offset	integer(int64)	否
sort	SortObject	否
pageSize	integer(int32)	否
unpaged	boolean	否

SortObject

名称	类型	必填
sorted	boolean	否
empty	boolean	否
unsorted	boolean	否

com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.mall.model.po.entity.RmMallView

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

org.springframework.data.domain.PageCom.leadwaycloud.rm.mall.model.po.entity.RmMallView

返回数据

名称	类型	必填
totalPages	integer(int32)	否
totalElements	integer(int64)	否
pageable	PageableObject	否
first	boolean	否
last	boolean	否
size	integer(int32)	否
content	RmMallView[]	否
number	integer(int32)	否
sort	SortObject	否
numberOfElements	integer(int32)	否
empty	boolean	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallView

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

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.model.po.entity.RmMallShoppingCart

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

com.leadwaycloud.rm.mall.model.po.entity.RmMallShoppingCart

商城购物车

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	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"
memberId	integer(int64)	是	会员ID	1

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

返回数据

名称	类型	必填	说明	示例
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	RmMallSelfPickupOutlets[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmMallSelfPickupOutlets

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

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

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.business.collect.model.vo.CollectItemVO

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

com.leadwaycloud.rm.common.business.goods.model.vo.ListItemBarcodeVO

零管商品条码信息集合

名称	类型	必填	说明	示例
itemBarcodeId	integer(int64)	是	零管商品条码ID
itemId	integer(int64)	是	零管商品ID
goodsId	integer(int64)	是	商品ID
goodsCategoryId	integer(int64)	否	商品分类ID
goodsCategoryCode	string	否	商品分类编号
goodsCategoryName	string	否	商品分类名称
goodsBrandId	integer(int64)	否	商品品牌ID
goodsBrandCode	string	否	商品品牌编号
goodsBrandName	string	否	商品品牌名称
goodsBarcodeId	integer(int64)	是	商品条码ID
goodsCode	string	是	商品货号
goodsBarcode	string	是	商品条码
goodsName	string	是	商品名称
goodsSpec	string	否	规格
goodsPack	string	否	包装
goodsPackSymbol	string	否	包装
goodsShortPack	string	否	包装
goodsIsoShortPack	string	否	商品包装
vatRatio	number(double)	是	商品税率
taxType	string	否	税额计算方式【 INCLUDE_TAX : 含税 EXCLUDE_TAX : 不含税】	"INCLUDE_TAX"
spec	string	否	商品条码规格
images	string	否	商品条码图片
price	number(double)	是	商品条码单价
price2	number(double)	否	商品条码单价2
orderMinQty	number(double)	是	单次最小购买数量	999
orderMaxQty	number(double)	是	单次最大购买数量	999
shelf	boolean	否	是否上架	true
checkStock	boolean	否	是否检查库存	true
virtual	boolean	否	是否是虚拟产品	true
defSettlement	boolean	否	是否是结算默认条码	true
orderedLocally	boolean	否	允许直接采购	true
thirdPartyDelivery	boolean	否	允许第三方直送	true
allowDiscount	boolean	否	允许折扣	true
allowManualPrice	boolean	否	允许手工变价(POS手工变价)	true
allowRefund	boolean	否	允许退货	true

com.leadwaycloud.rm.mall.business.collect.model.vo.CollectItemVO

返回数据

名称	类型	必填	说明	示例
itemId	integer(int64)	是	零管商品ID	1
name	string	否	商品名称	"xxx"
image	string	否	商品图片	"xxx"
offShelf	boolean	否	是否已经下架	false
itemBarcodeId	integer(int64)	否	零管商品条码ID	1
itemBarcodeBarcode	string	否	零管商品条码
itemBarcodePrice	number(double)	否	零管商品条码价格	1
barcodeInfoList	ListItemBarcodeVO[]	否	零管商品条码信息集合

com.leadwaycloud.core.model.RJava.lang.Double

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

com.leadwaycloud.core.model.RCom.alibaba.fastjson2.JSONObject

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.business.express.vo.AddressVO

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

com.leadwaycloud.rm.mall.business.express.vo.AddressVO

五级联动数据数据模版

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
code	string	是	代号
name	string	是	名称	"东城区"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.SysExpress

返回数据

名称	类型	必填	说明	示例
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	SysExpress[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.SysExpress

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

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmExpressScope

返回数据

名称	类型	必填	说明	示例
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	RmExpressScope[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmExpressScope

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmExpress

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

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionRuleChangeLog

返回数据

名称	类型	必填	说明	示例
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	RmDistributionRuleChangeLog[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionRuleChangeLog

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionRuleChangeLog

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
type	string	是	类型【 ADD : 新增 UPDATE : 修改 OPEN : 开启 CLOSE : 关闭】	"ADD"
changeData	string	否	分销规则变更数据
updateUser	ResUser	否

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

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

com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

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

org.springframework.data.domain.PageCom.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

返回数据

名称	类型	必填
totalPages	integer(int32)	否
totalElements	integer(int64)	否
pageable	PageableObject	否
first	boolean	否
last	boolean	否
size	integer(int32)	否
content	RmDistributionMember[]	否
number	integer(int32)	否
sort	SortObject	否
numberOfElements	integer(int32)	否
empty	boolean	否

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionOrder

返回数据

名称	类型	必填	说明	示例
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	RmDistributionOrder[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionOrder

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

com.leadwaycloud.rm.common.model.po.entity.RmDistributionOrder

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
orderId	integer(int64)	是	零管订单ID	1
orderDistributionAmount	number(double)	是	零管订单可分销金额	100
distributionMethod	string	是	分销方式【 COMMON : 普通 INTERNAL_PURCHASE : 内购】	"COMMON"
distributor1Member	RmDistributionMember	是
distributor2Member	RmDistributionMember	否
distributor3Member	RmDistributionMember	否
rebatePercent1	number(double)	是	一级提成比例
rebatePercent2	number(double)	是	二级提成比例
rebatePercent3	number(double)	是	三级提成比例
rebateVal1	number(double)	是	一级佣金
rebateVal2	number(double)	是	二级佣金
rebateVal3	number(double)	是	三级佣金
settlement1	boolean	是	是否已经结算	false
settlement2	boolean	是	是否已经结算	false
settlement3	boolean	是	是否已经结算	false
settlement1Time	string	否	结算时间	"2020-10-11 13:09:11"
settlement2Time	string	否	结算时间	"2020-10-11 13:09:11"
settlement3Time	string	否	结算时间	"2020-10-11 13:09:11"
distributionOrderItemList	RmDistributionOrderItem[]	是	订单分销商品

com.leadwaycloud.rm.common.model.po.entity.RmDistributionOrderItem

订单分销商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
orderItem	RmOrderItem	是
amount	number(double)	是	商品金额	100

com.leadwaycloud.rm.common.model.po.entity.RmOrderItem

订单商品

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
lineNo	integer(int32)	是	行号	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsTypeCode	string	是	商品类型编号	"1"
goodsTypeName	string	是	商品类型名称	"1"
brandId	integer(int64)	否	品牌ID	1
brandCode	string	否	品牌编号	"xxx"
brandName	string	否	品牌名称	"xxx"
goodsCode	string	是	商品编号	"12532534235"
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	"4719324252342"
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量
pack	string	是	包装	"瓶"
packSymbol	string	否	包装	"瓶"
shortPack	string	否	包装	"瓶"
isoShortPack	string	否	包装	"瓶"
spec	string	否	规格
totalAmount	number(double)	是	总金额	35
promAmount	number(double)	是	商品优惠金额	0
amount	number(double)	是	商品金额	35
vatAmount	number(double)	是	商品税额	100
snapshot	string	否	商品快照(下单时商品的基本信息)
rmItemId	integer(int64)	是	零管商品ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1
priceOriginId	integer(int64)	否	价格原单据ID	1
priceOriginType	string	否	价格原单据类型【 PRICE_LIST : 价目表 QUOTE_ORDER : 报价单】	"SALE_CONTRACT"
quotationCode	string	否	报价单编号
quotationOutsideCode	string	否	外部报价单编号
thirdpartyDelivery	boolean	否	是否第三方配送	false
thirdpartyPurchase	boolean	否	是否第三方采购(商城根据商品中的参数带入不可编辑，中台根据商品中的参数带入可编辑)	false
acceptThirdpartyDelivery	boolean	否	是否接受第三方配送(中台、商城在页面可调整,如果第三方采购=true默认带入true)	false
purchaseByOrder	boolean	否	是否按单采购(中台在页面可调整,默认false)	false
periodType	string	否	发货周期类型【 HOUR : 时 DAY : 天 WEEK : 周 MONTH : 月 YEAR : 年】	"1"
deliveryPeriod	integer(int32)	否	发货周期	1
remark	string	否	备注	"1"
reserved1	string	否	备用字段1(客户物料编码)
reserved2	string	否	备用字段2(客户物料规格)
reserved3	string	否	备用字段3

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

返回数据

名称	类型	必填	说明	示例
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	RmDistributionMember[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionMember

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

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionItem

返回数据

名称	类型	必填	说明	示例
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	RmDistributionItem[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionItem

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

com.leadwaycloud.rm.mall.business.distribution.dto.QueryDistributionApplyDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
memberId	integer(int64)	否	会员ID	1
initiator	integer(int64)	否	邀请人	1
status	string	否	申请状态【 APPLY : 申请中 PASS : 通过 REJECT : 拒绝】	"APPLY"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionApply

返回数据

名称	类型	必填	说明	示例
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	RmDistributionApply[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionApply

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

com.leadwaycloud.rm.mall.business.distribution.dto.QueryDistributionExtractRebateApplyDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
distributionMemberId	integer(int64)	否	分销成员ID	1
status	string	否	申请状态【 APPLY : 申请中 PASS : 通过 REJECT : 拒绝】	"APPLY"

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionExtractRebateApply

返回数据

名称	类型	必填	说明	示例
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	RmDistributionExtractRebateApply[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.common.model.po.entity.RmDistributionExtractRebateApply

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

com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.rm.mall.model.po.entity.RmMallCollect

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

org.springframework.data.domain.PageCom.leadwaycloud.rm.mall.model.po.entity.RmMallCollect

返回数据

名称	类型	必填
totalPages	integer(int32)	否
totalElements	integer(int64)	否
pageable	PageableObject	否
first	boolean	否
last	boolean	否
size	integer(int32)	否
content	RmMallCollect[]	否
number	integer(int32)	否
sort	SortObject	否
numberOfElements	integer(int32)	否
empty	boolean	否

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallArticle

返回数据

名称	类型	必填	说明	示例
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	RmMallArticle[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallArticle

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallArticleCategory

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmMallApplication

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

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallActive

返回数据

名称	类型	必填	说明	示例
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	RmMallActive[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallActive

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

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.active.vo.ActiveVO

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

com.leadwaycloud.rm.mall.business.active.vo.ActiveVO

返回数据

名称	类型	必填	说明
active	RmMallActive	是
activeConditionList	RmMallActiveCondition[]	否	活动条件
activeItemList	RmMallActiveItem[]	否	活动项目

com.leadwaycloud.core.model.RCom.leadwaycloud.rm.mall.business.active.vo.ActiveMemberVO

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

com.leadwaycloud.rm.mall.business.active.vo.ActiveMemberVO

返回数据

名称	类型	必填	说明
active	RmMallActive	是
activeConditionList	RmMallActiveCondition[]	否	活动条件
activeItemList	RmMallActiveItem[]	否	活动项目
activeMemberRecord	RmMallActiveMemberRecord	否
activeItemMemberRecordList	RmMallActiveItemMemberRecord[]	否	会员参与活动项目记录

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallActive

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveItem

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.common.model.po.entity.RmOrder

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

com.leadwaycloud.rm.common.business.order.mdoel.bo.OrderMerchantNoteBO

订单商户备注数据模版

名称	类型	必填	说明	示例
note	string	是	参数名称	"折扣名称"
user	string	是	备注人	"张三"
time	string	否	备注时间	"2020-10-11 13:09:11"

com.leadwaycloud.rm.common.model.bo.AttachmentBO

附件

名称	类型	必填	说明	示例
name	string	是	文件名称	"xx"
type	string	是	文件类型	"xx"
fileId	string	是	文件服务的文件ID	"xxx"
userId	integer(int64)	否	上传的用户ID	1
userName	string	否	上传的用户名称	"1"
uploadTime	string	否	上传时间	"2020-10-11 13:09:11"

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

收银员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
account	string	是	账号	"131131"
password	string	是	密码	"111111"
status	string	是	状态【 ACTIVE : 活跃 LOCK : 锁定 VOID : 删除】	"ACTIVE"
type	string	是	类型【 CASHIER : 收银员 LEADER : 收银组长 MANAGER : 收银管理员】	"CASHIER"
employeeId	integer(int64)	否	员工ID	1

com.leadwaycloud.rm.common.model.po.entity.RmDevicePos_Simple

机台(简略)

名称	类型	必填	说明	示例
id	integer(int64)	否
companyId	integer(int64)	是	公司
code	string	是	编号	"POS001"
status	string	是	状态	"INACTIVATED"
description	string	否	描述
applicationVersion	string	否	应用版本
registerTime	string	否	激活时间	"2020-10-11 10:09:11"
deviceName	string	否	设备名称	"MacBook-Pro-zkl.local"
deviceOSType	string	否	设备操作系统类型	"macOS Catalina"
deviceOSVersion	string	否	设备操作系统版本	"10.15.7"
deviceMacAddress	string	否	设备MAC地址	"88:E9:FE:7B:DA:75"
deviceKey	string	否	设备唯一标识	"OJ0789I0UR290UR2393U82"
defStockWarehouseId	integer(int64)	否	非油商品默认扣减库存仓库ID	1

com.leadwaycloud.rm.common.model.po.entity.RmOrder

订单

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	编号	"0989681627412313123"
type	string	是	类型	"SALE"
resources	string	是	来源【 ERP : ERP STORE : 实体店 MOBILE : 移动端 MALL : 网上商城】	"ONLINE_STORE"
channel	string	是	渠道【 STORE_POS : 门店机台(未来弃用) WECHAT_MINI_APPS : 微信小程序(未来弃用) WECHAT_MALL : 微信商城(未来弃用) APP : APP(未来弃用) ONLINE_SHOP : 电商商城(未来弃用) ONLINE : 线上 OFFLINE : 线下】	"ONLINE"
status	string	是	订单状态【 DRAFT : 待确认 CONFIRMED : 已确认 CANCEL : 已取消 EXPIRED : 已过期 DELETE : 已删除】	"CONFIRMED"
itemCount	integer(int32)	否	商品条数
paymentStatus	string	否	付款状态【 BE_PAID : 待付款 PAY_FINISH : 付款完成】	"PAID"
refundStatus	string	否	退款状态【 BE_REFUND : 待退款 REFUND_FINISH : 退款完成】	"FULL_REFUND"
deliveryStatus	string	否	发货状态【 BE_DELIVERED : 待发货 PARTIAL_SHIPPED : 部分发货 FULL_SHIPPED : 全部发货】	"FULL_SHIPPED"
returnStatus	string	否	退货状态【 BE_RETURN : 待退货 PARTIAL_RETURN : 部分退货 FULL_RETURN : 全部退货】	"FULL_RETURN"
receivedStatus	string	否	收货状态【 BE_RECEIVED : 待收货 PARTIAL_RECEIVED : 部分收货 FULL_RECEIVED : 全部收货】	"PARTIAL_RECEIVED"
purchaseStatus	string	否	采购状态【 BE_PROCURED : 待采购 ONGOING : 采购中 PURCHASED : 已采购】	"BE_PROCURED"
verifyStatus	string	否	审核状态【 PENDING : 待审核 ONGOING : 审核中 FINISH : 已审核】	"PENDING"
invoiceStatus	string	否	发票状态【 BE_INVOICED : 待开票 INVOICE_ING : 开票中 PARTIAL_INVOICED : 部分开票 FULL_INVOICED : 全部开票】	"BE_INVOICED"
totalAmount	number(double)	是	总金额	100
promAmount	number(double)	是	交易优惠金额	0
orderAmount	number(double)	是	订单金额	100
vatAmount	number(double)	是	订单税额	100
associateOrderId	integer(int64)	否	关联销售订单ID
scale	integer(int32)	是	金额计算精度	2
test	boolean	否	是否是测试订单	false
orderTime	string	是	订单时间	"2020-10-11 13:09:11"
endPaymentTime	string	否	付款截止时间	"2020-10-11 13:09:11"
customerNote	string	否	客户备注	"..."
merchantNote	OrderMerchantNoteBO[]	否	商户备注(仅仅在ERP上展示)	[{"note":"...","time":"2020-12-11 12:23:12"}]
reason	string	否	交易理由
verifyType	string	否	审核类型【 ONLINE_ORDER_REFUND : 线上销售订单退货审批 ONLINE_ORDER_EXCHANGE : 线上销售订单换货审批 BARCODE_ON_SHELF : 零管商品条码上架审批 BARCODE_OFF_SHELF : 零管商品条码下架审批 EPS_ORDER_CREDIT_LIMIT : 信用支付额度不足审核】	"SALE_ORDER_REFUND"
verifyResult	string	否	审核结果【 PASS : 通过 REFUSE : 拒绝 REJECT : 驳回】	"PASS"
verifyMsg	string	否	审核描述	"..."
reserved1	string	否	备用字段1(外部订单编号)
reserved2	string	否	备用字段2
reserved3	string	否	备用字段3(SAP订单编号,KDS叫号编号)
attachmentList	AttachmentBO[]	否	附件
memberId	integer(int64)	否	会员ID
memberName	string	否	会员名称	"张三"
memberBarcode	string	否	会员编号	"215252342234232145"
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxxx"
customerPersonName	string	否	客户联系人名称	"xxx"
salesPersonCode	string	否	业务员代号	"xxx"
posId	integer(int64)	否	机台ID	1
restaurantTableId	integer(int64)	否	桌位ID
fee	number(double)	否	运费
acceptSplittingDelivery	boolean	否	是否接受拆单发货
associateOrder	RmOrder	否
orderItemList	RmOrderItem[]	是	订单商品
orderMember	RmOrderMember	否
orderPos	RmOrderPos	否
orderHandmadeDiscountList	RmOrderHandmadeDiscount[]	否	订单手工折扣
orderDeliveryMode	RmOrderDeliveryMode	否
orderRestaurant	RmOrderRestaurant	否
customerInfo	RmPresaleOrderCustomerInfo	否
company	ResCompany	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderDeliveryMode

订单配送方式

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
deliveryMode	string	是	发货方式【 SELF : 自提/自送 EXPRESS : 快递】	"SELF"
fare	number(double)	否	运费	0
countryId	integer(int64)	否	国家ID
provinceId	integer(int64)	否	省份ID
cityId	integer(int64)	否	城市ID
areaId	integer(int64)	否	区ID
streetId	integer(int64)	否	街道ID
detailAddress	string	否	详细地址
receiver	string	否	收货人
phone	string	否	电话
selfPickupOutletsId	integer(int64)	否	商城自提网点
selfPickupDate	string(date)	否	自提日期	"2020-10-11"
selfPickupStartTime	string	否	自提时间区间(开始)	"08:00:00"
selfPickupEndTime	string	否	自提时间区间(结束)	"08:00:00"
remark	string	否	备注
country	SysCountry	否
province	SysProvince	否
city	SysCity	否
area	SysArea	否
street	SysStreet	否
selfPickupOutlets	RmMallSelfPickupOutlets	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderHandmadeDiscount

订单手工折扣

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
cashierId	integer(int64)	是	授权收银员ID
type	string	否	折扣类型
lineNo	integer(int32)	否	行号	1
promAmount	number(double)	是	手工优惠金额	0
cashier	RmCashier	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderMember

订单会员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
memberId	integer(int64)	否	会员ID	1
barcode	string	否	会员编号	"215252342234232145"
name	string	否	会员名称	"张三"
type	integer(int64)	否	会员类型	1
sex	string	否	会员性别	"1"
age	integer(int32)	否	会员年龄	22
birthday	string	否	会员生日	"1999-11-11"
tags	string[]	否	会员标签	["健身"]
customerId	integer(int64)	否	客户ID
customerCode	string	否	客户编号	"xxx"
customerName	string	否	客户名称	"xxx公司"
customerPersonId	integer(int64)	否	客户联系人ID
customerPersonCode	string	否	客户联系人编号	"xxx"
customerPersonName	string	否	客户联系人名称	"xxx"
customerPersonPhone	string	否	客户联系人手机号	"xxx"
businessUser	string	否	业务代表名称	"xxx"
businessPhone	string	否	业务代表手机号	"xxx"
member	SimpleCrmMember	是

com.leadwaycloud.rm.common.model.po.entity.RmOrderPos

订单机台

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
orderId	integer(int64)	是	订单ID
posId	integer(int64)	是	机台ID
cashierId	integer(int64)	否	收银员ID
shiftNo	integer(int32)	否	班次号	1
shiftDate	string	是	班次日	"2020-10-11"
pkNo	integer(int32)	否	流水号	1
operator	string	否	操作员
cateringOrderType	string	否	机台餐饮订单类型【 DINE_IN : 堂食 DINE_OUT : 外带 TAKEOUT : 外卖】
cateringOrderStatus	string	否	机台餐饮订单状态【 BE_PRODUCED : 待制作 PRODUCTION : 制作中 BE_PICKED : 待取餐 PICKED : 已取餐】
pos	RmDevicePos_Simple	是
cashier	RmCashier	否

com.leadwaycloud.rm.common.model.po.entity.RmOrderRestaurant

订单桌位信息

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
orderId	integer(int64)	是	订单ID
restaurantTable	RmRestaurantTable	否
consumerCount	integer(int32)	是	用餐人数	1
diningTime	string	是	用餐时间	"2020-10-11 13:09:11"
notes	string	否	备注

com.leadwaycloud.rm.common.model.po.entity.RmPresaleOrderCustomerInfo

预购单客户信息

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
assetId	integer(int64)	是	设备ID	1
orderId	integer(int64)	否	预售单ID	1
posNo	string	是	pos号	"1"
transNo	string	是	交易号	"1"
receipt	string	是	小票	"1"
note	string	否	备注	"1"
activeId	integer(int64)	是	活动ID	1
customerName	string	是	客户名称	"1"
phone	string	是	电话	"1"
backupPhone	string	否	备用电话	"1"
receiveMode	string	否	提货方式【 STORE_SELF : 门店自提 SUPPLY_POINT_SELF : 供应商自提 HOME_DELIVERY : 送货上门】	"STORE_SELF"
address	string	否	地址	"1"
archive	boolean	否	是否归档	false

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

桌位

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

com.leadwaycloud.rm.common.model.po.entity.SimpleCrmMember

会员

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID	1
barcode	string	是	会员编号	"002391117577753472"
status	string	是	会员状态【 ACTIVE : 活跃的 LOCK : 锁定的】	"ACTIVE"
name	string	是	名称	"张三"
mobilePhone	string	是	手机号码	"张三"
realName	string	否	真实名称
otherBarcode	string	否	第三方条码
source	string	是	会员来源
typeId	string	是	会员类型
partnerId	integer(int64)	是	关系ID

com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Long

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

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveCondition

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

com.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveMemberRecord

返回数据

名称	类型	必填	说明	示例
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	RmMallActiveMemberRecord[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.rm.mall.model.po.entity.RmMallActiveMemberRecord

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

com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.Long

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

com.leadwaycloud.core.model.R

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