Skip to content

settings ​

电商设置

概述 ​

k.commerce.settings 提供电商全局设置相关操作,用于获取货币、支付、物流、通知等配置信息。

currencyCode ​

获取货币代码。

ts
k.api.get(() => {
    return k.commerce.settings.currencyCode
})

返回: string(如 "CNY")

currencySymbol ​

获取货币符号。

ts
k.api.get(() => {
    return k.commerce.settings.currencySymbol
})

返回: string(如 "CN¥")

weightUnit ​

获取重量单位。

ts
k.api.get(() => {
    return k.commerce.settings.weightUnit
})

返回: string(如 "kg")

payments ​

获取支付方式列表。

ts
k.api.get(() => {
    return k.commerce.settings.payments
})

返回: string[]

earnPoint ​

获取积分获取配置。

ts
k.api.get(() => {
    return k.commerce.settings.earnPoint
})

返回: EarnPointSettings

redeemPoint ​

获取积分抵扣规则。

ts
k.api.get(() => {
    return k.commerce.settings.redeemPoint
})

返回: RedeemPointSettings

orderExtensionFields ​

获取订单扩展字段配置。

ts
k.api.get(() => {
    return k.commerce.settings.orderExtensionFields
})

返回: ExtensionField[]

productCustomFields ​

获取产品自定义字段配置。

ts
k.api.get(() => {
    return k.commerce.settings.productCustomFields
})

返回: CustomField[]

hideAttributes ​

获取是否隐藏属性。

ts
k.api.get(() => {
    return k.commerce.settings.hideAttributes
})

返回: boolean

hideVariants ​

获取是否隐藏规格。

ts
k.api.get(() => {
    return k.commerce.settings.hideVariants
})

返回: boolean

customMailServer ​

获取自定义邮件服务器配置。

ts
k.api.get(() => {
    return k.commerce.settings.customMailServer
})

返回: MailServer

mailServerType ​

获取邮件服务器类型。

ts
k.api.get(() => {
    return k.commerce.settings.mailServerType
})

返回: "kooboo" | "custom"

koobooEmailAddress ​

获取 Kooboo 邮箱地址。

ts
k.api.get(() => {
    return k.commerce.settings.koobooEmailAddress
})

返回: string

enableEmailNotification ​

获取是否启用邮件通知。

ts
k.api.get(() => {
    return k.commerce.settings.enableEmailNotification
})

返回: boolean

emailNotifications ​

获取邮件通知配置列表。

ts
k.api.get(() => {
    return k.commerce.settings.emailNotifications
})

返回: EmailNotification[]

enableWebhook ​

获取是否启用 Webhook。

ts
k.api.get(() => {
    return k.commerce.settings.enableWebhook
})

返回: boolean

webhooks ​

获取 Webhook 配置列表。

ts
k.api.get(() => {
    return k.commerce.settings.webhooks
})

返回: Webhook[]

webhookSecret ​

获取 Webhook 密钥。

ts
k.api.get(() => {
    return k.commerce.settings.webhookSecret
})

返回: string

结构 ​

Settings 属性 ​

k.commerce.settings 返回完整的电商设置对象,包含以下属性:

属性说明类型
currencyCode货币代码string
currencySymbol货币符号string
weightUnit重量单位string
earnPoint积分获取配置EarnPointSettings
redeemPoint积分抵扣配置RedeemPointSettings
shippingCost运费number
payments支付方式列表string[]
productCustomFields产品自定义字段CustomField[]
categoryCustomFields分类自定义字段CustomField[]
orderExtensionFields订单扩展字段ExtensionField[]
enableEmailNotification是否启用邮件通知boolean
customMailServer自定义邮件服务器MailServer
koobooEmailAddressKooboo 邮箱地址string
mailServerType邮件服务器类型string
emailNotifications邮件通知列表EmailNotification[]
enableWebhook是否启用 Webhookboolean
webhooksWebhook 配置列表Webhook[]
webhookSecretWebhook 密钥string
hideAttributes是否隐藏属性boolean
hideVariants是否隐藏规格boolean
productDigitalItemRequired数字产品是否必填boolean

EarnPointSettings 属性 ​

属性说明类型
activeDurationUnit积分有效时长单位string
activeDuration积分有效时长数值number
orderEarnRules订单赚取规则OrderEarnPointsRule[]
loginEarnRules登录赚取规则LoginEarnPointsRule[]

RedeemPointSettings 属性 ​

属性说明类型
exchangeRate兑换比例number
orderRedeemRules订单抵扣规则OrderRedeemPointsRule[]

OrderEarnPointsRule 属性 ​

属性说明类型
value赚取积分值number
isPercent是否为订单金额百分比boolean
description描述string
condition条件Condition

LoginEarnPointsRule 属性 ​

属性说明类型
value赚取积分值number
durationUnit积分有效时长单位string
description描述string
condition条件Condition

OrderRedeemPointsRule 属性 ​

属性说明类型
value抵扣积分值number
isPercent是否为订单金额百分比boolean
description描述string
condition条件Condition

Condition 属性 ​

属性说明类型
isAny任一条件满足即可boolean
items条件项列表ConditionItem[]

ConditionItem 属性 ​

属性说明类型
option条件选项string
method条件方法string
value条件值string

ExtensionField 属性 ​

属性说明类型
name字段名string
displayName显示名称string
type类型string
editable是否可编辑boolean
exportable是否可导出boolean
filterable是否可筛选boolean
isSelection是否为选择类型boolean

Webhook 属性 ​

属性说明类型
event事件类型string
urlWebhook URLstring

EmailNotification 属性 ​

属性说明类型
id通知IDstring
event事件类型string
subjectTemplate邮件主题模板string
bodyTemplate邮件内容模板string
sendToCustomer是否发送给客户boolean
sendToAddresses发送地址列表string[]

MailServer 属性 ​

属性说明类型
server服务器地址string
port端口number
ssl是否启用 SSLboolean
from发件人地址string
userName用户名string
password密码string

相关文档 ​