用于修改会员卡信息，例如更新卡号、延长会员卡的有效期、调整等级。

延期类型，更新类型为会员卡延期时必填。支持的类型包括：0-根据卡模板设置的过期参数延期；1-自定义，过期时间必填。

delayType

newCustomCardNo

reason

operatorName

oldCustomCardNo

更新类型。支持的类型包括：1-更新卡号；2-会员卡延期；3-调整等级。

updateType

levelId

operatorWid

过期时间，延期类型为自定义延期时必填。

expireTime

membershipPlanId

成长值变更渠道，调整成长值等级时必填。支持的类型包括：972-充值；971-消费；970-评论；969-分享店铺；968-访问店铺；967-补充信息；965-关注公众号。

channelType

成长值变更渠道id，调整成长值等级时必填。

channelId

errcode

errmsg

code

status

data

待更新用户的 ID，是微盟用户身份的唯一标识。可通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2250&id=3810&isold=2">bos/user/search </a> 接口返回参数中的data.result 获取该 wid。

延期类型，更新类型为会员卡延期时（updateType=2 时）必填。支持的类型包括：0-根据卡模板设置的过期参数延期；1-自定义。

新卡号，更新类型为更新（updateType=1 ）时，该字段必填，长度为 12 至 20 位。

操作者名称，当前操作人的用户 ID 。可通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2252&id=2349&isold=2">bos/employee/getList </a> 接口返回参数中的 data.name 获取该名称。

旧卡号，更新类型为更新时（updateType=1 时 ），该字段必填。可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3133&isold=2">weimob_crm/membercard/getList</a> 接口返回参数中的 data.customCardNo 获取该 ID。

更新类型。支持的类型包括：1-更新卡号；2-会员卡延期；3-调整等级。
【注意】updateType =1 时，newCustomCardNo、oldCustomCardNo 必填；updateType =2 时，delayType、expireTime 必填；updateType =3 时，levelId 必填。

会员等级 ID。可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3133&isold=2">weimob_crm/membercard/getList</a> 接口返回参数中的 data.levelId 获取该 ID。更新类型为调整（updateType=3）时，该字段必填。

当前操作人的用户 ID 。可通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2252&id=2349&isold=2">bos/employee/getList </a> 接口返回参数中的 data.wid 获取该 wid。也可传默认值 0。

过期时间，格式为时间戳，单位为毫秒。延期类型为自定义延期时（delayType=1 时）必填。

该会员卡采用的会员方案 ID。可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3133&isold=2">weimob_crm/membercard/getList</a> 接口返回参数中的 data.membershipPlanId 获取该 ID。

成长值变更渠道，等级方案为成长值方案，调整成长值时，该字段必填。支持的类型包括：972-充值；971-消费；970-评论；969-分享店铺；968-访问店铺；967-补充信息；965-关注公众号。

成长值变更渠道 ID，用户可自定义设置，用于提供标记流水记录。等级方案为成长值方案，调整成长值时，该字段必填。不超过 20。

是否更新成功。true-成功；false-失败。

<span style="color:#333333;font-family:Inter, -apple-system, BlinkMacSystemFont, &quot;PingFang SC&quot;, &quot;Hiragino Sans GB&quot;, &quot;noto sans&quot;, &quot;Microsoft YaHei&quot;, &quot;Helvetica Neue&quot;, Helvetica, Arial, sans-serif;line-height:2;">用于通过以下任一<span style="color:#333333;font-family:Inter, -apple-system, BlinkMacSystemFont, &quot;PingFang SC&quot;, &quot;Hiragino Sans GB&quot;, &quot;noto sans&quot;, &quot;Microsoft YaHei&quot;, &quot;Helvetica Neue&quot;, Helvetica, Arial, sans-serif;line-height:2;">参数<span style="color:#333333;font-family:Inter, -apple-system, BlinkMacSystemFont, &quot;PingFang SC&quot;, &quot;Hiragino Sans GB&quot;, &quot;noto sans&quot;, &quot;Microsoft YaHei&quot;, &quot;Helvetica Neue&quot;, Helvetica, Arial, sans-serif;line-height:2;">传入方式，获取对应会员卡列表：用户 ID、用户 ID + 会员方案 ID、会员方案 ID + 会员卡号。

