客如云开放平台

开发者平台
>
餐饮文档中心

API开发文档

1 快速入驻
- 1.1 企业认证
  - 1.1.1 服务商认证
  - 1.1.2 品牌商认证
- 1.2 对接流程
2 开发必读
- 2.1 公共参数说明
- 2.2 机构授权
3 解决方案
- 3.1 快餐场景小程序解决方案
- 3.2 外卖场景小程序解决方案
- 3.3 智能终端
4 开放能力
- 4.1 组织与员工
  - 4.1.1 门店基础信息
    - 4.1.1.1 门店档案
      - 4.1.1.1.1 查询门店信息(含三方机构ID)
      - 4.1.1.1.2 修改门店基本信息
      - 4.1.1.1.3 查询机构树
      - 4.1.1.1.4 三方自定义机构ID变更事件
      - 4.1.1.1.5 机构信息通知
  - 4.1.2 总部基础信息
    - 4.1.2.1 总部基础信息枚举
    - 4.1.2.2 查询品牌信息
    - 4.1.2.3 查询超管
  - 4.1.3 门店员工管理
    - 4.1.3.1 门店-创建员工
    - 4.1.3.2 门店-修改员工信息
    - 4.1.3.3 门店-启用员工
    - 4.1.3.4 门店-停用员工
    - 4.1.3.5 门店-查询员工详情
    - 4.1.3.6 门店-查询员工列表
  - 4.1.4 总部员工管理
    - 4.1.4.1 总部-创建员工
    - 4.1.4.2 总部-修改员工信息
    - 4.1.4.3 总部-启用员工
    - 4.1.4.4 总部-停用员工
    - 4.1.4.5 总部-查询员工详情
    - 4.1.4.6 总部-查询员工列表
- 4.2 商品
  - 4.2.1 门店商品
    - 4.2.1.1 商品分类列表查询
    - 4.2.1.2 门店菜品分页查询
    - 4.2.1.3 门店查询菜品详情
    - 4.2.1.4 查询菜品库存
    - 4.2.1.5 商品批量改价
    - 4.2.1.6 门店商品开放消息
    - 4.2.1.7 商品库存信息变更
  - 4.2.2 品牌商品
    - 4.2.2.1 品牌分页查询菜品基本信息
    - 4.2.2.2 品牌查询菜品详情
    - 4.2.2.3 品牌查询分类信息
    - 4.2.2.4 品牌菜品变更
- 4.3 ToC外卖下单
  - 4.3.1 交易订单详情查询
  - 4.3.2 交易订单变更事件
- 4.4 ToC快餐下单
  - 4.4.1 交易订单详情查询
  - 4.4.2 交易订单变更事件
- 4.5 ToC正餐点餐
  - 4.5.1 查询桌台状态
  - 4.5.2 开台
  - 4.5.3 正餐加购并下单
  - 4.5.4 查询正餐订单详情
  - 4.5.5 保存支付记录(记账)
  - 4.5.6 业务异常补偿
    - 4.5.6.1 请求超时场景降级查询请求执行结果
- 4.6 ToC正餐预订
  - 4.6.1 C端预订下单
  - 4.6.2 C端预订单详情查询
  - 4.6.3 C端预订单分页查询
  - 4.6.4 取消C端预订
- 4.7 ToC排菜预点
  - 4.7.1 创建/修改开放排菜单
  - 4.7.2 查询排菜单
  - 4.7.3 删除排菜单
  - 4.7.4 预点单操作事件
- 4.8 客如云CRM
  - 4.8.1 会员信息
    - 4.8.1.1 会员创建
    - 4.8.1.2 查询会员卡方案等级规则
    - 4.8.1.3 查询会员标签列表
    - 4.8.1.4 会员查询
    - 4.8.1.5 修改会员信息
    - 4.8.1.6 批量查询会员卡信息
    - 4.8.1.7 会员资产查询
  - 4.8.2 优惠券
    - 4.8.2.1 券模板
      - 4.8.2.1.1 分页查询券模版列表
      - 4.8.2.1.2 查询券模版
      - 4.8.2.1.3 分页查询券模版适用商品
      - 4.8.2.1.4 分页查询券模版适用门店
      - 4.8.2.1.5 券模板变更消息
    - 4.8.2.2 券实例
      - 4.8.2.2.1 发送优惠券
      - 4.8.2.2.2 作废优惠券
      - 4.8.2.2.3 查询券详情
      - 4.8.2.2.4 查询券实例
  - 4.8.3 储值
    - 4.8.3.1 会员储值扣减
    - 4.8.3.2 会员储值扣减退款
    - 4.8.3.3 查询门店储值消费金额
    - 4.8.3.4 储值充值接口
    - 4.8.3.5 查询储值变动明细列表
  - 4.8.4 积分
    - 4.8.4.1 增加积分
    - 4.8.4.2 扣减积分
    - 4.8.4.3 查询积分规则
    - 4.8.4.4 会员查询积分流水
- 4.9 三方会员
  - 4.9.1 会员及资产查询
  - 4.9.2 会员资产核销
  - 4.9.3 会员资产反核销
  - 4.9.4 查询核销结果
- 4.10 三方不记名券
  - 4.10.1 验券准备查询券
  - 4.10.2 执行券核销
  - 4.10.3 执行反核销券
- 4.11 年费制合约
  - 4.11.1 查询合约详情
  - 4.11.2 合约激活事件通知
  - 4.11.3 分配合约事件通知
