客如云开放平台

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

API开发文档

1 开发指南
2 平台介绍及入驻指南
- 2.1 平台简介
- 2.2 认证指南
  - 2.2.1 服务商认证
  - 2.2.2 品牌商认证
- 2.3 对接流程
  - 2.3.1 API接口对接流程（不上架服务市场）
  - 2.3.2 API接口对接流程（上架服务市场）
3 公共说明
- 3.1 https对接说明
- 3.2 请求公共参数
- 3.3 获取门店token
- 3.4 签名规则
- 3.5 调试工具
  - 3.5.1 2.0签名生成工具
- 3.6 响应参数
- 3.7 附录
  - 3.7.1 订单状态
  - 3.7.2 错误码
  - 3.7.3 订单取消原因表
  - 3.7.4 订单支付状态表
  - 3.7.5 订单配送状态
  - 3.7.6 回调接口编码
  - 3.7.7 支付机构代码
4 智享版
- 4.1 总部基础信息
  - 4.1.1 总部基础信息枚举
  - 4.1.2 查询品牌信息
  - 4.1.3 查询超管
- 4.2 CRM
  - 4.2.1 会员信息
    - 4.2.1.1 会员创建
  - 4.2.2 优惠券
    - 4.2.2.1 券模板
      - 4.2.2.1.1 分页查询券模版列表
      - 4.2.2.1.2 查询券模版
      - 4.2.2.1.3 分页查询券模版适用商品
      - 4.2.2.1.4 分页查询券模版适用门店
      - 4.2.2.1.5 券模板【失效】【删除】消息
    - 4.2.2.2 券实例
      - 4.2.2.2.1 发送优惠券
      - 4.2.2.2.2 作废优惠券
      - 4.2.2.2.3 获取会员优惠券详情：查询券详情
      - 4.2.2.2.4 获取会员优惠券列表：查询券实例
  - 4.2.3 储值
    - 4.2.3.1 储值充值
      - 4.2.3.1.1 储值充值接口
    - 4.2.3.2 储值核销
      - 4.2.3.2.1 查询门店储值消费金额
- 4.3 供应链2.0
  - 4.3.1 供应商创建接口
  - 4.3.2 供应商主收款人查询接口
  - 4.3.3 供应商提现接口
  - 4.3.4 供应商提现结果查询
  - 4.3.5 供应链可用余额查询
  - 4.3.6 供应链分账退款接口
  - 4.3.7 供应链分账支付接口
  - 4.3.8 供应链分账交易结果查询接口
  - 4.3.9 供应商流水查询接口
- 4.4 三方会员
  - 4.4.1 会员及资产查询
  - 4.4.2 会员资产核销
  - 4.4.3 会员资产反核销
  - 4.4.4 查询核销结果
- 4.5 三方券
  - 4.5.1 验券准备查询券
  - 4.5.2 执行券核销
  - 4.5.3 执行反核销券
- 4.6 组织与员工
  - 4.6.1 门店档案
    - 4.6.1.1 查询门店信息(含三方机构ID)
    - 4.6.1.2 修改门店基本信息
    - 4.6.1.3 查询机构树
    - 4.6.1.4 三方自定义机构ID变更事件
    - 4.6.1.5 机构信息通知
  - 4.6.2 机构合约
    - 4.6.2.1 查询合约详情
    - 4.6.2.2 分配合约事件通知
    - 4.6.2.3 合约激活事件通知
  - 4.6.3 总部员工管理
    - 4.6.3.1 总部-创建员工
    - 4.6.3.2 总部-修改员工信息
    - 4.6.3.3 总部-启用员工
    - 4.6.3.4 总部-停用员工
    - 4.6.3.5 总部-查询员工详情
    - 4.6.3.6 总部-查询员工列表
  - 4.6.4 门店员工管理
    - 4.6.4.1 门店-创建员工
    - 4.6.4.2 门店-修改员工信息
    - 4.6.4.3 门店-启用员工
    - 4.6.4.4 门店-停用员工
    - 4.6.4.5 门店-查询员工详情
    - 4.6.4.6 门店-查询员工列表
- 4.7 离线点餐
  - 4.7.1 连接POS SDK说明文档
  - 4.7.2 pos信息
    - 4.7.2.1 查询主pos信息
  - 4.7.3 设备管理
    - 4.7.3.1 设备绑定
    - 4.7.3.2 通过SN解绑
    - 4.7.3.3 通过设备ID解绑