用户 ID，用户 ID 与会员卡号列表不能同时为空。

会员方案 ID，根据会员卡号查询时，会员方案 ID 必填。

会员卡号列表，每组最多10个。

customCardNoList

查询类型。支持的类型包括：1-会员卡基本信息；2-会员身份信息、会员等级ID；3-会员成长值；4-会员等级名称（查询会员等级名称有前置条件，需要传入查询类型：2，查询出会员等级ID）; 5-会员来源、渠道信息；6.会员卡名称、卡类型。 数组为空时，默认查询 [1,2,3,4,5] 五种类型；数组不为空时，查询传入的数组值来查询，查询类型1和2至少传一项；

queryType

obtainTime

customCardNo

effectiveTime

领卡渠道。支持的类型包括：-1-未知；0-微信公众号；1-微信小程序；2-支付宝；3-H5；4-百度小程序；5-商家后台（导入/新增/发卡）；6-自有APP（C端免登APP&H5）；7-APP收银台（APP发卡/收银发卡）。

membershipCardChannel

growthValue

领卡场景。支持的类型包括：0-未知；1-其他；2-扫描门店二维码；5-会员中心；6-线下主题活动；7-二维码；8-微信小程序；10-微信公众号；11-会员推荐；27-员工领卡。

membershipCardScene

卡状态。支持的类型包括：1-启用；2-冻结；3-作废；4-过期；5-待激活；6-待审核；7-待生效；8-已拒绝； 9-已失效。

membershipCardSceneId

cardNo

待查询会员卡信息的客户 wid

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2250&id=3810&isold=2" style="color:#0F72FF;" target="_blank">bos/user/search </a> 接口返回参数中的 data.result 获取该 wid。 

 <a style="background-color:#FBE4E7;border-radius:50px">&ensp;注意&ensp;</a> 

wid 与 customCardNoList 不能同时为空。

待查询会员卡采用的会员方案 ID。根据会员卡号查询时，会员方案 ID 必填。

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3259&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/membercard/plan/getList</a> 接口返回参数中的 data.membershipPlanId 获取该 ID。

待查询的会员卡号列表，每组最多 10 个。

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以订阅 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=2994&isold=2" style="color:#0F72FF;" target="_blank">会员开卡事件</a> 消息，从消息体中的 msgBody.customCardNo 获取该卡号。 

 <a style="background-color:#FBE4E7;border-radius:50px">&ensp;注意&ensp;</a> 

wid 与 customCardNoList 不能同时为空。

查询类型

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1：查询会员卡基本信息；2：查询会员身份信息、会员等级 ID；3：会员成长值；4：查询会员等级名称（必须与 2-查询会员等级 ID 一起传入）; 5：查询会员来源、渠道信息；6：查询会员卡名称、卡类型。 

 <a style="background-color:#FBE4E7;border-radius:50px">&ensp;注意&ensp;</a> 
▪ 不传此参数，则默认查询 [1,2,3,4,5] 五种类型； 
▪ 如需指定查询类型时，1 和 2 至少传一项。

会员卡的获取时间，格式为 “YYYY-MM-DD HH:mm:ss”

会员卡生效时间，格式为时间戳，单位为毫秒。

会员卡的领卡渠道

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

-1-未知；0-微信公众号；1-微信小程序；2-支付宝；3-H5；4-百度小程序；5-商家后台（导入/新增/发卡）；6-自有APP（C端免登APP&H5）；7-APP收银台（APP发卡/收银发卡）

会员卡的过期时间，格式为时间戳，单位为毫秒。

会员卡的领卡场景

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

