客如云 API
复制页面
客如云 API
平台简介
对接流程-API接口对接流程及操作步骤(不上架服务市场)
对接流程-API接口对接流程及操作步骤(上架服务市场)
认证指南-服务商认证
认证指南-品牌商认证
接口能力大图
https对接说明
接口请求公共参数
响应参数
V2签名规则
订单取消原因表
订单状态
错误码
订单配送状态
订单支付状态表
回调接口编码
支付机构代码
接收菜品分类变更通知
接收菜品变更通知
订单状态推送通知收费
自配送场景介绍
客如云下发配送通知
订单配送状态通知
优惠券核销通知接口-上行
第三方券核销介绍
登录成功回调收费
获取授权码code收费
新手指南
平台简介
对接流程-API接口对接流程及操作步骤(不上架服务市场)
对接流程-API接口对接流程及操作步骤(上架服务市场)
认证指南-服务商认证
认证指南-品牌商认证
接口能力大图
接口能力大图
公共说明
https对接说明
接口请求公共参数
响应参数
V2签名规则
附录
订单取消原因表
订单状态
错误码
订单配送状态
订单支付状态表
回调接口编码
支付机构代码
获取门店token
接口列表
门店信息
获取服务下可用门店
获取门店列表
获取门店信息
获取门店经营时间
查询门店营业状态
修改门店营业状态
查询桌台信息
附加费配置查询接口
支付类型查询
门店设备列表查询接口
门店设备状态推送接口
菜品
接收菜品分类变更通知
接收菜品变更通知
菜品分类信息查询
菜品父级信息查询
菜品分类查询
菜品分页查询
菜品精确查询
批量修改门店菜品售卖数量
订单信息
订单状态推送通知收费
查询订单详情
查询订单列表
后厨管理服务
后厨菜品制作状态变更推送
配送服务
自配送场景介绍
客如云下发配送通知
订单配送状态通知
商家自配送状态推送
会员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.第三方券核销介绍
#
客如云第三方券核销是客如云基于自身的硬件能力和标准接口,连接上下游资源,打通了第三方券平台的核销通道。助力商家在客如云pos上核销第三方券平台、小程序、app发放的各种折扣券、满减券。拓宽商户引流渠道,增加商户营业收入。
2.第三方券核销接口介绍
#
(1)券查询接口
(上行接口)合作方提供此接口地址,接受客如云商户pos端查询券信息的请求(满足第三方满减券、折扣券在客如云POS端核销验券场景)
(2 )券核销接口
(上行接口)合作方提供此接口地址,接受客如云商户pos端核销券的请求(满足第三方满减券、折扣券在客如云POS端核销验券场景)
(3)券反核销接口
(上行接口)合作方提供此接口地址,接受客如云商户pos端券反核销的请求(券反核销用于已经使用优惠券结账的订单发生退款的场景,订单退款,商户pos端调用此接口进行券的反核销,反核销后的优惠券还能再次使用)
3.第三方券核销对接流程
#
(1)申请券核销接口
注册成为客如云开发者
,开发者中心中创建服务,选择第三方营销,验券(查询、核销、反核销)填写回调地址,提交审核。
(2)接口功能开发
接口审核通过,授权测试门店,根据文档调试接口。
(3)授权方式(根据需要选择)
(3.1)购买授权(面向所有客如云商户)
1.上架到服务市场
接口开发完成,根据
对接流程
,把该服务上架到客如云服务市场。
2.购买服务
服务市场服务审核通过后,前往服务市场,购买该服务。
(哪个门 店需要用到券核销功能,就用那个门店进行购买)
(3.2)扫码授权(面向应用指定商户)
请参考
对接流程
中扫码授权流程
(4)pos重启
重启已购买此服务的门店pos
(5)pos上核销券码
pos上收银时,点击卡券——找到此服务的核销入口(如:你的服务叫XXX,券入口就叫:XXX第三方营销)输入券码结算即可
3.第三方券核销购买对接流程图
#
4.第三方券核销扫码授权对接流程
#
请参考
对接流程
中扫码授权流程
5.对接注意事项
#
(1)上图流程仅供参考,开发者需根据自己的需求来对接
(2)正式环境pos要求的版本是:10.15.1版本及以上
(3)用券核销接口开发的功能服务必须要上架到客如云服务市场,商户通过服务市场购买才能使用(需开发者在沙箱环境把流程跑通,在切换到正式环境)
(4)crm2.0商户不可使用第三方券核销能力
【如客云】API开发者 微信交流群
用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通
扫码加入交流群
上一页
优惠券核销通知接口-上行
下一页
登录成功回调收费