客如云开放平台

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

API开发文档

1 平台介绍
2 如何入驻
- 2.1 入驻说明
- 2.2 品牌商入驻
- 2.3 服务商入驻
3 开发指南
- 3.1 接口调用规则（必读）
- 3.2 签名规则
- 3.3 公共请求参数
- 3.4 获取门店/品牌token
- 3.5 公共响应参数
- 3.6 平台返回状态码
  - 3.6.1 订单配送状态
  - 3.6.2 订单取消原因表
  - 3.6.3 订单支付状态表
  - 3.6.4 订单状态
  - 3.6.5 错误码
  - 3.6.6 回调接口编码
  - 3.6.7 支付机构代码
- 3.7 开发者辅助工具
  - 3.7.1 接口示例demo
  - 3.7.2 签名生成工具
  - 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 自配送介绍
    - 4.4.4.2 API列表
    - 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 获取授权码code
    - 4.4.12.4 登录成功回调
    - 4.4.12.5 获取token
5 智享版
- 5.1 接口申请与授权流程（智享版）
- 5.2 API文档
  - 5.2.1 总部基础信息
    - 5.2.1.1 查询品牌信息
  - 5.2.2 门店基础信息
    - 5.2.2.1 根据品牌查询门店列表
    - 5.2.2.2 根据门店id获取门店详情
    - 5.2.2.3 获取门店桌台列表
    - 5.2.2.4 查询门店服务费列表
    - 5.2.2.5 根据桌台ID获取桌台信息
    - 5.2.2.6 根据服务费ID获取服务费详情
    - 5.2.2.7 合约激活
    - 5.2.2.8 查询超管
  - 5.2.3 菜品
    - 5.2.3.1 门店菜品信息分页查询
    - 5.2.3.2 门店菜品详情查询
    - 5.2.3.3 门店分类信息查询
    - 5.2.3.4 商品库存信息变更
    - 5.2.3.5 门店商品开放消息
  - 5.2.4 订单信息
    - 5.2.4.1 订单详情查询接口
    - 5.2.4.2 订单列表查询接口
    - 5.2.4.3 订单变更事件同步
  - 5.2.5 预订
    - 5.2.5.1 获取预订营业日信息
    - 5.2.5.2 预订单下单
    - 5.2.5.3 查询预订单详情
    - 5.2.5.4 查询桌台信息与预订单聚合信息
    - 5.2.5.5 预订到店
    - 5.2.5.6 取消预订
    - 5.2.5.7 预订单状态事件通知
    - 5.2.5.8 预订单关联的交易单的状态通知
  - 5.2.6 会员
    - 5.2.6.1 会员创建
    - 5.2.6.2 修改会员信息
    - 5.2.6.3 会员查询
    - 5.2.6.4 批量查询会员详情
    - 5.2.6.5 会员资产查询
    - 5.2.6.6 储值充值接口
    - 5.2.6.7 积分
      - 5.2.6.7.1 查询积分规则
      - 5.2.6.7.2 增加积分
      - 5.2.6.7.3 扣减积分
    - 5.2.6.8 优惠券
      - 5.2.6.8.1 券模板
        5.2.6.8.1.1 查询券模版列表
        5.2.6.8.1.2 查询券模版详情
        5.2.6.8.1.3 券模板变更事件通知
        5.2.6.8.1.4 查询券模版适用门店
        5.2.6.8.1.5 查询券模版适用商品
      - 5.2.6.8.2 券实例
        5.2.6.8.2.1 发送优惠券
        5.2.6.8.2.2 作废优惠券
        5.2.6.8.2.3 查询券实例列表
        5.2.6.8.2.4 查询券实例详情
  - 5.2.7 三方券
    - 5.2.7.1 查询券
    - 5.2.7.2 核销券
    - 5.2.7.3 反核销券
  - 5.2.8 供应链2.0
    - 5.2.8.1 报损出库查询
      - 5.2.8.1.1 报损出库单列表
      - 5.2.8.1.2 报损出库单详情
    - 5.2.8.2 其他出入库查询
      - 5.2.8.2.1 其他入库单详情
      - 5.2.8.2.2 其他入库单列表
      - 5.2.8.2.3 其他出库单列表
      - 5.2.8.2.4 其他出库单详情
    - 5.2.8.3 组织内调拨查询
      - 5.2.8.3.1 组织内调拨订单列表
      - 5.2.8.3.2 组织内调拨订单详情
    - 5.2.8.4 盘盈亏查询
      - 5.2.8.4.1 盘点单列表
      - 5.2.8.4.2 盘点单详情
    - 5.2.8.5 组织间调拨查询
      - 5.2.8.5.1 组织间调拨出库单详情
      - 5.2.8.5.2 组织间调拨出库单列表
      - 5.2.8.5.3 组织间调拨入库单列表
      - 5.2.8.5.4 组织间调拨入库单详情
    - 5.2.8.6 POS核减查询
      - 5.2.8.6.1 消耗出库单详情
      - 5.2.8.6.2 消耗出库单列表
    - 5.2.8.7 接收其他出入库数据
      - 5.2.8.7.1 其他入库（接收）
      - 5.2.8.7.2 其他出库（接收）
    - 5.2.8.8 接收采购数据
      - 5.2.8.8.1 采购入库（接收）
      - 5.2.8.8.2 采购退货出库（接收）
    - 5.2.8.9 库存查询
      - 5.2.8.9.1 库存查询
    - 5.2.8.10 基础信息
      - 5.2.8.10.1 查询组织机构信息
      - 5.2.8.10.2 新增或修改物品分类
      - 5.2.8.10.3 新增物品档案
      - 5.2.8.10.4 修改物品档案
    - 5.2.8.11 采购入库
      - 5.2.8.11.1 采购入库单详情
      - 5.2.8.11.2 采购入库单列表
    - 5.2.8.12 采购退货
      - 5.2.8.12.1 采购退货单列表
      - 5.2.8.12.2 采购退货单详情
    - 5.2.8.13 查询物品信息
      - 5.2.8.13.1 物品详情
      - 5.2.8.13.2 物品列表
    - 5.2.8.14 退菜入库查询信息
      - 5.2.8.14.1 退菜入库列表查询
      - 5.2.8.14.2 退菜入库详情查询
    - 5.2.8.15 销售订单查询
      - 5.2.8.15.1 销售订单详情
      - 5.2.8.15.2 销售订单列表
    - 5.2.8.16 配送验收入库查询
      - 5.2.8.16.1 配送验收入库单详情
      - 5.2.8.16.2 配送验收入库单列表
    - 5.2.8.17 配送退货查询
      - 5.2.8.17.1 向总部退货单详情
      - 5.2.8.17.2 向总部退货单列表
  - 5.2.9 系统集成
    - 5.2.9.1 oauth免登
      - 5.2.9.1.1 获取accessToken
      - 5.2.9.1.2 获取用户信息
      - 5.2.9.1.3 刷新accessToken