0-未知；1-其他；2-门店二维码；3-线下导入；5-会员中心主页；8-用户领卡；9-第三方平台领卡；10-用户领卡；12-消费赠送；13-后台导入；14-后台新增；15-APP新增；16-第三方新增；17-营销活动粉丝召集令员；27-员工领卡；28-全民推广；29-后台发卡；31-用户领卡；32-付费领卡；34-红包也疯狂；35-默契大考验；39-百变二维码；42-营销活动扭蛋机；43-下开卡；49-乐高活动；51-POS开卡；52-集卡；53-优惠券引导开卡

会员卡状态

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1-启用；2-冻结；3-作废；4-过期；5-待激活；6-待审核；7-待生效；8-已拒绝；9-已失效

当客户端领卡或商户端后台发卡时触发会员开卡事件消息。

topic

event

bosId

sign

productInstanceId

绑卡类型：1-手动绑卡 2-自动绑卡

bindType

是否线下开卡：0-线上， 1-线下

offline

guideWid

开放消息来源；weimob-saas-mc- 微盟会员模块产生的消息、ONECRM_SPI-标记同步外部会员发的消息(需要外部过滤)

saasChannel

msgBody

防篡改签名：md5(clientId+id+msgBody+clientSecret)


绑卡类型。1-手动绑卡；2-自动绑卡。

绑卡类型；1. 手动绑卡 2. 自动绑卡

是否线下开卡。0-线上；1-线下。

是否线下开卡；0： 线上， 1线下

商户助手APP， 开通会员的导购 wid

开放消息来源。weimob-saas-mc：微盟会员模块产生的消息；ONECRM_SPI：标记同步外部会员发的消息（需要外部过滤）。

用于获取对应会员卡列表。

functionId

actionKey

vType

对应不同的source不同值，渠道openid参数 比如手机号

sourceOpenId

渠道的appid 如果渠道没有appid概念的话，可以不传

sourceAppId

渠道类型: 0.微信公众号 1.微信小程序  2.unionid  4.手机号phone

source

sourceObjectList

params

会员卡开卡渠道。0:微信公众号,1:微信小程序

领卡场景。0:未知,1:其他,2:扫描门店二维码,5:会员中心,6:线下主题活动,7:二维码,8:微信小程序,10:微信公众号,11:会员推荐,27:员工领卡

卡状态。1:启用,2:冻结,3:作废,4:过期,5:待激活,6:待审核,7:待生效,8:已拒绝,9:已失效

微盟新商业操作系统 ID。WOS 体系下商家创建店铺时，会自动生成 bosId，是店铺的唯一标识。可以在商家后台店铺设置的组织架构页面获取该 ID，也可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2350&isold=2">bos/info/get</a> 接口获取该 ID。

组织架构节点 ID。组织的唯一标识，是 <a href="http://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2850&isold=2">创建组织</a> 时自动生成的 ID，可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2348&isold=2">bos/organization/getList</a> 接口获取该 ID。

组织架构节点类型。类型包括：1-集团；2-品牌；3-区域；4-部门；5-商场；6-楼层；10-门店；11-网点；100-自提点。

对应不同的 source 不同值，渠道 openid 参数，比如手机号。

渠道的 appid 如果渠道没有 appid 概念的话，可以不传。

渠道类型：0-微信公众号；1-微信小程序；2-unionid；4-手机号 phone。

会员卡开卡渠道。0-微信公众号；1-微信小程序。

卡状态（必填）。1-启用；2-冻结；3-作废；4-过期；5-待激活；6-待审核；7-待生效；8-已拒绝；9-已失效。

当商户端变更会员方案时触发会员卡方案变更消息。

防篡改签名：md5(clientId+id+msgBody+clientSecret)

当会员等级发生变更时触发会员等级变更消息。

bosId	

changeTime

newLevelId

oldLevelId

等级变更时间，格式：时间戳。

当客户成长值发生变更时触发会员成长值变更消息。

changeReason

修改的成长值，整数类型，正数表示增加成长值，负数表示减少成长值

