局域网二期接口

1.购物车模块

• 下单接口
  

  云收银做成本地购物车，下单时将本地购车内的所有菜统一通过下单接口，下单到主收银。

2.收款模块

• 拉取账单接口（普通收款）

  • 接口入参

    private String orderId;
        private String entityId;
        private String opUserId;
        /**
         * 支付平台，0表示通用，其他值如下：
         * short FROM_DEFAULT = 0;
         * short FROM_ALL_IN = 1; // 通联pos
         * short FROM_NEW_LAND = 2; // 新大陆pos
         * short FROM_ICBC = 3; // 工行pos
         * short FROM_BRIGHT = 4; // 慧银pos
         * short FROM_BOC = 5; // 中国银行pos
         * short FROM_UNION_PAY = 6; // 银联pos
         * short FROM_RCC = 7; // 农信pos
         */
        private short platform;
        private int supportMemberVerify = 1;//是否支持会员核销，0不支持（老版本），1支持

  • 接口返回值：GetCloudCashBillResponse.java

• 拉取账单接口（会员收款）

  • 接口入参：BillCloudCashRequest.java

        /**
         * 支付平台，0表示通用，其他值如下：
         * short FROM_DEFAULT = 0;
         * short FROM_ALL_IN = 1; // 通联pos
         * short FROM_NEW_LAND = 2; // 新大陆pos
         * short FROM_ICBC = 3; // 工行pos
         * short FROM_BRIGHT = 4; // 慧银pos
         * short FROM_BOC = 5; // 中国银行pos
         * short FROM_UNION_PAY = 6; // 银联pos
         * short FROM_RCC = 7; // 农信pos
         */
        private short platform;
        private PromotionParam promotionParam;//账单请求参数-优惠模块
        private TradeParam tradeParam;//交易对象
        private OrderParam orderParam;//账单请求参数-订单模块
        private String cardId;//会员未绑定火小二账户时，传cardId
        private boolean mcGroupPromotionSupported; // 是否支持优惠券组合，兼容云收银之前的版本不支持优惠券复用：Q2优惠券复用

  • 接口返回值：BillCloudCashResponse.java

• 获取代金券面额列表

  • 接口入参

     private String kindPayId;
     private String entityId;

  • 接口返回值：

    private List<VoucherInfoVo> voucherFundList;

  VoucherInfoVo.java

• 获取签字员工列表

  • 接口入参

     private String kindPayId;
     private String entityId;

  • 接口返回值：

      private List<SignInfoVo> signInfoVos;
      private String signUnitKindPayDetailId;

  SignInfoVo.java

• 获取挂账单位（人）列表

  • 接口入参

    private String kindPayId;
    private String entityId;
    private String keyword;
    private int pageIndex;
    private int pageSize;

  • 接口返回值：

      private List<SignInfoVo> signInfoVos;
    private String signUnitKindPayDetailId;

  SignInfoVo.java

• 账单优惠（整单打折，卡优惠）

  • 接口入参
    

    private String orderId;
    private String entityId;
    private String opUserId;
    private List<Promotion> promotions;

  Promotion.java

  • 接口返回值：
    

       private String orderId;
    private String entityId;
    private List<Promotion> promotions;
    /**
     * 订单最后修改时间
     */
    private long modifyTime;

  Promotion.java

• 获取支付选项信息

  免单需要，用来获取KindPayDetailDto的KindPayDetailOptionDto和id

  • 接口入参

    private String kindPayId;
    private String entityId;
    private String name;
    private int mode;

  • 接口返回值：

        private List<KindPayDetailDto> kindPayDetailDtoList;

  KindPayDetailDto.java

• 收款接口

  • 接口入参

    private String customerRegisterId;
    private String orderId;
    private String entityId;
    private String opUserId;
    private boolean notCheckPromotion;
    private List<Promotion> promotions;
    /**
     * 是否支持会员核销,0不支持，1支持
     */
    private int supportMemberVerify;
    //普通收款（现金、挂账、银行卡、第三方支付等）
    private List<Fund> funds;
    private boolean checkLimit;
    /**
     * 收款用户名
     */
    private String userName;
    /**
     * 付款方式名称
     */
    private String payName;
    /**
     * 订单编号
     */
    private int code;
    /**
     * 桌位编码
     */
    private String seatCode;
    /**
     * 桌位名称
     */
    private String seatName;
    //代金券收款
    private List<VoucherFund> funds;

  • 接口返回值：
    CloudCashCollectPayResponse.java

• 获取支付状态

  第三方支付时需要，比如微信扫码支付，需要轮训该接口获取支付状态

  • 接口入参

    private String snapshotId;
    private String entityId;
    private String outTradeNo;

  • 接口返回值：

          /**
     * 支付列表
     */
    private List<Fund> funds;
    /**
     * 快照id，不可为空。
     */
    private String snapshotId;
    /**
     * 支付状态，不可为空 -1表示支付失败，1表示支付成功，2表示正在支付。
     */
    private int status;
    /**
     * 订单最后修改时间
     */
    private long modifyTime;
    private double userCollectLimit;
    private double userCurrAmount;
    /**
     * 支付流水号
     */
    private String outTradeNo;

• 结账完毕

  • 接口入参

    String entityId, 
    String operatorId, 
    String orderId, 
    long modifyTime

  • 接口返回值：-

• 清空折扣

  • 接口入参

     private String orderId;
    private String entityId;
    private String opUserId;

  • 接口返回值：-

     /**
         * 订单最后修改时间
         */
        private long modifyTime;

• 云收银退款

  • 接口入参

     private String orderId;
    private String entityId;
    private String opUserId;
    private List<Refund> refunds;

  • 接口返回值：-

    private List<Refund> refunds;
    private double userCollectLimit;
    private double userCurrAmount;
    /**
     * 订单最后修改时间
     */
    private long modifyTime;

• 优惠券核销

  • 接口入参

      private String entityId;
    /**
     * 优惠券code
     */
    private String promotionCode;
    private String orderId;
    private String opUserId;

  • 接口返回值：-

    /**
         * 优惠类型，对应tc的ChannelType，本店在线优惠位8，单品兑换券在线优惠位13
         */
        private short type;
        /**
         * 核销失败原因
         */
        private String verifyMessage;
        /**
         * 1表示核销正确，-1表示核销失败
         */
        private int status;
        /**
         * 优惠交易流水号
         */
        private String outTradeNo;

• 获取订单的全部支付列表

  收款完成界面使用

  • 接口入参

       private String orderId;
    private String entityId;
    private String opUserId;

  • 接口返回值：-

     /**
     * 云收银账单支付详情列表，可以为空
     */
    private List<Pay> pays;
    /**
     * 订单的收款模式，0表示普通收款，1表示快捷收款
     */
    private short collectPayMode;
    /**
     * 应收金额(分)
     */
    private int needFee;
    /**
     * 当有足够的付款金额时是否自动结账完毕
     */
    private boolean autoCheckout;
    /**
     * 是否是外卖，0表示不是，1表示是
     */
    private short takeout;

• 快捷收款
  

  需要确认主收银是否有快捷收款的逻辑