6 服务市场入驻
- 6.1 服务市场事件通知
- 6.2 不调用API接口，直接把服务上架到服务市场
7 公告中心
- 7.1 【公告】开放平台服务协议更新公告
8 更新日志

订单状态推送通知收费

(上行接口)客如云门店产生新订单或订单状态变更会推送对应状态给第三方合作者，合作者按operation值处理具体场景注：由于消息中间件特性，有小概率会重复推送消息，建议开发者以订单id和订单状态为判断标准，设计程序时，需做好幂等判断

授权方式：门店授权

请求描述

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

业务参数

参数名	类型	是否必填	参数描述
operation	Integer	是	订单操作类型 1.订单创建；13.订单确认（接受订单)；14.拒绝订单；15.订单取消；16.订单作废；19.退货；20.退款；21.反结账；26.订单完成；91.合单；92挂账；93.支付完成
shopId	Long	是	客如云门店Id
brandId	Long	是	客如云品牌Id
tradeId	Long	是	客如云订单Id
relatedTradeId	Long	是否	原单Id（若operation=19，20时，才会返回，relatedTradeId代表原单ID，tradId代表退货单ID）
mergeTradeIds	List	否	被合并的订单列表（operation=91时，才会返回此值，tradeId代表合并后的订单ID）
customerId	Long	否	会员Id
tradePayStatus	Integer	否	订单支付状态 1:UNPAID:未支付；2:PAYING:支付中(目前组合支付使用)；3:PAID:已支付；4:REFUNDING:退款中；5:REFUNDED:已退款；6:REFUND_FAILED:退款失败；8:WAITING_REFUND:等待退款；9:PAID_FAIL:支付失败
tradePayForm	Integer	否	支付方式 1:线下支付；2:在线支付；3:组合支付(暂时是微信在使用)

业务示例（JSON）

{
    "operation":1,
    "shopId":247900002,
    "brandId":2479,
    "tradeId":123456789,
    "tradePayStatus":2,
    "tradePayForm":2
}

响应参数

参数名	类型	是否必填	参数描述
code	Int	是	返回编码，详见错误码
message	String	是	返回信息
messageUuid	String	是	消息uuid
result	Pager	否	返回响应数据，json对象或数组，可为空

响应示例（JSON）

{
    "code":0,
    "message":"OK",
    "messageUuid":"3b4cce269b0d45a3a2a783e91bed263a"
}