Skip to content

customer ​

客户管理

概述 ​

k.commerce.customer 提供客户相关操作,包括创建、查询、登录、订单管理等功能。

create() ​

创建顾客。

ts
k.api.post(() => {
    const customer = k.commerce.customer.create({
        email: 'test@example.com',
        firstName: 'Test',
        lastName: 'User',
        password: '123456',
        phone: '15291101010'
    })
    return { id: customer.id, email: customer.email }
})

参数:

参数类型必填说明
valueobject是顾客信息
value.emailstring是邮箱
value.firstNamestring否名
value.lastNamestring否姓
value.passwordstring否密码
value.phonestring否电话

返回: Customer

get() ​

根据客户 ID 获取顾客。

ts
k.api.get(() => {
    const customer = k.commerce.customer.get('customer-id')
    return { id: customer.id, email: customer.email }
})

参数:

参数类型必填说明
idstring是顾客ID

返回: Customer

getByEmail() ​

根据邮箱获取顾客。

ts
k.api.get(() => {
    const customer = k.commerce.customer.getByEmail('test@example.com')
    return { id: customer.id, email: customer.email }
})

参数:

参数类型必填说明
emailstring是顾客邮箱

返回: Customer

getByPhone() ​

根据手机号获取顾客。

ts
k.api.get(() => {
    const customer = k.commerce.customer.getByPhone('15291101010')
    return { id: customer.id, phone: customer.phone }
})

参数:

参数类型必填说明
phonestring是手机号

返回: Customer

login() ​

顾客登录。

ts
k.api.post(() => {
    const result = k.commerce.customer.login('test@example.com', '123456')
    if (!result) {
        return { error: 'email or password is incorrect' }
    }
    return { id: result.id, email: result.email }
})

参数:

参数类型必填说明
emailstring是邮箱
passwordstring是密码

返回: Customer | string - 登录成功返回 Customer,失败返回错误信息

setPassword() ​

设置顾客密码。

ts
k.api.post(() => {
    k.commerce.customer.setPassword('customer-id', 'new-password')
    return 'password set success'
})

参数:

参数类型必填说明
customerIdstring是顾客ID
passwordstring是新密码

返回: Customer

setOAuth() ​

设置顾客的 OAuth 信息。

ts
k.api.post(() => {
    k.commerce.customer.setOAuth('customer-id', 'open-id-123', 'Apple')
    return 'set OAuth success'
})

参数:

参数类型必填说明
customerIdstring是顾客ID
openIdstring是第三方平台的 openId
typestring是第三方平台类型(如 Apple)

返回: void

getByOAuth() ​

根据 OAuth 信息获取顾客。

ts
k.api.get(() => {
    const customer = k.commerce.customer.getByOAuth('open-id-123', 'Apple')
    return { id: customer.id, email: customer.email }
})

参数:

参数类型必填说明
openIdstring是第三方平台 openId
typestring是第三方平台类型

返回: Customer

oAuthList() ​

获取顾客绑定的 OAuth 列表。

ts
k.api.get(() => {
    const list = k.commerce.customer.oAuthList('customer-id')
    return { count: list.length, items: list }
})

参数:

参数类型必填说明
customerIdstring是顾客ID

返回: CustomerOAuthModel[]

orders() ​

获取顾客的订单列表。

ts
k.api.get(() => {
    const orders = k.commerce.customer.orders('customer-id', {
        pageIndex: 1,
        pageSize: 10,
        paid: true,
        delivered: true,
        canceled: false
    })
    return { count: orders.count, orders: orders.list }
})

参数:

参数类型必填说明
customerIdstring是顾客ID
queryobject否查询参数
query.pageIndexnumber否页码,默认 1
query.pageSizenumber否每页条数,默认 10
query.paidboolean否是否已支付
query.deliveredboolean否是否已发货
query.canceledboolean否是否已取消
query.startDateDate否起始时间
query.endDateDate否截止时间

返回:

ts
{
    list: OrderDetail[];
    count: number;
    pageIndex: number;
    pageSize: number;
}

updateInfo() ​

更新顾客信息。

ts
k.api.post(() => {
    k.commerce.customer.updateInfo('customer-id', {
        firstName: 'Updated',
        lastName: 'Name',
        phone: '13900139000',
        tags: ['vip', 'active']
    })
    return 'update success'
})

参数:

参数类型必填说明
customerIdstring是顾客ID
infoobject是更新内容
info.emailstring否邮箱
info.firstNamestring否名
info.lastNamestring否姓
info.phonestring否电话
info.tagsstring[]否标签

返回: void

updateAddresses() ​

更新顾客的地址列表。

注意

本操作为覆盖写入,即传入的数组就是最终的地址列表

ts
k.api.post(() => {
    k.commerce.customer.updateAddresses('customer-id', [{
        country: '中国',
        province: '福建省',
        city: '厦门市',
        address1: 'address1',
        address2: 'address2',
        zip: '361000',
        firstName: 'firstName',
        lastName: 'lastName',
        phone: '13800138000',
        isDefault: true
    }])
    return 'update success'
})

参数:

参数类型必填说明
customerIdstring是顾客ID
addressesAddressModel[]是地址列表

返回: void

remove() ​

删除顾客。

ts
k.api.post(() => {
    k.commerce.customer.remove('customer-id')
    return 'remove success'
})

参数:

参数类型必填说明
customerIdstring是顾客ID

返回: void

结构 ​

Customer 属性 ​

属性说明类型
id客户IDstring
email客户邮箱string
firstName客户姓名string
lastName客户姓氏string
phone客户电话string
password客户密码string
lastPlaceOrderDate最后下单时间string
addresses地址列表AddressModel[]
tags标签列表string[]
createdAt创建时间string
updatedAt更新时间string

AddressModel 属性 ​

属性说明类型
id地址IDstring
isDefault是否默认地址boolean
country国家string
province省份string
city城市string
address1地址1string
address2地址2string
firstName收货人姓名string
lastName收货人姓氏string
phone电话string
zip邮编string

CustomerOAuthModel 属性 ​

属性说明类型
CustomerId顾客IDstring
OpenId第三方平台 openIdstring
Type第三方平台类型string
CreatedAt创建时间string

相关文档 ​