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

创建/升级会员

测试环境
https://gldopenapi.keruyun.com
测试环境
https://gldopenapi.keruyun.com
POST
/open/v1/crm/createOrUpgradeMember
(下行接口)合作方创建(升级)会员
注意: 如果loginType!=0时,需要在客如云商户后台开通微信关注及会员,否则,微信会员无法使用该接口升级为会员
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/crm/createOrUpgradeMember?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": 800000095,
    "customerMainId": 800000095,
    "loginType": 0,
    "loginId": "18980808088",
    "consumePwd": "098f6bcd4621d373cade4e832627b4f6",
    "birthday": 1475116492,
    "sex": 1,
    "name": "李华",
    "environmentHobby": "喜欢安静",
    "memo": "",
    "invoiceTitle": "",
    "email": "adsad@asd.com",
    "address": "",
    "groupId": "",
    "wxIconUrl": "",
    "attentionWxTime": 1475116492
}'
响应示例响应示例
{
  "code": 1,
  "result": {
    "brandId": 6339,
    "commercialId": 89877,
    "customerId": 800000095,
    "customerMainId": 800000095,
    "userId": -777,
    "source": 16,
    "loginType": 0,
    "loginId": "18980808088",
    "birthday": 1475116492,
    "sex": 1,
    "name": "李华",
    "environmentHobby": "喜欢安静",
    "memo": "",
    "invoiceTitle": "",
    "email": "adsad@asd.com",
    "address": "",
    "groupId": "",
    "wxIconUrl": "",
    "isDisable": 1
  }
}

请求参数

Query 参数
appKey
string 
必需
开发者申请服务客如云分配的appKey
默认值:
{{appKey}}
shopIdenty
string 
必需
客如云门店id (门店维度接口传递门店ID)
默认值:
{{shopIdenty}}
brandId
string 
必需
客如云品牌id(品牌授权的接口传递品牌ID)
默认值:
{{brandId}}
version
string 
必需
版本,默认2.0(1.0版本仍可用)
默认值:
2.0
timestamp
string 
必需
时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒,我方服务器使用阿里云授时中心
默认值:
{{timestamp}}
sign
string 
必需
签名,64位长度的字符串,获取规则详见签名规则
默认值:
{{sign}}
Body 参数application/json
loginId
string 
必需
手机号码\微信openId
birthday
integer 
生日(时间戳)
必需
sex
integer 
必需
性别(-1:未知;0:女;1:男;)
name
string 
顾客名
必需
environmentHobby
string 
兴趣爱好
必需
memo
string 
备注
必需
invoiceTitle
string 
发票抬头
必需
email
string 
电子邮箱
必需
address
string 
地址
可选
groupId
string 
顾客分组
必需
wxIconUrl
string 
微信头像URL
可选
attentionWxTime
integer 
可选
关注微信时间(时间戳)
nationalTel
object (CustomerNation) 
必需
电话国际区码信息(为空默认中国)
nation
string 
国家英文名称
必需
country
string 
国家中文名称
必需
nationalTelCode
string 
电话国际区码
必需
consumePwd
string 
必需
消费密码(6位整数或者MD5加密)
customerId
integer 
必需
顾客ID,传0表示为创建会员
customerMainId
string 
必需
顾客主ID,传0表示为创建会员
loginType
string 
必需
登陆类型(0:手机注册客户;1:微信注册用户;2:座机号;101:微信会员卡卡号;)
示例

返回响应

🟢200成功
application/json
Body
code
integer 
必需
result
可选
返回响应数据,json对象或数组,可空
One of
brandId
integer 
品牌ID
必需
commercialId
integer 
客如云门店ID
必需
customerId
integer 
顾客ID
必需
customerMainId
integer 
顾客主ID
必需
userId
integer 
操作人ID
必需
source
integer 
必需
顾客来源(1:CALM;2:手机app;3:其他系统倒入;4:微信;5:支付宝;6:商家官网;7:百度;8:后台;9:百度外卖;10:饿了么;11:美图外卖;12:大众点评;13:熟客;14:糯米点菜;15:os mobile;16:开放平台;)
loginType
integer 
必需
登录类型(0:手机注册客户;1:微信注册用户;2:座机号;101:微信会员卡卡号;)
loginId
string 
必需
手机号码\微信openId
birthday
integer 
必需
sex
integer 
必需
性别(-1:未知;0:女;1:男;)
name
string 
顾客名
必需
environmentHobby
string 
兴趣爱好
可选
memo
string 
备注
可选
invoiceTitle
string 
发票抬头
可选
email
string 
电子邮箱
可选
address
string 
地址
可选
groupId
string 
顾客分组名称
可选
wxIconUrl
string 
微信头像URL
可选
isDisable
integer 
必需
是否停用(1:停用;2:未停用;)
message
string 
返回信息
必需
messageUuid
string 
消息uuid
必需

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

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

扫码加入交流群
上一页
创建顾客
下一页
查询会员实体卡列表
Built with