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

优惠券核销通知接口-上行

接口描述#

该接口是客如云优惠券核销后,通知第三方核销信息接口

接口被调用方#

第三方合作伙伴

被调接口地址#

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
URI:  《第三方回调地址》

参数说明#

请求参数#

参数名字段名类型是否必填字段描述
券规则IDcouponRuleIdLong是券规则唯一标示
券实例IDcouponIdLong是券实例唯一标示
品牌IDbrandIdLong是品牌唯一标示
验券门店IdshopIdLong是验券门店唯一标示
验券来源checkSourceInteger是1:mobile,2:后台,3:微信,4:pos,5:自助
验券时间checkTimeLong是验券时间,毫秒数时间戳
验券人IdcheckerIdLong否验券人Id
验券人名称checkerNameString是验券人名称
消费人数consumePersonsInteger否消费人数
创建时间createTimeLong是创建时间,毫秒数时间戳
验券记录IdidLong是验券记录Id
减免金额offerValueBigDecimal是减免金额
订单idorderUUIdString是订单ID
消费金额payAmountBigDecimal是消费金额
更新时间updateTimeLong是更新时间,毫秒数时间戳

请求示例代码#

{
  "couponRuleId": 123456789,
  "couponId": 123456789,
  "brandId": 123456789,
  "shopId": 123456789,
  "checkSource":1,
  "checkTime":123456789,
  "checkerId":123456789,
  "checkerName": "张三",
  "consumePersons": 2,
  "createTime": 123456789,
  "id":1,
  "offerValue":3,
  "orderUUId":123456789,
  "payAmount":30,
  "updateTime":123456789
}

响应参数#

参数名参数类型是否必填参数描述
codeInteger是错误码;0:成功;其他值认为失败
messagestring是返回信息
messageUuidstring是错误信息序列码
resultnull否无

响应示例代码#

{
    "result": null,
    "code": 0,
    "message": "成功[OK]",
    "messageUuid": "964644b070104fd0985b4a59023813bb",
    "apiMessage": "成功[OK]"
}

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

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

扫码加入交流群
上一页
会员积分扣减
下一页
查询优惠券列表
Built with