客如云 API
  1. 配送服务
客如云 API
  • 平台简介
  • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
  • 对接流程-API接口对接流程及操作步骤(上架服务市场)
  • 认证指南-服务商认证
  • 认证指南-品牌商认证
  • 接口能力大图
  • https对接说明
  • 接口请求公共参数
  • 响应参数
  • V2签名规则
  • 订单取消原因表
  • 订单状态
  • 错误码
  • 订单配送状态
  • 订单支付状态表
  • 回调接口编码
  • 支付机构代码
  • 接收菜品分类变更通知
  • 接收菜品变更通知
  • 订单状态推送通知收费
  • 自配送场景介绍
  • 客如云下发配送通知
  • 订单配送状态通知
  • 优惠券核销通知接口-上行
  • 第三方券核销介绍
  • 登录成功回调收费
  • 获取授权码code收费
  • 新手指南
    • 平台简介
    • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
    • 对接流程-API接口对接流程及操作步骤(上架服务市场)
    • 认证指南-服务商认证
    • 认证指南-品牌商认证
  • 接口能力大图
    • 接口能力大图
  • 公共说明
    • https对接说明
    • 接口请求公共参数
    • 响应参数
    • V2签名规则
    • 附录
      • 订单取消原因表
      • 订单状态
      • 错误码
      • 订单配送状态
      • 订单支付状态表
      • 回调接口编码
      • 支付机构代码
    • 获取门店token
  • 接口列表
    • 门店信息
      • 获取服务下可用门店
      • 获取门店列表
      • 获取门店信息
      • 获取门店经营时间
      • 查询门店营业状态
      • 修改门店营业状态
      • 查询桌台信息
      • 附加费配置查询接口
      • 支付类型查询
      • 门店设备列表查询接口
      • 门店设备状态推送接口
    • 菜品
      • 接收菜品分类变更通知
      • 接收菜品变更通知
      • 菜品分类信息查询
      • 菜品父级信息查询
      • 菜品分类查询
      • 菜品分页查询
      • 菜品精确查询
      • 批量修改门店菜品售卖数量
    • 订单信息
      • 订单状态推送通知收费
      • 查询订单详情
      • 查询订单列表
    • 后厨管理服务
      • 后厨菜品制作状态变更推送
    • 配送服务
      • 自配送场景介绍
      • 客如云下发配送通知
      • 订单配送状态通知
      • 商家自配送状态推送
        POST
    • 会员1.0
      • 会员基本信息1.0
        • 创建顾客
        • 创建/升级会员
        • 查询会员实体卡列表
        • 会员详情查询
        • 修改会员详情
        • 查询品牌下会员等级
        • 修改会员等级信息
      • 会员登录1.0
        • 会员登录
        • 会员登录二维码
        • 获取免登录token
      • 会员充值1.0
        • 会员充值接口
        • 查询门店储值消费金额
        • 会员充值/消费记录查询
      • 积分 1.0
        • 会员积分增加
        • 会员积分扣减
    • 优惠券1.0
      • 优惠券核销通知接口-上行
      • 查询优惠券列表
      • 查询券模板列表
      • 查询优惠券详情
      • 查询门店营销规则
      • 券模板发券接口
      • 客如云券核销
    • 第三方券核销
      • 第三方券核销介绍
      • 券查询
      • 券核销
      • 券反核销
    • 供应链1.0
      • 供应链基础数据1.0
        • 查询供应链物品接口
        • 查询仓库列表
        • 查询物品分类
        • 查询供应链物品库存
        • 查询商品库存收费
        • 接收商品库存变更
        • 查询供应商类别
        • 查询供应商列表
        • 查询交易记录
        • 获取交易凭证
        • 查询商户余额
      • 采购单据1.0
        • 查询采购入库单列表
        • 查询采购订单收费
        • 查询采购入库单明细
        • 查询采购退货单明细
        • 采购退货单列表收费
      • 销售单据1.0
        • 查询非销售单出库明细收费
      • 库存单据1.0
        • 入库单保存
        • 入库详情查询
        • 入库分页查询
        • 收货单详情
        • 收货单分页查询
        • 调拨单详情查询
        • 调拨单分页查询
        • 出库单保存
        • 出库详情查询
        • 出库分页查询
        • 配送签收单修改保存
        • 查询配送签收单详情
        • 配送签收单分页查询
        • 退回单详情查询
        • 退回单分页查询
        • 退回入库单分页查询
        • 退回入库单详情查询
        • 盘点单详情查询
        • 盘点单分页查询
        • 报废单详情查询收费
        • 报废单分页查询
    • 支付收银服务
      • 支付状态查询
      • 扫码支付(主扫)
      • 扫码支付(被扫)
      • 退款状态查询
      • 退款申请
    • OAUTH 授权服务
      • 登录成功回调收费
      • 获取授权码code收费
      • 获取用户信息
      • 获取token
  1. 配送服务

自配送场景介绍

1.自配送介绍#

  自配送是指商户或开发者通过自己的运力系统配送客如云商户流入客如云的外卖订单。

2.自配送对接接口介绍#

(1)客如云下发配送通知接口
  (上行接口)开发者按照对接流程配置此接口的回调地址地址,通过此接口客如云可把外卖订单下发到开发者对应的运力系统中
(2)订单配送状态通知接口
  (上行接口)开发者按照对接流程配置此接口的回调地址地址,接受客如云推送外卖配送订单状态通知(如:商户取消)
(3)商家自配送状态推送接口
  (下行接口)开发者调用此接口,可把客如云下发的外卖配送订单状态推送给客如云(如:订单配送中)

3.对接流程#

(1)根据对接流程开发接口,授权对应门店(可通过开发者后台授权门店,也可上架到服务市场,商户购买此项服务时授权门店)
(2)登录商户后台,切换到对应门店下,更多-设置-第三方管理-配送管理-配送服务-配送平台开通下查看申请的接口服务是否打开(在开发者后台申请的接口服务名称XXX,此处就显示XXX配送),若关闭,需要开启(默认是开启),如下图:
image.png
(3)可通过外卖下单接口下外卖订单到客如云pos,配送方式一定要选择商户1:自配送(配送方式,1:商家自配(商户自己配送或通过客如云接入的第三方配送平台),2:平台配送,3:自提),在pos上选择对应的配送服务,下发配送单子(也可以在商户后台配置自动下发配送订单),若下发成功,下发流程就对接完成。
(4)可通过订单状态通知接口与商家自配送订单状态通知接口验证客如云商户取消订单与运力方取消订单的异常情况,可参考对接流程图。

4.对接流程图#

image.png

5.对接注意事项#

(1)自配送不支持在pos上下的外卖订单,支持API接口下的外卖订单,支持客如云移动门店下的订单,支持其它渠道下到客如云的外卖订单
(2)若通过客如云API接口下的外卖订单,配送方式一定要选择自配送方式

【如客云】API开发者 微信交流群

用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通

扫码加入交流群
上一页
后厨菜品制作状态变更推送
下一页
客如云下发配送通知
Built with