开发者后台

  • 开发者平台
  • >
  • 餐饮文档中心
    API开发文档
  • 1 平台介绍
  • 2 如何入驻
    • 2.1 入驻说明
    • 2.2 品牌商入驻
    • 2.3 服务商入驻
    • 2.4 开放平台服务协议
  • 3 开发指南
    • 3.1 接口调用规则（必读）
    • 3.2 签名规则
    • 3.3 公共请求参数
    • 3.4 公共响应参数
    • 3.5 平台返回状态码
      • 3.5.1 订单配送状态
      • 3.5.2 订单取消原因表
      • 3.5.3 错误码
      • 3.5.4 订单支付状态表
      • 3.5.5 订单状态
      • 3.5.6 支付机构代码
      • 3.5.7 回调接口编码
    • 3.6 获取门店/品牌token
    • 3.7 开发者辅助工具
      • 3.7.1 签名生成工具
      • 3.7.2 接口示例demo
      • 3.7.3 CRM版本判断工具
      • 3.7.4 POS版本判断工具
    • 3.8 常见FAQ
      • 3.8.1 订单相关
      • 3.8.2 会员相关
      • 3.8.3 菜品相关
      • 3.8.4 授权相关
      • 3.8.5 其它
  • 4 ONPOS版
    • 4.1 业务介绍（ONPOS版）
    • 4.2 解决方案
      • 4.2.1 第三方数据监管/数据分析场景方案
      • 4.2.2 第三方财务系统对接
      • 4.2.3 三方券核销解决方案
      • 4.2.4 三方配送解决方案
      • 4.2.5 供应链2.0财务集成解决方案
    • 4.3 接口申请与授权流程（ONPOS版）
    • 4.4 API文档
      • 4.4.1 门店信息
        • 4.4.1.1 API列表
        • 4.4.1.2 查询桌台信息
        • 4.4.1.3 支付类型查询
        • 4.4.1.4 获取门店列表
        • 4.4.1.5 门店设备状态推送接口
        • 4.4.1.6 门店设备列表查询接口
        • 4.4.1.7 附加费配置查询接口
        • 4.4.1.8 查询门店营业状态
        • 4.4.1.9 获取服务下可用门店
        • 4.4.1.10 获取门店经营时间
        • 4.4.1.11 修改门店营业状态
        • 4.4.1.12 获取门店信息
      • 4.4.2 菜品
        • 4.4.2.1 API列表
        • 4.4.2.2 菜品父级信息查询
        • 4.4.2.3 菜品分页查询
        • 4.4.2.4 菜品分类信息查询
        • 4.4.2.5 菜品分类查询
        • 4.4.2.6 菜品精确查询
        • 4.4.2.7 接收菜品分类变更通知
        • 4.4.2.8 接收菜品变更通知
        • 4.4.2.9 批量修改门店菜品售卖数量
      • 4.4.3 订单信息
        • 4.4.3.1 API列表
        • 4.4.3.2 查询订单详情
        • 4.4.3.3 订单状态推送通知
        • 4.4.3.4 查询订单列表
      • 4.4.4 配送
        • 4.4.4.1 API列表
        • 4.4.4.2 配送下单接口
        • 4.4.4.3 自配送介绍
        • 4.4.4.4 配送取消通知
        • 4.4.4.5 商家自配送状态推送
      • 4.4.5 后厨管理
        • 4.4.5.1 API列表
        • 4.4.5.2 后厨菜品制作状态变更推送
        • 4.4.5.3 KDS后厨菜品制作状态变更推送
      • 4.4.6 会员1.0
        • 4.4.6.1 API列表
        • 4.4.6.2 会员基本信息
          • 4.4.6.2.1 创建/升级会员
          • 4.4.6.2.2 会员详情查询
          • 4.4.6.2.3 修改会员详情
          • 4.4.6.2.4 创建顾客
          • 4.4.6.2.5 查询会员实体卡列表
          • 4.4.6.2.6 查询品牌下会员等级
          • 4.4.6.2.7 修改会员等级信息
        • 4.4.6.3 会员登录
          • 4.4.6.3.1 会员登录
          • 4.4.6.3.2 会员登录二维码
          • 4.4.6.3.3 获取免登录token
        • 4.4.6.4 会员充值
          • 4.4.6.4.1 会员充值/消费记录查询
          • 4.4.6.4.2 会员充值接口
          • 4.4.6.4.3 查询门店储值消费金额
        • 4.4.6.5 积分
          • 4.4.6.5.1 会员积分增加
          • 4.4.6.5.2 会员积分扣减
        • 4.4.6.6 优惠券
          • 4.4.6.6.1 查询优惠券列表
          • 4.4.6.6.2 查询优惠券详情
          • 4.4.6.6.3 查询券模板列表
          • 4.4.6.6.4 券模板发券接口
          • 4.4.6.6.5 查询门店营销规则
          • 4.4.6.6.6 优惠券核销通知接口
          • 4.4.6.6.7 客如云券核销
      • 4.4.7 会员2.0
        • 4.4.7.1 API列表
        • 4.4.7.2 会员创建
        • 4.4.7.3 会员查询
        • 4.4.7.4 会员资产查询
        • 4.4.7.5 储值充值接口
      • 4.4.8 第三方券核销
        • 4.4.8.1 第三方券核销场景与流程介绍
        • 4.4.8.2 API列表
        • 4.4.8.3 券查询
        • 4.4.8.4 券核销
        • 4.4.8.5 券反核销
      • 4.4.9 供应链1.0
        • 4.4.9.1 API列表
        • 4.4.9.2 供应链基础数据
          • 4.4.9.2.1 查询商品库存
          • 4.4.9.2.2 获取交易凭证
          • 4.4.9.2.3 查询供应链物品库存
          • 4.4.9.2.4 查询商户余额
          • 4.4.9.2.5 查询仓库列表
          • 4.4.9.2.6 查询供应商类别
          • 4.4.9.2.7 查询物品分类
          • 4.4.9.2.8 查询供应商列表
          • 4.4.9.2.9 查询供应链物品接口
          • 4.4.9.2.10 查询交易记录
          • 4.4.9.2.11 接收商品库存变更
        • 4.4.9.3 采购单据
          • 4.4.9.3.1 查询采购入库单列表
          • 4.4.9.3.2 查询采购入库单明细
          • 4.4.9.3.3 查询采购退货单明细
          • 4.4.9.3.4 查询采购订单
          • 4.4.9.3.5 采购退货单列表
        • 4.4.9.4 销售单据
          • 4.4.9.4.1 查询非销售单出库明细
        • 4.4.9.5 库存单据
          • 4.4.9.5.1 入库分页查询
          • 4.4.9.5.2 出库分页查询
          • 4.4.9.5.3 入库详情查询
          • 4.4.9.5.4 出库详情查询
          • 4.4.9.5.5 调拨单分页查询
          • 4.4.9.5.6 盘点单分页查询
          • 4.4.9.5.7 调拨单详情查询
          • 4.4.9.5.8 退回单分页查询
          • 4.4.9.5.9 盘点单详情查询
          • 4.4.9.5.10 退回单详情查询
          • 4.4.9.5.11 入库单保存
          • 4.4.9.5.12 出库单保存
          • 4.4.9.5.13 收货单分页查询
          • 4.4.9.5.14 报废单分页查询
          • 4.4.9.5.15 收货单详情
          • 4.4.9.5.16 报废单详情查询
          • 4.4.9.5.17 配送签收单分页查询
          • 4.4.9.5.18 退回入库单分页查询
          • 4.4.9.5.19 配送签收单修改保存
          • 4.4.9.5.20 查询配送签收单详情
          • 4.4.9.5.21 退回入库单详情查询
      • 4.4.10 供应链2.0
        • 4.4.10.1 API列表
        • 4.4.10.2 报损出库
          • 4.4.10.2.1 报损出库单详情
          • 4.4.10.2.2 报损出库单列表
        • 4.4.10.3 其他出库查询
          • 4.4.10.3.1 其他出库单详情
          • 4.4.10.3.2 其他出库单列表
        • 4.4.10.4 其他入库查询
          • 4.4.10.4.1 其他入库单列表
        • 4.4.10.5 组件内仓库间调拨
          • 4.4.10.5.1 组织内调拨订单详情
          • 4.4.10.5.2 组织内调拨订单列表
        • 4.4.10.6 盘点
          • 4.4.10.6.1 盘点单详情
          • 4.4.10.6.2 盘点单列表
        • 4.4.10.7 店间调拨出库
          • 4.4.10.7.1 店间调拨出库单列表
          • 4.4.10.7.2 店间调拨出库单详情
        • 4.4.10.8 店间调拨入库
          • 4.4.10.8.1 店间调拨入库单详情
          • 4.4.10.8.2 店间调拨入库单列表
        • 4.4.10.9 pos核减
          • 4.4.10.9.1 消耗出库单详情
          • 4.4.10.9.2 消耗出库单列表
        • 4.4.10.10 其他出库（接收）
          • 4.4.10.10.1 其他出库（接收）
        • 4.4.10.11 其他入库（接收）
          • 4.4.10.11.1 其他入库（接收）
        • 4.4.10.12 接收采购数据
          • 4.4.10.12.1 采购入库（接收）
          • 4.4.10.12.2 采购退货出库（接收）
        • 4.4.10.13 库存查询
          • 4.4.10.13.1 库存查询
        • 4.4.10.14 请购单
          • 4.4.10.14.1 请购单详情查询
          • 4.4.10.14.2 请购单列表
        • 4.4.10.15 配送订单2.0
          • 4.4.10.15.1 配送订单详情
          • 4.4.10.15.2 配送订单列表
        • 4.4.10.16 销售订单查询
          • 4.4.10.16.1 销售订单详情
          • 4.4.10.16.2 销售订单列表
        • 4.4.10.17 向总部退货
          • 4.4.10.17.1 向总部退货单列表
          • 4.4.10.17.2 向总部退货单详情
        • 4.4.10.18 采购退货出库
          • 4.4.10.18.1 采购退货单列表
          • 4.4.10.18.2 采购退货单详情
        • 4.4.10.19 采购入库
          • 4.4.10.19.1 采购入库单列表
          • 4.4.10.19.2 采购入库单详情
        • 4.4.10.20 配送验收入库
          • 4.4.10.20.1 配送验收入库单列表
          • 4.4.10.20.2 配送验收入库单详情
        • 4.4.10.21 配送出库
          • 4.4.10.21.1 查询配送出库单详情
          • 4.4.10.21.2 配送出库单列表
        • 4.4.10.22 配送差异单
          • 4.4.10.22.1 配送差异单列表
          • 4.4.10.22.2 配送差异单详情
        • 4.4.10.23 凭证对接
          • 4.4.10.23.1 财务集成推送消息回调
          • 4.4.10.23.2 推送财务集成的凭证信息
      • 4.4.11 支付收银服务
        • 4.4.11.1 API列表
        • 4.4.11.2 支付状态查询
        • 4.4.11.3 扫码支付（主扫）
        • 4.4.11.4 扫码支付（被扫）
        • 4.4.11.5 退款状态查询
        • 4.4.11.6 退款申请
      • 4.4.12 OAUTH授权服务
        • 4.4.12.1 API列表
        • 4.4.12.2 获取用户信息
        • 4.4.12.3 登录成功回调
        • 4.4.12.4 获取授权码code
        • 4.4.12.5 获取token
  • 5 智享版
    • 5.1 接口申请与授权流程（智享版）
    • 5.2 解决方案
      • 5.2.1 扫码点餐下单解决方案
      • 5.2.2 三方优惠券解决方案
      • 5.2.3 三方预订解决方案
      • 5.2.4 三方数据中台解决方案
      • 5.2.5 客如云对接三方CRM解决方案
    • 5.3 API文档
      • 5.3.1 总部基础信息
        • 5.3.1.1 查询品牌信息
      • 5.3.2 门店基础信息
        • 5.3.2.1 根据品牌查询门店列表
        • 5.3.2.2 门店基础信息API列表
        • 5.3.2.3 根据门店id获取门店详情
        • 5.3.2.4 获取门店桌台列表
        • 5.3.2.5 根据桌台ID获取桌台信息
        • 5.3.2.6 查询门店服务费列表
        • 5.3.2.7 根据服务费ID获取服务费详情
        • 5.3.2.8 查询超管
        • 5.3.2.9 查询合约详情
        • 5.3.2.10 合约激活通知
      • 5.3.3 组织与员工
        • 5.3.3.1 门店档案
          • 5.3.3.1.1 门店档案API列表
          • 5.3.3.1.2 查询机构树
          • 5.3.3.1.3 查询门店信息(含三方机构ID)
          • 5.3.3.1.4 机构信息通知
          • 5.3.3.1.5 修改门店基本信息
          • 5.3.3.1.6 三方自定义机构ID变更事件
        • 5.3.3.2 总部员工管理
          • 5.3.3.2.1 总部员工管理API列表
          • 5.3.3.2.2 总部-创建员工
          • 5.3.3.2.3 总部-启用员工
          • 5.3.3.2.4 总部-修改员工信息
          • 5.3.3.2.5 总部-查询员工详情
          • 5.3.3.2.6 总部-停用员工
          • 5.3.3.2.7 总部-查询员工列表
          • 5.3.3.2.8 员工信息变更通知
        • 5.3.3.3 门店员工管理
          • 5.3.3.3.1 门店员工管理API列表
          • 5.3.3.3.2 门店-创建员工
          • 5.3.3.3.3 门店-修改员工信息
          • 5.3.3.3.4 门店-停用员工
          • 5.3.3.3.5 门店-查询员工详情
          • 5.3.3.3.6 门店-启用员工
          • 5.3.3.3.7 门店-查询员工列表
      • 5.3.4 菜品
        • 5.3.4.1 门店菜品信息分页查询
        • 5.3.4.2 门店菜品详情查询
        • 5.3.4.3 门店分类信息查询
        • 5.3.4.4 门店商品开放消息
        • 5.3.4.5 商品库存信息变更
      • 5.3.5 订单信息
        • 5.3.5.1 订单详情查询接口
        • 5.3.5.2 订单列表查询接口
        • 5.3.5.3 订单补打通知
        • 5.3.5.4 订单变更事件同步
      • 5.3.6 预订
        • 5.3.6.1 预订单下单
        • 5.3.6.2 获取预订营业日信息
        • 5.3.6.3 查询预订单详情
        • 5.3.6.4 查询桌台信息与预订单聚合信息
        • 5.3.6.5 预订到店
        • 5.3.6.6 取消预订
        • 5.3.6.7 预订单状态事件通知
        • 5.3.6.8 预订单关联的交易单的状态通知
      • 5.3.7 会员
        • 5.3.7.1 会员API列表
        • 5.3.7.2 会员创建
        • 5.3.7.3 修改会员信息
        • 5.3.7.4 批量查询会员详情
        • 5.3.7.5 会员资产查询
        • 5.3.7.6 会员查询
        • 5.3.7.7 储值充值接口
        • 5.3.7.8 积分
          • 5.3.7.8.1 增加积分
          • 5.3.7.8.2 扣减积分
          • 5.3.7.8.3 查询积分规则
        • 5.3.7.9 优惠券
          • 5.3.7.9.1 券模板
            • 5.3.7.9.1.1 查询券模版详情
            • 5.3.7.9.1.2 查询券模版列表
            • 5.3.7.9.1.3 券模板变更事件通知
            • 5.3.7.9.1.4 查询券模版适用门店
            • 5.3.7.9.1.5 查询券模版适用商品
          • 5.3.7.9.2 券实例
            • 5.3.7.9.2.1 作废优惠券
            • 5.3.7.9.2.2 发送优惠券
            • 5.3.7.9.2.3 查询券实例详情
            • 5.3.7.9.2.4 查询券实例列表
      • 5.3.8 三方券
        • 5.3.8.1 查询券
        • 5.3.8.2 核销券
        • 5.3.8.3 反核销券
      • 5.3.9 三方会员
        • 5.3.9.1 会员查询
          • 5.3.9.1.1 会员及资产查询
        • 5.3.9.2 会员资产支付
          • 5.3.9.2.1 会员资产核销
          • 5.3.9.2.2 会员资产反核销
          • 5.3.9.2.3 查询核销结果
      • 5.3.10 供应链2.0
        • 5.3.10.1 报损出库查询
          • 5.3.10.1.1 报损出库单列表
          • 5.3.10.1.2 报损出库单详情
        • 5.3.10.2 其他出入库查询
          • 5.3.10.2.1 其他入库单列表
          • 5.3.10.2.2 其他入库单详情
          • 5.3.10.2.3 其他出库单详情
          • 5.3.10.2.4 其他出库单列表
        • 5.3.10.3 组织内调拨查询
          • 5.3.10.3.1 组织内调拨订单列表
          • 5.3.10.3.2 组织内调拨订单详情
        • 5.3.10.4 盘盈亏查询
          • 5.3.10.4.1 盘点单列表
          • 5.3.10.4.2 盘点单详情
        • 5.3.10.5 组织间调拨查询
          • 5.3.10.5.1 组织间调拨出库单详情
          • 5.3.10.5.2 组织间调拨入库单列表
          • 5.3.10.5.3 组织间调拨出库单列表
          • 5.3.10.5.4 组织间调拨入库单详情
        • 5.3.10.6 POS核减查询
          • 5.3.10.6.1 消耗出库单详情
          • 5.3.10.6.2 消耗出库单列表
        • 5.3.10.7 接收其他出入库数据
          • 5.3.10.7.1 其他入库（接收）
          • 5.3.10.7.2 其他出库（接收）
        • 5.3.10.8 接收采购数据
          • 5.3.10.8.1 采购入库（接收）
          • 5.3.10.8.2 采购退货出库（接收）
        • 5.3.10.9 库存查询
          • 5.3.10.9.1 库存查询
        • 5.3.10.10 基础信息
          • 5.3.10.10.1 新增或修改物品分类
          • 5.3.10.10.2 删除物品分类
          • 5.3.10.10.3 查询组织机构信息
          • 5.3.10.10.4 新增物品档案
          • 5.3.10.10.5 修改物品档案
          • 5.3.10.10.6 删除物品档案
        • 5.3.10.11 采购入库
          • 5.3.10.11.1 采购入库单列表
          • 5.3.10.11.2 采购入库单详情
        • 5.3.10.12 采购退货
          • 5.3.10.12.1 采购退货单列表
          • 5.3.10.12.2 采购退货单详情
        • 5.3.10.13 查询物品信息
          • 5.3.10.13.1 物品详情
          • 5.3.10.13.2 物品列表
        • 5.3.10.14 退菜入库查询信息
          • 5.3.10.14.1 退菜入库列表查询
          • 5.3.10.14.2 退菜入库详情查询
        • 5.3.10.15 销售订单查询
          • 5.3.10.15.1 销售订单列表
          • 5.3.10.15.2 销售订单详情
        • 5.3.10.16 配送验收入库查询
          • 5.3.10.16.1 配送验收入库单详情
          • 5.3.10.16.2 配送验收入库单列表
        • 5.3.10.17 配送退货查询
          • 5.3.10.17.1 向总部退货单详情
          • 5.3.10.17.2 向总部退货单列表
        • 5.3.10.18 库存报表
          • 5.3.10.18.1 进销存明细列表
          • 5.3.10.18.2 门店毛利分析列表
          • 5.3.10.18.3 商品毛利分析列表
        • 5.3.10.19 接收销售发货数据
          • 5.3.10.19.1 销售发货单写入
      • 5.3.11 数据报表
        • 5.3.11.1 数据报表API列表
        • 5.3.11.2 数据报表枚举
        • 5.3.11.3 营业报表
          • 5.3.11.3.1 优惠构成统计
          • 5.3.11.3.2 店内营收统计
          • 5.3.11.3.3 收入优惠统计
          • 5.3.11.3.4 收入构成统计
        • 5.3.11.4 收款对账
          • 5.3.11.4.1 营业收款统计
          • 5.3.11.4.2 支付方式收款统计
          • 5.3.11.4.3 支付结算统计
        • 5.3.11.5 菜品报表
          • 5.3.11.5.1 销售品项统计
          • 5.3.11.5.2 菜品销售统计
          • 5.3.11.5.3 菜品分类营收统计
          • 5.3.11.5.4 服务费统计
          • 5.3.11.5.5 套餐销售统计
        • 5.3.11.6 会员报表
          • 5.3.11.6.1 会员储值金额变动统计
      • 5.3.12 系统集成
        • 5.3.12.1 oauth免登
          • 5.3.12.1.1 获取accessToken
          • 5.3.12.1.2 刷新accessToken
          • 5.3.12.1.3 获取用户信息
        • 5.3.12.2 商户授权
          • 5.3.12.2.1 应用已授权机构查询
          • 5.3.12.2.2 获取授权二维码
  • 6 服务市场入驻
    • 6.1 不调用API接口，直接把服务上架到服务市场
    • 6.2 服务市场事件通知
  • 7 公告中心
    • 7.1 【公告】开放平台服务协议更新公告

