# 规则创建接口

#### **接口用途**

- 创建规则

#### **接口说明**

- 本接口用来后台管平台创建规则

#### **action**

- `createRule`

**请求参数，ERP===>[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>ruleScenceKey</td><td>String</td><td>是</td><td>场景关键字</td><td>一般填写需要限制的表对象的表名</td></tr><tr><td>ruleSceneItemKey</td><td>String</td><td>否</td><td>场景对象ID</td><td>一般填写需要限制的表的ID</td></tr><tr><td>ruleScene</td><td>String</td><td>是</td><td>规则适用场景</td><td>自定义，例如制码和核销为不同的场景</td></tr><tr><td>ruleName</td><td>String</td><td>是</td><td>规则名称</td><td> </td></tr><tr><td>ruleKey</td><td>String</td><td>是</td><td>规则关键字</td><td>可理解为限制的类型，如BuyGet/ActivityLimit等</td></tr><tr><td>ruleValue</td><td>JSONObject</td><td>是</td><td>规则内容</td><td> </td></tr><tr><td>startTime</td><td>String</td><td>是</td><td>规则开始时间</td><td> </td></tr><tr><td>endTime</td><td>String</td><td>是</td><td>规则结束时间</td><td> </td></tr><tr><td>messageTpl</td><td>String</td><td>是</td><td>规则不满足提示消息模板</td><td>错误提示信息</td></tr><tr><td>isActive</td><td>String</td><td>否</td><td>是否启用</td><td>Y/N 默认Y</td></tr><tr><td>isContinue</td><td>String</td><td>否</td><td>规则不满足是否继续</td><td>Y/N 默认N</td></tr><tr><td>ruleOrder</td><td>Integer</td><td>否</td><td>规则执行顺序</td><td>默认0，数值越小优先级越高</td></tr></tbody></table>

**规则内容(ruleValue)说明**

**BuyGet 报文格式 根据不同的规则选择不同的字段**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>codeConfigList</td><td>String</td><td>否</td><td>配置规则sku分组</td><td>分组格式\["111,222","333,444"\]</td></tr><tr><td>codeType</td><td>String</td><td>否</td><td>code类型</td><td>分组类型支持SKU(sku)/品类(type)/规格(spec)</td></tr><tr><td>checkExpression</td><td>String</td><td>否</td><td>规则检查表达式</td><td>根据配置的分组检查上送产品是否满足</td></tr><tr><td>returnExpression</td><td>String</td><td>否</td><td>规则匹配返回产品表达式</td><td>检查表达式通过的情况下匹配返回产品是否满足</td></tr><tr><td>limitMinAmount</td><td>BigDecimal</td><td>否</td><td>满足规则的最小交易金额</td><td> </td></tr><tr><td>amountOff</td><td>BigDecimal</td><td>否</td><td>固定金额折扣</td><td>直接优惠折抵的金额</td></tr><tr><td>discountOff</td><td>BigDecimal</td><td>否</td><td>折扣</td><td>在规则匹配的金额基础上折扣</td></tr><tr><td>superposition</td><td>Integer</td><td>否</td><td>是否可以叠加使用</td><td>面100减20，如果可叠加就是满200减40</td></tr><tr><td>fixedAmount</td><td>BigDecimal</td><td>否</td><td>固定金额</td><td>例如：10元喝咖啡，将产品金额变为10元</td></tr><tr><td>setMealFixedAmount</td><td>BigDecimal</td><td>否</td><td>固定套餐金额</td><td>将匹配到多个产品设置为固定金额</td></tr><tr><td>sort</td><td>String</td><td>否</td><td>上送商品排序</td><td>例如：price/a 价格升序排列</td></tr><tr><td>isMerchant</td><td>String</td><td>否</td><td>是否为商户自由规则</td><td> </td></tr><tr><td>faceValue</td><td>BigDecimal</td><td>否</td><td>固定值</td><td>设置此值降直接替换规则计算的面值</td></tr><tr><td>netValue</td><td>BigDecimal</td><td>否</td><td>固定收银机入账金额</td><td> </td></tr><tr><td>netRadio</td><td>BigDecimal</td><td>否</td><td>固定收银机入账折扣</td><td> </td></tr><tr><td>reduceValue</td><td>BigDecimal</td><td>否</td><td>规定规则抵扣金额</td><td>对应元来的posPrice</td></tr><tr><td>cashierCode</td><td>String</td><td>否</td><td>收银机对接编号</td></tr></tbody></table>

**限制规则报文结构**

- 目前支持的炼制规则包括
- ScenceLimit 场景限制
- ActivityLimit 活动限制
- CardBinLimit 卡bin限制
- CardNoLimit 卡号限制
- CityLimit 城市限制
- PosTidLimit POS终端限制

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-l"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>limitWay</td><td>String</td><td>是</td><td>限量方式</td><td>数量限制(Q)/金额显示(A)</td></tr><tr><td>limitType</td><td>String</td><td>是</td><td>限量类型</td><td>白名单(W)/黑名单(B)</td></tr><tr><td>retained</td><td>String</td><td>否</td><td>是否支持滚存</td><td> </td></tr><tr><td>binPrefixNum</td><td>Integer</td><td>否</td><td>bin码的前缀位数</td><td> </td></tr><tr><td>binSuffixNum</td><td>Integer</td><td>否</td><td>bin码的后缀位数</td><td> </td></tr><tr><td>description</td><td>String</td><td>否</td><td>规则描述</td><td> </td></tr><tr><td>limitItems</td><td>JSONArray</td><td>是</td><td>限量明细</td></tr></tbody></table>

**限制明细报文结构**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-l-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>limitKey</td><td>String</td><td>是</td><td>限量关键字</td><td>例如卡号、卡bin等</td></tr><tr><td>limitMaxDay</td><td>Long</td><td>是</td><td>日限量</td><td>0表示不限量</td></tr><tr><td>limitMaxWeek</td><td>Long</td><td>是</td><td>周限量</td><td>0表示不限量</td></tr><tr><td>limitMaxMonth</td><td>Long</td><td>是</td><td>月限量</td><td>0表示不限量</td></tr><tr><td>limitMaxYear</td><td>Long</td><td>是</td><td>年限量</td><td>0表示不限量</td></tr><tr><td>limitMaxTotal</td><td>Long</td><td>是</td><td>总限量</td><td>0表示不限量</td></tr><tr><td>startTime</td><td>String</td><td>是</td><td>开始时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>endTime</td><td>String</td><td>是</td><td>结束时间</td><td>yyyyMMddHHmmss</td></tr></tbody></table>

**WeekTime 指定日限制**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-w"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>weekDay</td><td>String</td><td>是</td><td>指定日期</td><td>指定一周中的日期 格式为7位 \[0\]表示不可使用 \[1\]表示可以使用。eg:0000000 日一二三四五六</td></tr><tr><td>times</td><td>String</td><td>否</td><td>指定时间段</td><td>每12位表示一个时间区间，多个用","分割。eg:090000120000,220000235959</td></tr></tbody></table>

**请求报文举例**

```
暂无

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;ERP**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>returnCode</td><td>String</td><td>是</td><td>请求返回码</td><td>00成功</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td></tr></tbody></table>

**返回报文举例**

```
暂无
```