- 4.12 供应链2.0
  - 4.12.1 机构收款人查询接口
  - 4.12.2 分账供应商
    - 4.12.2.1 供应商创建接口
    - 4.12.2.2 查询供应商列表
    - 4.12.2.3 查询供应商类别
    - 4.12.2.4 供应商主收款人查询接口
  - 4.12.3 供应链分账支付(新)
    - 4.12.3.1 供应链可用余额查询(新)
    - 4.12.3.2 供应链分账支付接口（新）
    - 4.12.3.3 供应链分账交易结果查询接口(新)
    - 4.12.3.4 供应链分账退款接口（新）
    - 4.12.3.5 供应商提现接口
    - 4.12.3.6 供应商提现结果查询
    - 4.12.3.7 供应商流水查询接口
  - 4.12.4 请购单
    - 4.12.4.1 销售计划-获取计划销量
    - 4.12.4.2 销售计划-营业额预估
    - 4.12.4.3 千元用量-计算预估订货量
    - 4.12.4.4 千元用量-营业额预估
    - 4.12.4.5 销售计划-计算预估订货量
    - 4.12.4.6 销售计划-获取商品分类
    - 4.12.4.7 销售计划-分页获取商品
- 4.13 数据报表
  - 4.13.1 报表订单信息(统计分析链路)
    - 4.13.1.1 订单详情查询接口
    - 4.13.1.2 订单列表查询接口
  - 4.13.2 营业报表
    - 4.13.2.1 店内营收统计
    - 4.13.2.2 优惠构成统计
    - 4.13.2.3 收入构成统计
    - 4.13.2.4 收入优惠统计
    - 4.13.2.5 服务费统计
    - 4.13.2.6 收入优惠统计自定义报表
  - 4.13.3 收款对账
    - 4.13.3.1 营业收款统计
    - 4.13.3.2 支付结算统计
    - 4.13.3.3 支付方式收款统计
    - 4.13.3.4 套餐销售统计
  - 4.13.4 菜品报表
    - 4.13.4.1 菜品销售统计
    - 4.13.4.2 菜品分类营收统计
    - 4.13.4.3 销售品项统计
  - 4.13.5 会员报表
    - 4.13.5.1 会员储值金额变动统计
    - 4.13.5.2 查询储值明细
  - 4.13.6 财务报表
    - 4.13.6.1 储值店间结算表
    - 4.13.6.2 查询营业数据-营业指标汇总
    - 4.13.6.3 营业数据-差异明细
    - 4.13.6.4 菜品数据-汇总指标
    - 4.13.6.5 菜品数据-差异明细
    - 4.13.6.6 收款数据-汇总指标
    - 4.13.6.7 收款数据-差异明细
    - 4.13.6.8 收款数据-按支付方式构成
- 4.14 系统集成
  - 4.14.1 oauth免登
    - 4.14.1.1 oauth免登介绍
    - 4.14.1.2 获取免登accessToken
    - 4.14.1.3 根据accessToken获取用户信息
    - 4.14.1.4 根据refreshToken刷新token
  - 4.14.2 商户授权
    - 4.14.2.1 获取授权二维码
    - 4.14.2.2 应用已授权机构查询
5 智能终端开放能力
- 5.1 智能终端对接指南(必读)
- 5.2 pos信息
  - 5.2.1 查询主pos信息
- 5.3 设备管理
  - 5.3.1 设备绑定
  - 5.3.2 通过SN解绑
  - 5.3.3 通过设备ID解绑
  - 5.3.4 通过sn查询设备
  - 5.3.5 本地局域网模式(Wifi)
    - 5.3.5.1 通过SN查找设备
- 5.4 后厨送餐
  - 5.4.1 本地局域网模式(Wifi)
    - 5.4.1.1 根据取餐码查询订单
    - 5.4.1.2 开始送餐
    - 5.4.1.3 结束送餐
  - 5.4.2 云端调用模式(4G)
    - 5.4.2.1 根据取餐码查询订单
    - 5.4.2.2 开始送餐
    - 5.4.2.3 结束送餐
- 5.5 ToB正餐点餐
  - 5.5.1 获取所有桌台状态&状态数量
  - 5.5.2 查询简化菜单目录
  - 5.5.3 正餐开台
  - 5.5.4 正快餐下单
  - 5.5.5 查询购物车
  - 5.5.6 批量修改已下单商品数量
  - 5.5.7 划菜
  - 5.5.8 催菜
  - 5.5.9 票据补打
- 5.6 ToB正餐预订
  - 5.6.1 查询桌台信息与预订单聚合信息
  - 5.6.2 预订单保存接口
  - 5.6.3 预订到店
  - 5.6.4 预订到店
  - 5.6.5 取消预订
  - 5.6.6 预订单详情查询
  - 5.6.7 保存订金
  - 5.6.8 查询桌台信息与预订单聚合信息
  - 5.6.9 获取预订营业日信息
  - 5.6.10 取消预订
- 5.7 ToB排队预点
  - 5.7.1 本地局域网模式(Wifi)
    - 5.7.1.1 预点单删除

平台简介

客如云开放平台通过连接"人财物客"、餐饮、零售等上下游资源，提供外卖、会员、供应链等多种服务，为餐饮、零售品牌商户提供更加便捷的操作平台、数据分析能力、数据整合能力，从而促使商家轻松获客、高效管理门店，提升经营效率、降低经营成本。

平台简介

openAPI+服务市场模型

调试工具