changeGrowth

用于根据用户出示的动态码，查询对应会员的相关信息。

动态码来源，用于区分本地或渠道。支持的类型包括：1-微盟本地卡动态码；2-微信卡动态码。

codeSource

组织架构节点 ID。组织的唯一标识，是创建组织时自动生成的 ID，可以通过 bos/organization/getList 接口获取该 ID

dynamicCode

phone

dynamicExpireAtTime

wxCode

动态码来源，用于区分本地或渠道

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1-微盟本地卡动态码；2-微信卡动态码

待查询会员码信息的组织 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2348&isold=2" style="color:#0F72FF;" target="_blank">bos/organization/getList</a> 接口返回参数中的 data.vid 获取该 ID。

客户编号，是客户在微盟的用户身份唯一标识。

动态码过期时间，格式为时间戳，单位为毫秒。

会员卡过期时间，格式为时间戳，单位为毫秒。

用于根据客户编号、会员卡方案 ID，删除对应会员卡。

用户 ID，是微盟用户身份的唯一标识。可通过 bos/user/search 接口获取 wid。

操作人 ID，可以通过 bos/employee/getList 接口获取，也可传默认值 0。

会员方案 ID。可以通过 weimob_crm/membercard/getList 获取该 ID。

删除状态标识。true-删除成功，false-删除失败。

删除会员卡的原因，要求 100 个字符以内

需要删除会员卡的客户编号

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2250&id=3810&isold=2" style="color:#0F72FF;" target="_blank">bos/user/search </a> 接口返回参数中的 data.result 获取该 wid。

操作人 wid

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2252&id=2349&isold=2" style="color:#0F72FF;" target="_blank">bos/employee/getList </a> 接口返回参数中的 data.wid 获取该 wid。也可传默认值 0。

会员卡采用的会员方案 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3133&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/membercard/getList</a> 接口返回参数中的 data.membershipPlanId 获取该 ID。

删除状态

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

true-删除成功，false-删除失败

当商户端删除会员卡时触发删除会员卡消息。

 membershipPlanId

用于根据客户编号 wid 以及相关会员资料信息，为对应客户开通领取会员卡。

领卡场景。 0:未知,1:其他,2:扫描门店二维码,5:会员中心,6:线下主题活动领卡,7:二维码定位门店,8:小程序领卡,10:公众号领卡,11:会员推荐,27:员工领卡

过期时间，自定义过期时间时必填

生效时间，自定义过期时间时必填

groupId

groupWholeFieldInfos

fieldInfo

groupFieldInfos

领卡渠道。-1:未知,0:微信公众号,1:微信小程序,2:支付宝,3:H5,4:百度小程序,5:商家后台(导入/新增/发卡),6:自有APP(C端免登APP&H5),7:APP收银台(APP发卡/收银发卡)

门店。0:无类型，无业务意义；10:门店

vidType

领卡场景 ID，外部 ID，与 membershipCardScene 搭配使用。

采用的会员方案的 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3259&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/membercard/plan/getList</a> 接口返回参数中的 data.membershipPlanId 获取该 ID。

会员等级 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3259&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/membercard/plan/getList</a> 接口返回参数中的 data.levelInfos.levelId 获取该 ID。

领卡场景，与 membershipCardSceneId 搭配使用。

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

0-未知；1-其他；2-扫描门店二维码；5-会员中心；6-线下主题活动领卡；7-二维码定位门店；8-小程序领卡；10-公众号领卡；11-会员推荐；27-员工领卡

需要领取会员卡的客户编号 wid

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2250&id=3810&isold=2" style="color:#0F72FF;" target="_blank">bos/user/search </a> 接口返回参数中的 data.result 获取该 wid。

会员卡过期时间，有效期类型采用固定有效期时必填。格式为时间戳，单位为毫秒。

会员卡生效时间，有效期类型采用固定有效期时必填。格式为时间戳，单位为毫秒。

