客如云 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

    订单状态推送通知收费

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

    请求描述#

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

    业务参数#

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

    业务示例(JSON)#

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

    响应参数#

    参数名类型是否必填参数描述
    codeInt是返回编码,详见错误码
    messageString是返回信息
    messageUuidString是消息uuid
    resultPager否返回响应数据,json对象或数组,可为空

    响应示例(JSON)#

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

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

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

    扫码加入交流群
    上一页
    接收菜品变更通知
    下一页
    自配送场景介绍
    Built with