会员资产核销

核销会员资产，如储值余额、优惠券、积分等

授权方式: 品牌授权

请求描述

HTTP请求方式：POST
HTTP请求头类型：Content-Type=application/json
URI: 第三方提供

请求参数

1. 公共参数

详情可查看【公共说明】中的公共参数模块

业务参数

参数名 类型 是否必填 参数描述
bizId String 是
业务id（幂等、唯一性校验使用）
kryTransOrderNo String 是
客如云交易订单号 描述：关联使用
kryPaymentNo String 是
客如云支付订单号
kryMemberId String 否
客如云会员id
thirdMemberId String 否
接入方会员id
mobile String 否
会员手机号
memberAssetsVerificationList Array 是
资产核销列表
paymentToken String 否
支付口令
requestId String 是
请求id(串联系统流程使用)
kryBrandId String 是
客如云品牌id
kryShopId String 是
客如云门店id
operatorId String 是
操作人id
operatorName String 是
操作人名称
callInterface String 否
callMethod String 否
kryDeviceId String 否
paymentTokenType String 否
支付口令类型 PHYSICAL_CHIP_CARD_NO: 芯片号、 PAYMENT_TOKEN: 支付口令

业务示例（JSON）

{
    "bizId": "20250001",
    "kryTransOrderNo": "2025121000001",
    "kryPaymentNo": "1113434444443211",
    "kryMemberId": "1001",
    "thirdMemberId": "1001",
    "mobile": "150****1111",
    "memberAssetsVerificationList": [
        {
            "assetMappingId": "100001",
            "assetId": "100001",
            "verifyAmount": 1000,
            "verifyCnt": 0
        }
    ],
    "paymentToken": "11100001",
    "requestId": "1vnfjvaa-111",
    "kryBrandId": "11342",
    "kryShopId": "8066287",
    "operatorId": "1543",
    "operatorName": "张三",
    "paymentTokenType": "PAYMENT_TOKEN"
}

