顾客管理

1. 获取顾客列表（getCustomerList）

前端： 谭海涛
后端： 陈明辉 url： /v1/homing/system/web/customer/page-list
备注： WEB-顾客-列表

typescript

//! 注意，TS版本4^
import type { GetCustomerListReq, GetCustomerListRes } from '@homing/web'

homingClient.getCustomerList({
  orgId: '123',
  pageIndex: '1',
  pageRows: '10',
  nickname: '张三',
  mobile: '13800138000'
}).then((res: any) => {
  console.log('顾客列表', res.customerList);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
`nickname`	string	否	昵称
`mobile`	string	否	手机号
`gender`	string	否	性别
`age`	number	否	年龄
`birthdayMonths`	string	否	生日月份	多个月份用逗号隔开
`orgId`	string	是	机构标识
`pageIndex`	string	是	页码
`pageRows`	string	是	行数
`startCreateTime`	string	否	开始活动时间
`endCreateTime`	string	否	结束活动时间
`tagName`	string	否	标签名称
`startLastTestDate`	string	否	开始最近测试时间
`endLastTestDate`	string	否	结束最近测试时间
`touristFlag`	boolean	否	是否仅查询游客列表
`serviceRole`	string	否	查询幼儿或者家长数据	PRIMARY-幼儿 ASSOCATIED-家长

响应说明

字段名	类型	说明
`total`	number	总记录数
`pageIndex`	number	当前页码
`pageRows`	number	每页记录数
`customerList`	CustomerListItem[]	顾客列表数据

CustomerListItem 字段说明

字段名	类型	说明
`orgId`	number	所属机构id
`orgName`	string	所属机构名称
`customerId`	number	顾客注册账号标识
`nickname`	string	昵称
`realName`	string	姓名/真名
`gender`	string	性别
`birthday`	string	生日
`weight`	string	体重
`height`	string	身高
`state`	number	状态
`tenantCode`	string	租户编号
`createdBy`	string	创建人
`createdTime`	string	创建时间
`updatedBy`	string	更新人
`updatedTime`	string	更新时间
`avatar`	string	头像
`age`	number	年龄
`mobile`	string	手机号
`customerCode`	string	顾客code
`fullMobile`	string	完整手机号
`orgType`	string	机构类型

customerBusinessInfo 字段说明

字段名	类型	说明
`lastTestDate`	string	上一次测肤时间
`skinTestTimes`	string	累计测肤次数

customerTextTag 字段说明

字段名	类型	说明
`tagItems`	Array	顾客标签列表

tagItems 字段说明

字段名	类型	说明
`tagCode`	string	标签code
`tagName`	string	名称
`sortValue`	string	排序

2. 获取顾客详情（getCustomerInfo）

前端： 谭海涛
后端： 陈明辉 url： /v1/homing/system/web/customer/get
备注： WEB-顾客-获取详情适用角色类型：顾客，家长，幼儿

typescript

//! 注意，TS版本4^
import type { GetCustomerInfoReq, GetCustomerInfoRes } from '@homing/web'

homingClient.getCustomerInfo({
  customerId: 123
}).then((res: any) => {
  console.log('顾客详情', res);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
`customerId`	number	是	顾客ID

响应说明

字段名	类型	说明
`customerId`	number	顾客ID
`nickname`	string	昵称
`realName`	string	真实姓名
`gender`	number	性别 0-未知 1-男 2-女
`birthday`	string	生日

3. 更新顾客信息（updateCustomerInfo）

前端： 谭海涛
后端： 陈明辉 url： /v1/homing/system/web/customer/update
备注： WEB-顾客-更新

typescript

//! 注意，TS版本4^
import type { UpdateCustomerInfoReq } from '@homing/web'

try {
    await client.updateCustomerInfo({
        customerId: 123,
        nickname: '新昵称',
        realName: '新姓名'
    } as UpdateCustomerInfoReq);
    console.log('更新成功');
} catch (error: any) {
    console.log(error, '更新失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
`customerId`	number	是	顾客ID
`nickname`	string	否	昵称
`realName`	string	否	真实姓名
`gender`	number	否	性别	0-未知 1-男 2-女
`birthday`	string	否	生日

响应说明

字段名	类型	说明
无

4. 删除顾客（removeCustomer）

前端： 谭海涛
后端： 陈明辉 url： /v1/homing/system/web/customer/delete
备注： WEB-顾客-删除

typescript

//! 注意，TS版本4^
import type { RemoveCustomerReq } from '@homing/web'

try {
    await client.removeCustomer({
        customerId: 123
    } as RemoveCustomerReq);
    console.log('删除成功');
} catch (error: any) {
    console.log(error, '删除失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
`customerId`	number	是	顾客ID

响应说明

字段名	类型	说明
无

5. 分页获取家长/幼儿档案列表（getCustomerArchivesList）

前端： 谭海涛
后端： 陈明辉 url： /v1/homing/system/web/customer/archives/page-list
备注： WEB-顾客档案-分页列表

typescript

//! 注意，TS版本4^
import type { GetCustomerArchivesListReq, GetCustomerArchivesListRes } from '@homing/web'

homingClient.getCustomerArchivesList({
  orgId: '123',
  pageIndex: '1',
  pageRows: '10'
}).then((res: any) => {
  console.log('档案列表', res);
});

参数说明

参数名	类型	必填	说明
`orgId`	string	是	机构ID
`pageIndex`	string	是	页码
`pageRows`	string	是	每页条数

响应说明

字段名	类型	说明
`total`	number	总记录数
`pageIndex`	number	当前页码
`pageRows`	number	每页记录数
`list`	CustomerArchivesItem[]	档案列表数据

6. 获取家庭顾客列表（getFamilyCustomerList）

前端： 谭海涛
后端： 章强
url： /system/web/family/get-list-customer
备注： 获取家庭顾客列表，查询顾客家庭列表

typescript

//! 注意，TS版本4^
import type { GetFamilyCustomerListReq, GetFamilyCustomerListRes } from '@homing/web';

try {
  const data: GetFamilyCustomerListRes = await client.getFamilyCustomerList({
    customerId: 123,
    orgId: 456,
    familyRoles: ['FATHER', 'MOTHER'],
    withOneself: true,
    withDetailedAge: true,
    withOrgInfoList: true
  } as GetFamilyCustomerListReq);
  console.log('调用成功', data);
} catch (error: any) {
  console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	是否必填	说明	备注/枚举值
`customerId`	number	是	顾客ID
`orgId`	number	是	机构ID
`familyRoles`	string[]	否	家庭角色列表	'OTHER'-其他 'NANNY'-保姆 'AUNT'-婶婶 'UNCLE'-叔叔 'M_GRANDMOTHER'-姥爷 'M_GRANDFATHER'-姥姥 'GRANDMOTHER'-奶奶 'GRANDFATHER'-爷爷 'FATHER'-爸爸 'MOTHER'-妈妈 'SON'-儿子 'DAUGHTER'-女儿
`withOneself`	boolean	否	是否包含自己
`withDetailedAge`	boolean	否	是否包含详细年龄
`withOrgInfoList`	boolean	否	是否包含机构信息列表

响应说明

字段名	类型	说明	备注/枚举值
`memberId`	string	成员ID
`memberCode`	string	成员编码
`familyId`	string	家庭ID
`familyRole`	string	家庭角色	'OTHER'-其他 'NANNY'-保姆 'AUNT'-婶婶 'UNCLE'-叔叔 'M_GRANDMOTHER'-姥爷 'M_GRANDFATHER'-姥姥 'GRANDMOTHER'-奶奶 'GRANDFATHER'-爷爷 'FATHER'-爸爸 'MOTHER'-妈妈 'SON'-儿子 'DAUGHTER'-女儿
`customerId`	number	顾客ID
`nickname`	string	昵称
`realName`	string	真实姓名
`trueImg`	string	真实头像
`gender`	number	性别
`birthday`	string	生日
`age`	number	年龄
`detailedAge`	string	详细年龄
`mobile`	string	手机号
`workCorp`	string	工作单位
`orgVOList`	OrgVO[]	机构信息列表

OrgVO详细说明

字段名	类型	说明	备注/枚举值
`orgId`	string	机构ID
`orgCode`	string	机构编码
`orgName`	string	机构名称
`orgType`	number	机构类型	0-全部 1-区中心组织 2-总部 3-区域/分部 4-门店 5-部门 12-站点 13-年级 14-班级
`parentId`	string	父机构ID

顾客管理 ​

1. 获取顾客列表（getCustomerList） ​

参数说明 ​

响应说明 ​

2. 获取顾客详情（getCustomerInfo） ​

参数说明 ​

响应说明 ​

3. 更新顾客信息（updateCustomerInfo） ​

参数说明 ​

响应说明 ​

4. 删除顾客（removeCustomer） ​

参数说明 ​

响应说明 ​

5. 分页获取家长/幼儿档案列表（getCustomerArchivesList） ​

参数说明 ​

响应说明 ​

6. 获取家庭顾客列表（getFamilyCustomerList） ​

参数说明 ​

响应说明 ​

顾客管理

1. 获取顾客列表（getCustomerList）

参数说明

响应说明

2. 获取顾客详情（getCustomerInfo）

参数说明

响应说明

3. 更新顾客信息（updateCustomerInfo）

参数说明

响应说明

4. 删除顾客（removeCustomer）

参数说明

响应说明

5. 分页获取家长/幼儿档案列表（getCustomerArchivesList）

参数说明

响应说明

6. 获取家庭顾客列表（getFamilyCustomerList）

参数说明

响应说明