- 4.8 数据报表
  - 4.8.1 营业报表
    - 4.8.1.1 店内营收统计
    - 4.8.1.2 优惠构成统计
    - 4.8.1.3 收入构成统计
    - 4.8.1.4 收入优惠统计
  - 4.8.2 收款对账
    - 4.8.2.1 营业收款统计
    - 4.8.2.2 支付结算统计
    - 4.8.2.3 支付方式收款统计
  - 4.8.3 菜品报表
    - 4.8.3.1 菜品销售统计
    - 4.8.3.2 菜品分类营收统计
    - 4.8.3.3 销售品项统计
  - 4.8.4 会员报表
    - 4.8.4.1 会员储值金额变动统计
- 4.9 系统集成
  - 4.9.1 oauth免登
    - 4.9.1.1 oauth免登介绍
    - 4.9.1.2 获取免登accessToken
    - 4.9.1.3 根据accessToken获取用户信息
    - 4.9.1.4 根据refreshToken刷新token
  - 4.9.2 商户授权
    - 4.9.2.1 获取授权二维码
    - 4.9.2.2 应用已授权机构查询
5 OnPos版
- 5.1 接口能力大图
- 5.2 接口列表
  - 5.2.1 门店信息
    - 5.2.1.1 获取门店列表
    - 5.2.1.2 获取门店信息
    - 5.2.1.3 查询桌台信息
    - 5.2.1.4 获取门店经营时间
    - 5.2.1.5 获取服务下可用门店
    - 5.2.1.6 查询门店营业状态
    - 5.2.1.7 修改门店营业状态
    - 5.2.1.8 支付类型查询
    - 5.2.1.9 附加费配置查询接口
    - 5.2.1.10 门店设备列表查询接口
    - 5.2.1.11 门店设备状态推送接口
  - 5.2.2 菜品
    - 5.2.2.1 菜品分类信息查询
    - 5.2.2.2 菜品父级信息查询
    - 5.2.2.3 菜品分页查询
    - 5.2.2.4 菜品精确查询
    - 5.2.2.5 菜品分类查询
    - 5.2.2.6 接收菜品变更通知
    - 5.2.2.7 接收菜品分类变更通知
    - 5.2.2.8 批量修改门店菜品售卖数量
  - 5.2.3 订单信息
    - 5.2.3.1 查询订单详情
    - 5.2.3.2 订单状态推送通知
  - 5.2.4 外卖
    - 5.2.4.1 场景流程与介绍
    - 5.2.4.2 外卖下单服务
      - 5.2.4.2.1 外卖下单
      - 5.2.4.2.2 订单状态查询
      - 5.2.4.2.3 客如云接收订单通知
      - 5.2.4.2.4 客如云拒绝订单通知
      - 5.2.4.2.5 合作方取消订单
      - 5.2.4.2.6 客如云推送配送状态
      - 5.2.4.2.7 合作方推送配送状态通知
      - 5.2.4.2.8 合作方申请退款
      - 5.2.4.2.9 商家同意退款通知
      - 5.2.4.2.10 商家拒绝退款通知
      - 5.2.4.2.11 合作方退款成功通知
      - 5.2.4.2.12 商户作废订单通知
      - 5.2.4.2.13 客如云退货通知
  - 5.2.5 后厨管理服务
  - 5.2.6 配送服务
    - 5.2.6.1 客如云下发配送通知
    - 5.2.6.2 订单配送状态通知
    - 5.2.6.3 商家自配送状态推送
  - 5.2.7 会员
    - 5.2.7.1 会员基本信息
      - 5.2.7.1.1 创建顾客
      - 5.2.7.1.2 创建/升级会员
      - 5.2.7.1.3 会员详情查询
      - 5.2.7.1.4 修改会员详情
      - 5.2.7.1.5 查询会员实体卡列表
      - 5.2.7.1.6 查询品牌下会员等级
      - 5.2.7.1.7 修改会员等级信息
    - 5.2.7.2 会员登录
      - 5.2.7.2.1 会员登录
      - 5.2.7.2.2 获取免登录token
      - 5.2.7.2.3 会员登录二维码
    - 5.2.7.3 会员充值
      - 5.2.7.3.1 会员充值/消费记录查询
      - 5.2.7.3.2 会员充值接口
      - 5.2.7.3.3 查询门店储值消费金额
  - 5.2.8 积分
    - 5.2.8.1 会员积分增加
    - 5.2.8.2 会员积分扣减
  - 5.2.9 优惠券
    - 5.2.9.1 查询优惠券列表
    - 5.2.9.2 查询优惠券详情
    - 5.2.9.3 查询券模板列表
    - 5.2.9.4 券模板发券接口
    - 5.2.9.5 客如云券核销
    - 5.2.9.6 查询门店营销规则
  - 5.2.10 第三方券核销
    - 5.2.10.1 第三方券核销场景与流程介绍
    - 5.2.10.2 券查询
    - 5.2.10.3 券核销
    - 5.2.10.4 券反核销
  - 5.2.11 供应链
    - 5.2.11.1 供应链基础数据
      - 5.2.11.1.1 获取交易凭证
      - 5.2.11.1.2 查询供应链物品库存
      - 5.2.11.1.3 查询商户余额
      - 5.2.11.1.4 查询商品库存
      - 5.2.11.1.5 查询仓库列表
      - 5.2.11.1.6 查询供应商类别
      - 5.2.11.1.7 查询供应商列表
      - 5.2.11.1.8 查询供应链物品接口
      - 5.2.11.1.9 查询物品分类
      - 5.2.11.1.10 接收商品库存变更
      - 5.2.11.1.11 查询交易记录
    - 5.2.11.2 销售单据
    - 5.2.11.3 采购单据
      - 5.2.11.3.1 查询采购入库单列表
      - 5.2.11.3.2 查询采购入库单明细
      - 5.2.11.3.3 查询采购订单
      - 5.2.11.3.4 采购退货单列表
      - 5.2.11.3.5 查询采购退货单明细
    - 5.2.11.4 库存单据
      - 5.2.11.4.1 入库分页查询
      - 5.2.11.4.2 入库详情查询
      - 5.2.11.4.3 出库分页查询
      - 5.2.11.4.4 出库详情查询
      - 5.2.11.4.5 调拨单分页查询
      - 5.2.11.4.6 调拨单详情查询
      - 5.2.11.4.7 盘点单分页查询
      - 5.2.11.4.8 盘点单详情查询
      - 5.2.11.4.9 退回单分页查询
      - 5.2.11.4.10 退回单详情查询
      - 5.2.11.4.11 出库单保存
      - 5.2.11.4.12 入库单保存
      - 5.2.11.4.13 收货单分页查询
      - 5.2.11.4.14 收货单详情
      - 5.2.11.4.15 报废单分页查询
      - 5.2.11.4.16 报废单详情查询
      - 5.2.11.4.17 配送签收单分页查询
      - 5.2.11.4.18 查询配送签收单详情
      - 5.2.11.4.19 退回入库单详情查询
      - 5.2.11.4.20 退回入库单分页查询
      - 5.2.11.4.21 配送签收单修改保存
  - 5.2.12 支付收银服务
    - 5.2.12.1 扫码支付（主扫）
    - 5.2.12.2 扫码支付（被扫）
    - 5.2.12.3 支付状态查询
    - 5.2.12.4 退款申请
    - 5.2.12.5 退款状态查询
  - 5.2.13 OAUTH授权服务
    - 5.2.13.1 获取授权码code
    - 5.2.13.2 登录成功回调
    - 5.2.13.3 获取token
    - 5.2.13.4 获取用户信息
- 5.3 常见FAQ
6 服务市场入驻
- 6.1 不调用API接口，直接把服务上架到服务市场
- 6.2 服务市场事件通知
7 开放平台公告
- 7.1 【公告】开放平台服务协议更新公告
8 更新日志

欢迎使用开发指南

客如云开放平台开发指南从平台介绍、对接流程、开发者业务对接模块等方面阐述，助你快速接入各个功能模块

平台介绍

对接流程

开发者业务对接


公共说明	通用接口	会员
签名规则	菜品	会员登录
响应参数	订单信息	会员充值
请求公共参数	门店信息	会员信息


堂食正餐	堂食快餐	外卖	供应链
正餐场景与流程介绍	快餐场景与流程介绍	外卖场景与流程介绍	库存单据
正餐订单服务	快餐订单服务	外卖订单服务	采购单据
		配送服务	销售单据

调试工具