响应参数

参数名 类型 是否必填 参数描述
code Integer 是
返回编码(0:成功, 3000:系统异常,3001:请求超时)
message String 否
异常信息
messageUuid String 否
traceId
result Object 否
响应数据，code !=0的情况下不返回业务参数

响应示例（JSON）

{
    "code": 0,
    "message": "OK",
    "messageUuid": "OK",
    "result": {
        "data": {
            "kryBrandId": "11342",
            "kryShopId": "8066287",
            "kryTransOrderNo": "20250000001",
            "kryPaymentNo": "20250110000001",
            "flowId": "1114423111",
            "memberId": "1001",
            "memberName": "张三",
            "verifyAssetsDetailList": [
                {
                    "assetMappingId": "100001",
                    "assetId": "100001",
                    "kryBrandId": "11342",
                    "verifyTotalAmount": 1000,
                    "verifyRealAmount": 1000,
                    "verifyGiftAmount": 0,
                    "platformDiscountAmount": 0,
                    "platformCommissionAmount": 0,
                    "status": "SUCCESS",
                    "errorDescription": "核销成功",
                    "errCode": "FAIL"
                }
            ],
            "errorDescription": "全部核销成功"
        },
        "subCode": "000",
        "subMsg": "成功",
        "success": true
    }
}
目录