后台管理类接口 新增活动接口 接口用途 当有新的电子凭证活动时，ERP调用此接口 接口说明 PM做电子凭证立项后，3.0系统的活动Id绑定到电子凭证活动中，做一一对应关系 action activityInsert 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 activityName String 是 活动名称 小于100个字符 ebuyActivityId String 是 易百活动ID 小于40个字符 saleChannelId String 是 取码方   validStart String 是 活动有效开始时间   validEnd String 是 活动有效结束时间   isActive String 否 是否启用（Y/N） 如不填，默认情况是启用 createUser String 否 创建人   createTime String 是 创建时间 yyyyMMddHHmmss updateTime String 是 更新时间 yyyyMMddHHmmss activityConfig Object 否 活动配置 请求报文举例 { "activityName": "中信电子凭证活动", "ebuyActivityId": "2018090500", "saleChannelId":"10002401" "validStart": "20180905112600", "validEnd": "20181005112600", "createUser": "xiedonglei", "createTime": "20180905112600", "activityConfig": { "channelPublicKey": "publicKey", "whalePublicKey": "publlicKey", "verifyNotifyURL": "www.baidu.com" } } 返回参数， WHALE ===>ERP 字段 类型 是否必填 字段意义 备注 returnCode String 是 返回码   returnMsg String 是 返回信息 返回报文举例 { "returnCode": "00", "returnMsg": "SUCCESS" } 制码通知查询接口 接口用途 当需要页面中展示制码通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要 whale 进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必须有明确的订单编号 action makeNotifyQuery 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 saleChannelOrderId String 是 销售渠道制码订单id 小于64个字符 请求报文举例 { "saleChannelOrderId": "20180905000" } 返回参数， WHALE ===>ERP 字段 类型 是否必填 字段意义 备注 notifyId String 是 数据库通知id   orderId String 是 数据库订单id   saleChannelId Long 是 销售渠道id   saleChannelOrderId String 是 销售渠道制码订单号   createDate String 是 订单创建日期 YYYYmmdd createTime String 是 订单创建时间 YYYYmmddHHMMSS orderMobile String 否 制码时上送手机号   codeNum int 是 订单制码总数   orderExtend String 否 订单扩展   isNotify String 是 是否通知 已通知，未通知 isCanVoid String 是 是否可撤销 可撤销，不可撤销 returnCode String(2) 是 订单返回码 00为成功，其他均为失败 updateDate String 是 订单更新日期 YYYYmmdd updateTime String 是 订单更新时间 YYYYmmddHHMMSS status String 是 状态描述 返回报文举例 { "orderId": "99000009100010101732123", "requestId": "171698602301", "saleChannelId": 123456, "saleChannelOrderId":"10101732123", "createDate":"20180905", "createTime":"20180905160911", "orderMobile":"13524121212", "codeNum":1, "isNotify":"已通知", "isCanVoid":"可撤销", "createDate":"20180905", "createTime":"20180905160911", "returnCode": "00", "status": "订单初始状态" } 制码通知重试接口 接口用途 当需要对制码重新通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要 whale 进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必须有明确的订单编号 action makeNotifyRetry 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 saleChannelOrderId String 是 销售渠道制码订单id 小于64个字符 请求报文举例 { "saleChannelOrderId": "20180905000" } 返回参数， WHALE ===>ERP 字段 类型 是否必填 字段意义 备注 notifyId String 是 数据库通知id   orderId String 是 数据库订单id   saleChannelId Long 是 销售渠道id   saleChannelOrderId String 是 销售渠道制码订单号   createDate String 是 订单创建日期 YYYYmmdd createTime String 是 订单创建时间 YYYYmmddHHMMSS orderMobile String 否 制码时上送手机号   codeNum int 是 订单制码总数   orderExtend String 否 订单扩展   isNotify String 是 是否通知 已通知，未通知 isCanVoid String 是 是否可撤销 可撤销，不可撤销 returnCode String(2) 是 订单返回码 00为成功，其他均为失败 updateDate String 是 订单更新日期 YYYYmmdd updateTime String 是 订单更新时间 YYYYmmddHHMMSS status String 是 状态描述 返回报文举例 { "orderId": "99000009100010101732123", "requestId": "171698602301", "saleChannelId": 123456, "saleChannelOrderId":"10101732123", "createDate":"20180905", "createTime":"20180905160911", "orderMobile":"13524121212", "codeNum":1, "isNotify":"已通知", "isCanVoid":"可撤销", "createDate":"20180905", "createTime":"20180905160911", "returnCode": "00", "status": "订单初始状态" } 新增销售渠道接口 接口用途 当有新的销售渠道对接时，ERP调用此接口 接口说明 每个第三取码方均为一个销售渠道，ERP调用此接口后能新增一个销售渠道供日后取码使用 action saleChanneInsert 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 saleChannelName String 是 销售渠道名称 小于100个字符 isActive String 否 是否启用（Y/N） 如不填，默认情况是启用 remark String 否 备注   creatorName String 否 创建人   createTime String 是 创建时间 yyyyMMddHHmmss updateTime String 是 更新时间 yyyyMMddHHmmss saleChannelConfig Object< saleChannelConfig > 否 销售渠道配置 请求报文举例 { "sendChannelName": "中信银行", "isActive": "Y", "remark":"备注信息", "saleChannelConfig": { "channelPublicKey": "publicKey", "whalePublicKey": "publlicKey", "verifyNotifyURL": "www.baidu.com" } } 返回参数，中间件===>收银机 字段 类型 是否必填 字段意义 备注 traceNo String 是 收银机流水号 不允许重复 orderNo String 是 交易订单号 单位：元 transDate String 是 交易时间 格式为：YYYYmmddHHMMSS returnCode String 是 返回码 00表示交易成功，其他表示失败 returnDesc String 是 返回信息 交易结果描述或错误原因 rightsTimes Integer 是 权益次数 返回可以享受的权益次数 moneyBalance Price 是 现金余额 单位：元 pointBalance Price 是 积分余额 单位：分 printDetail Object 否 打印信息 如需要在收银小票上打印信息时必填 memberDetail Object< memberDetail > 否 会员信息 返回本次交易的会员信息 返回报文举例 { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "rightsTimes": 1, "moneyBalance": 40.8, "pointBalance": 40000, "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "0", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } 新增制码渠道接口 接口用途 当有新的制码渠道对接时，ERP调用此接口 接口说明 每个第三制码方均为一个制码渠道，ERP调用此接口后能新增一个制码渠道供日后制码使用 action sendChanneInsert 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 sendChannelName String 是 制码渠道名称 小于100个字符 isActive String 否 是否激活（Y/N） 如不填，默认情况是激活 sendChannelConfig Object< sendChannelConfig > 是 制码渠道配置 必填 请求报文举例 { "sendChannelName": "资和信", "isActive": "Y", "sendChannelConfig": { "thirdChannelNo": "M000001545", "makeCodeURL": "www.baidu.com", "verifyURL": "www.baidu.com", "verifyNotifyURL": "www.baidu.com" } } 返回参数，中间件===>收银机 字段 类型 是否必填 字段意义 备注 traceNo String 是 收银机流水号 不允许重复 orderNo String 是 交易订单号 单位：元 transDate String 是 交易时间 格式为：YYYYmmddHHMMSS returnCode String 是 返回码 00表示交易成功，其他表示失败 returnDesc String 是 返回信息 交易结果描述或错误原因 rightsTimes Integer 是 权益次数 返回可以享受的权益次数 moneyBalance Price 是 现金余额 单位：元 pointBalance Price 是 积分余额 单位：分 printDetail Object 否 打印信息 如需要在收银小票上打印信息时必填 memberDetail Object< memberDetail > 否 会员信息 返回本次交易的会员信息 返回报文举例 { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "rightsTimes": 1, "moneyBalance": 40.8, "pointBalance": 40000, "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "0", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } 新增券模板接口 接口用途 当需要创建新的券模板时，ERP调用此接口 接口说明 每个易百productId对应一个券模板，一个券模板可供多个活动使用 action templateInsert 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 templateName String 是 券模板名称   sendChannelId Long 是 制码渠道ID   brandId Long 是 品牌ID   productId Long 是 易百产品ID   ticketType int 是 券类型 1：代金券，2：折抵券，3：产品抵用券，4：复合产品券 faceValue String 是 面值 12位字符串，分为单位 sendType String 是 券模板名称 1：接口，2：批导 isActive String 否 是否启用（Y/N） 如不填，默认情况是启用 remark String 否 备注   createUser String 否 创建人   createTime String 是 创建时间 yyyyMMddHHmmss updateTime String 是 更新时间 yyyyMMddHHmmss templateConfig Object< templateConfig > 否 券模板配置 请求报文举例 { "templateName": "COSTA30元代金券", "sendChannelId":123L, "brandId":686L, "productId":12345L, "ticketType":1, "sendType":1, "faceValue":"000000003000" "isActive": "Y", "remark":"备注信息", "createUser":"xiedonglei", "templateConfig": { "channelPublicKey": "publicKey", "whalePublicKey": "publlicKey", "verifyNotifyURL": "www.baidu.com" } } 返回参数，中间件===>收银机 字段 类型 是否必填 字段意义 备注 traceNo String 是 收银机流水号 不允许重复 orderNo String 是 交易订单号 单位：元 transDate String 是 交易时间 格式为：YYYYmmddHHMMSS returnCode String 是 返回码 00表示交易成功，其他表示失败 returnDesc String 是 返回信息 交易结果描述或错误原因 rightsTimes Integer 是 权益次数 返回可以享受的权益次数 moneyBalance Price 是 现金余额 单位：元 pointBalance Price 是 积分余额 单位：分 printDetail Object 否 打印信息 如需要在收银小票上打印信息时必填 memberDetail Object< memberDetail > 否 会员信息 返回本次交易的会员信息 返回报文举例 { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "rightsTimes": 1, "moneyBalance": 40.8, "pointBalance": 40000, "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "0", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } 核销通知查询接口 接口用途 当需要页面中展示核销通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要 whale 进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必须有明确的订单编号 action makeNotifyQuery 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 saleChannelOrderId String 是 销售渠道制码订单id 小于64个字符 请求报文举例 { "saleChannelOrderId": "20180905000" } 返回参数， WHALE ===>ERP 字段 类型 是否必填 字段意义 备注 notifyId String 是 数据库通知id   orderId String 是 数据库订单id   saleChannelId Long 是 销售渠道id   saleChannelOrderId String 是 销售渠道制码订单号   createDate String 是 订单创建日期 YYYYmmdd createTime String 是 订单创建时间 YYYYmmddHHMMSS orderMobile String 否 制码时上送手机号   codeNum int 是 订单制码总数   orderExtend String 否 订单扩展   isNotify String 是 是否通知 已通知，未通知 isCanVoid String 是 是否可撤销 可撤销，不可撤销 returnCode String(2) 是 订单返回码 00为成功，其他均为失败 updateDate String 是 订单更新日期 YYYYmmdd updateTime String 是 订单更新时间 YYYYmmddHHMMSS status String 是 状态描述 返回报文举例 { "orderId": "99000009100010101732123", "requestId": "171698602301", "saleChannelId": 123456, "saleChannelOrderId":"10101732123", "createDate":"20180905", "createTime":"20180905160911", "orderMobile":"13524121212", "codeNum":1, "isNotify":"已通知", "isCanVoid":"可撤销", "createDate":"20180905", "createTime":"20180905160911", "returnCode": "00", "status": "订单初始状态" } 核销通知查询接口 接口用途 当需要页面中展示核销通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要 whale 进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必须有明确的订单编号 action makeNotifyQuery 请求参数，ERP===> WHALE 字段 类型 是否必填 字段意义 备注 saleChannelOrderId String 是 销售渠道制码订单id 小于64个字符 请求报文举例 { "saleChannelOrderId": "20180905000" } 返回参数， WHALE ===>ERP 字段 类型 是否必填 字段意义 备注 notifyId String 是 数据库通知id   orderId String 是 数据库订单id   saleChannelId Long 是 销售渠道id   saleChannelOrderId String 是 销售渠道制码订单号   createDate String 是 订单创建日期 YYYYmmdd createTime String 是 订单创建时间 YYYYmmddHHMMSS orderMobile String 否 制码时上送手机号   codeNum int 是 订单制码总数   orderExtend String 否 订单扩展   isNotify String 是 是否通知 已通知，未通知 isCanVoid String 是 是否可撤销 可撤销，不可撤销 returnCode String(2) 是 订单返回码 00为成功，其他均为失败 updateDate String 是 订单更新日期 YYYYmmdd updateTime String 是 订单更新时间 YYYYmmddHHMMSS status String 是 状态描述 返回报文举例 { "orderId": "99000009100010101732123", "requestId": "171698602301", "saleChannelId": 123456, "saleChannelOrderId":"10101732123", "createDate":"20180905", "createTime":"20180905160911", "orderMobile":"13524121212", "codeNum":1, "isNotify":"已通知", "isCanVoid":"可撤销", "createDate":"20180905", "createTime":"20180905160911", "returnCode": "00", "status": "订单初始状态" } 规则创建接口 接口用途 创建规则 接口说明 本接口用来后台管平台创建规则 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 是 请求返回信息 返回报文举例 暂无 ESB制码订单 Whale同步调用ESB制码接口 接口用途 当 Whale 需要进行第三方制码时， Whale 将请求报文发送给ESB，ESB再统一对不同制码方通信。 接口说明 单产品制码时，为同步制码，需实时返回制码结果。 请求参数， WHALE ===>ESB 字段 类型 是否必填 字段意义 备注 saleChannelId String 是 取码方id   sendChannelId String 是 制码方id   sendChannelOrderId String(64) 是 制码方订单号   whaleTradeNo String(64) 是 易百唯一订单号，ESB可用于与制码方作3订单唯一标识   channelMid String 是 渠道商户编号 制码方分配的商编，存于sendChannel表中 channelTid String 是 渠道终端编号 制码方分配的终端号，存于sendChannel表中 orderEncryptKey String 是 制码方报文加密密钥 3DES加密时为密钥，公私钥对加密时为公钥字符串 createDate String 是 制码日期 yyyyMMdd createTime String 是 制码时间 yyyyMMddHHmmss items < makeOrderItems > 是 制码明细 请求报文举例 { "saleChannelOrderId": "20181024154201", "requestId": "20181024154201", "notifyType": { "mobilePhone": "13524161800" }, "item": { "saleChannelItemId":"20181024154201", "commissionDate":"1", "validDays": 10, "ticketId": 1, "makeFundsChannel": { "channelBenefit": 0, "merchantBenefit": 500, "userRealAmount": 2500 } } } 返回参数，ESB===> WHALE 字段 类型 是否必填 字段意义 备注 returnCode String 是 请求返回码   returnMsg String 是 请求返回信息   data Object< makeCodeResponseData > 否 码信息 返回报文举例 { "returnCode": "00", "returnMsg": "SUCCESS", "data": { "saleChannelOrderId": "20181120155110", "tradeNo": "c1eca7fbda51430cb5100ec0699a5b00", "createTime": "20181120155225", "isNotify": "1", "codeNum": 1, "items": [{ "codeDetail": [{ "codeURL": "http://qrcode.url.ag/make?0000001496A382FA4725D24FA27839FC1680D136CAFE515519B94B1D&type=QRCODE", "code": "10116574123700278846", "useTimes": 10, "status": "00", "statusDesc": "未使用" }], "validEnd": "20181201000000", "validStart": "20181121000000", "itemResultMsg": "SUCCESS", "itemResultCode": "00", "saleChannelItemId": "20181120155110", "ticketId": 9000000010, "ticketName":"星巴克30元代金券", "activityId":"1000000006", "activityName":"中信银行星巴克代金券活动" }], "createDate": "20181120" } }