规则创建接口
接口用途
- 创建规则
接口说明
- 本接口用来后台管平台创建规则
action
createRule
请求参数，ERP===>WHALE
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| ruleScenceKey | String | 是 | 场景关键字 | 一般填写需要限制的表对象的表名 |
| ruleSceneItemKey | String | 否 | 场景对象ID | 一般填写需要限制的表的ID |
| ruleScene | String | 是 | 规则适用场景 | 自定义，例如制码和核销为不同的场景 |
| ruleName | String | 是 | 规则名称 | |
| ruleKey | String | 是 | 规则关键字 | 可理解为限制的类型，如BuyGet/ActivityLimit等 |
| ruleValue | JSONObject | 是 | 规则内容 | |
| startTime | String | 是 | 规则开始时间 | |
| endTime | String | 是 | 规则结束时间 | |
| messageTpl | String | 是 | 规则不满足提示消息模板 | 错误提示信息 |
| isActive | String | 否 | 是否启用 | Y/N 默认Y |
| isContinue | String | 否 | 规则不满足是否继续 | Y/N 默认N |
| ruleOrder | Integer | 否 | 规则执行顺序 | 默认0，数值越小优先级越高 |
规则内容(ruleValue)说明
BuyGet 报文格式 根据不同的规则选择不同的字段
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| codeConfigList | String | 否 | 配置规则sku分组 | 分组格式["111,222","333,444"] |
| codeType | String | 否 | code类型 | 分组类型支持SKU(sku)/品类(type)/规格(spec) |
| checkExpression | String | 否 | 规则检查表达式 | 根据配置的分组检查上送产品是否满足 |
| returnExpression | String | 否 | 规则匹配返回产品表达式 | 检查表达式通过的情况下匹配返回产品是否满足 |
| limitMinAmount | BigDecimal | 否 | 满足规则的最小交易金额 | |
| amountOff | BigDecimal | 否 | 固定金额折扣 | 直接优惠折抵的金额 |
| discountOff | BigDecimal | 否 | 折扣 | 在规则匹配的金额基础上折扣 |
| superposition | Integer | 否 | 是否可以叠加使用 | 面100减20，如果可叠加就是满200减40 |
| fixedAmount | BigDecimal | 否 | 固定金额 | 例如：10元喝咖啡，将产品金额变为10元 |
| setMealFixedAmount | BigDecimal | 否 | 固定套餐金额 | 将匹配到多个产品设置为固定金额 |
| sort | String | 否 | 上送商品排序 | 例如：price/a 价格升序排列 |
| isMerchant | String | 否 | 是否为商户自由规则 | |
| faceValue | BigDecimal | 否 | 固定值 | 设置此值降直接替换规则计算的面值 |
| netValue | BigDecimal | 否 | 固定收银机入账金额 | |
| netRadio | BigDecimal | 否 | 固定收银机入账折扣 | |
| reduceValue | BigDecimal | 否 | 规定规则抵扣金额 | 对应元来的posPrice |
| cashierCode | String | 否 | 收银机对接编号 |
限制规则报文结构
- 目前支持的炼制规则包括
- ScenceLimit 场景限制
- ActivityLimit 活动限制
- CardBinLimit 卡bin限制
- CardNoLimit 卡号限制
- CityLimit 城市限制
- PosTidLimit POS终端限制
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| limitWay | String | 是 | 限量方式 | 数量限制(Q)/金额显示(A) |
| limitType | String | 是 | 限量类型 | 白名单(W)/黑名单(B) |
| retained | String | 否 | 是否支持滚存 | |
| binPrefixNum | Integer | 否 | bin码的前缀位数 | |
| binSuffixNum | Integer | 否 | bin码的后缀位数 | |
| description | String | 否 | 规则描述 | |
| limitItems | JSONArray | 是 | 限量明细 |
限制明细报文结构
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| limitKey | String | 是 | 限量关键字 | 例如卡号、卡bin等 |
| limitMaxDay | Long | 是 | 日限量 | 0表示不限量 |
| limitMaxWeek | Long | 是 | 周限量 | 0表示不限量 |
| limitMaxMonth | Long | 是 | 月限量 | 0表示不限量 |
| limitMaxYear | Long | 是 | 年限量 | 0表示不限量 |
| limitMaxTotal | Long | 是 | 总限量 | 0表示不限量 |
| startTime | String | 是 | 开始时间 | yyyyMMddHHmmss |
| endTime | String | 是 | 结束时间 | yyyyMMddHHmmss |
WeekTime 指定日限制
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| weekDay | String | 是 | 指定日期 | 指定一周中的日期 格式为7位 [0]表示不可使用 [1]表示可以使用。eg:0000000 日一二三四五六 |
| times | String | 否 | 指定时间段 | 每12位表示一个时间区间，多个用","分割。eg:090000120000,220000235959 |
请求报文举例
暂无
返回参数，WHALE===>ERP
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
|---|---|---|---|---|
| returnCode | String | 是 | 请求返回码 | 00成功 |
| returnMsg | String | 是 | 请求返回信息 |
返回报文举例
暂无