开卡字段所属的分组 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=1655&id=3181&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/customer/field/config/get </a> 接口返回参数中的 data.groupList.groupId 获取该 ID。

会员开卡资料

 <a style="background-color:#FBE4E7;border-radius:50px">&ensp;注意&ensp;</a> 

如果店铺后台的 开卡设置 中设置了 领卡时需填写资料，并勾选了必填的开卡字段，此处 groupFieldInfos 必填，必须传入相应的开卡字段信息。

领卡渠道

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

-1-未知；0-微信公众号；1-微信小程序；2-支付宝；3-H5；4-百度小程序；5-商家后台（导入/新增/发卡）；6-自有APP（C端免登APP&H5）；7-APP收银台（APP发卡/收银发卡）

开卡门店的组织 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2348&isold=2" style="color:#0F72FF;" target="_blank">bos/organization/getList</a> 接口返回参数中的 data.vid 获取该 ID。

开卡门店的组织类型，与 vid 对应。

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1-集团；2-品牌；3-区域；4部门；5-商场；6-楼层；10-门店；11-网点；100-自提点

创建成功的会员卡号

 <a style="background-color:#FBE4E7;border-radius:50px">&ensp;注意&ensp;</a> 

当店铺所配置的会员卡卡号规则为系统随机 20 位卡号时，该字段会返回系统随机生成的卡号。

用于根据组织 ID、卡类型、会员卡方案 ID，查询相应的会员卡方案数据。

卡类型。支持的类型包括：1-等级卡；2-权益卡。

cardType

查询类型。支持的类型包括：1-会员卡基本信息；2-会员卡详情信息（包含等级信息）；3-成长值别名；4.微信卡信息；5.分享信息；6-权益信息

name

growthName

等级规则类型。支持的类型包括：1-成长值；2-条件等级。

levelRuleType

levelName

rightInfo

levelInfos

有效期类型。支持的类型包括：1-天；2-月；3-年。

validType

validValue	

排序（按序号大小排序，序号小的排在前面）

sort

dynamicSettings

会员卡状态。支持的类型包括：0-禁用；1-启用。

cardFreeType

cardExplain

privilegeId

privilegeName

权益类型，类型包括：1-商品折扣；2-优先发货；3-急速售后；4-优先购买；5-急速客服；6-商品专享；7-专属礼券；8-生日礼；9-节日礼；10-微客直通车；11-自定义权益；12-消费折扣；14-消费积分；15-生日特权；16-自定义权益（组合）17=会员专属券 18=会员满包邮

privilegeType

remark

ruleId

ruleName

需要查询的指定会员卡方案 ID。不传默认查询所有会员卡方案。

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2483&id=3133&isold=2" style="color:#0F72FF;" target="_blank">weimob_crm/membercard/getList</a> 接口返回参数中的 data.membershipPlanId 获取该 ID。

卡类型

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1-等级卡：属于会员等级体系，商家可以根据会员成长规则、升降级机制设置不同等级下，会员可以拥有的权益； 
2-权益卡：与等级无关，仅与商家配置权益有关，用户领取权益卡后，在有效期内可享有该卡拥有的权益，且该权益无法升级。

待查询的会员卡方案所属的组织 ID

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;获取方法&ensp;</a> 

可以通过 <a href="https://doc.weimobcloud.com/detail?menuId=19&childMenuId=1&tag=2253&id=2348&isold=2" style="color:#0F72FF;" target="_blank">bos/organization/getList</a> 接口返回参数中的 data.vid 获取该 ID。

查询类型

 <a style="background-color:#E8E8FF;border-radius:50px">&ensp;枚举值&ensp;</a> 

1-查询卡的基本信息；2-查询卡的详情信息（包含等级信息）；3-查询成长值名称；4-查询微信卡信息；5-查询分享信息；6-查询权益信息。

微盟内部产品实例 ID（外部无需关注）

文档中心

开发者角色

快速开始

工具与帮助

能力中心

常用API

能力场景

解决方案

会员卡