Skip to content

order ​

订单

概述 ​

k.commerce.order 提供订单相关操作,包括查询、创建、支付、发货、取消等功能。

list() ​

获取订单列表。

ts
k.api.get(() => {
    const result = k.commerce.order.list({
        startDate: new Date('2025-01-01'),
        endDate: new Date('2025-12-31'),
        paid: false,
        delivered: false,
        canceled: false,
        pageIndex: 1,
        pageSize: 10
    })
    return result
})

参数:

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

返回:

ts
{
    list: OrderDetail[];  // 订单列表
    count: number;        // 总数量
    pageIndex: number;    // 当前页码
    pageSize: number;     // 每页条数
}

get() ​

获取指定订单详情。

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

参数:

参数类型必填说明
orderIdstring是订单ID

返回: OrderDetail

create() ​

创建订单。

ts
k.api.post(() => {
    // 创建购物车并添加商品
    const cartId = k.commerce.cart.create()
    const product = k.commerce.product.create({
        title: 'Order Test Product',
        description: 'Test',
        price: 99.9,
        active: true,
        seoName: 'order-test-' + Date.now(),
        featuredImage: ''
    } as any)
    k.commerce.product.createVariant(product.id, {
        sku: 'ORD-SKU-001',
        price: 99.9,
        inventory: 100,
        barcode: '',
        active: true,
        selectedOptions: []
    } as any)
    const refreshed = k.commerce.product.get(product.id)
    k.commerce.cart.addOrUpdateLine(cartId, refreshed.variants[0].id, 1)

    // 创建订单
    const order = k.commerce.order.create(cartId, {
        address: {
            country: '中国',
            province: '福建省',
            city: '厦门市',
            address1: 'address1',
            address2: '',
            zip: '361000',
            firstName: 'firstName',
            lastName: 'lastName',
            phone: '13800138000',
            isDefault: true
        },
        note: 'test order'
    })
    return { orderId: order.id }
})

参数:

参数类型必填说明
cartIdstring是购物车ID
optionsobject是订单选项
options.addressAddress是收货地址
options.extensionFieldsKeyValue[]否扩展字段
options.notestring否备注
options.scheduledDeliveryTimeDate否预计发货时间

返回: OrderDetail

cancel() ​

取消订单。

ts
k.api.post(() => {
    k.commerce.order.cancel('order-id', 'cancel reason')
    return 'success'
})

参数:

参数类型必填说明
orderIdstring是订单ID
reasonstring是取消原因

返回: void

delete() ​

删除订单。

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

参数:

参数类型必填说明
orderIdstring是订单ID

返回: void

pay() ​

支付订单。

ts
k.api.post(() => {
    k.commerce.order.pay('order-id', 'alipay')
    return 'success'
})

参数:

参数类型必填说明
orderIdstring是订单ID
paymentMethodstring是支付方式

返回: void

delivery() ​

订单发货。

ts
k.api.post(() => {
    const shipping = k.commerce.shipping.list()[0]
    k.commerce.order.delivery('order-id', shipping.id, 'SF123456789')
    return 'success'
})

参数:

参数类型必填说明
orderIdstring是订单ID
shippingCarrierstring是物流公司
trackingNumberstring是物流单号

返回: void

reopen() ​

重新打开已取消的订单。

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

参数:

参数类型必填说明
orderIdstring是订单ID

返回: void

updateAddress() ​

更新订单收货地址。

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

参数:

参数类型必填说明
orderIdstring是订单ID
addressAddress是收货地址

返回: void

updateShippingInfo() ​

更新订单配送信息。

ts
k.api.post(() => {
    const order = k.commerce.order.get('order-id')
    const lineId = order.lines[0].id
    const shipping = k.commerce.shipping.list()[0]

    k.commerce.order.updateShippingInfo('order-id', lineId, {
        shippingCarrier: shipping.id,
        trackingNumber: 'SF123456789'
    })
    return 'success'
})

参数:

参数类型必填说明
orderIdstring是订单ID
orderLineIdstring是订单商品ID
optionsobject是配送选项
options.shippingCarrierstring否物流公司
options.trackingNumberstring否物流单号
options.digitalItemsDigitalOrderItem[]否数字产品

返回: void

结构 ​

OrderDetail 属性 ​

属性说明类型
id订单IDstring
customer顾客信息Customer
pointsDeductionAmount积分扣除金额number
earnPoints赚取积分number
redeemPoints兑换积分number
totalAmount订单总金额number
taxAmount税额number
originalAmount原始金额number
shippingAmount配送金额number
insuranceAmount保险金额number
subtotalAmount小计金额number
originalSubtotalAmount原始小计金额number
totalQuantity总数量number
currency货币string
paid是否已支付boolean
paidAt支付时间Date
paymentMethod支付方式string
delivered是否已发货boolean
partialDelivered是否部分发货boolean
trackingNumber物流单号string
shippingCarrier物流公司string
shippingAt发货时间Date
scheduledDeliveryTime预计发货时间Date
canceled是否已取消boolean
cancelReason取消原因string
cancelAt取消时间Date
createdAt创建时间Date
updatedAt更新时间Date
shippingAddress发货地址Address
note备注string
lines订单商品OrderLine[]
ipIP地址string
country国家string
source来源string
clientInfo客户端信息ClientInfo
extensionButton扩展按钮{ text: string, url: string }
discountAllocations自动折扣信息DiscountAllocation[]
shippingAllocations配送方式列表ShippingAllocation[]
extensionFields扩展字段KeyValue[]

Customer 属性 ​

属性说明类型
id客户IDstring
email客户邮箱string
firstName客户姓名string
lastName客户姓氏string
phone客户电话string

Address 属性 ​

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

OrderLine 属性 ​

属性说明类型
id订单商品IDstring
totalAmount订单商品总金额number
taxAmount订单商品税额number
originalAmount订单商品原始金额number
quantity订单商品数量number
totalQuantity订单商品总数量number
price订单商品价格number
originalPrice订单商品原价number
title订单商品名称string
image订单商品图片string
productId商品IDstring
variantId变体IDstring
sku商品SKUstring
orderId订单IDstring
options商品选项{ name: string, value: string }[]
discountAllocations自动折扣信息DiscountAllocation[]
groupName商品组名称string
isMain是否为主商品boolean
note订单商品备注string
extensionButton扩展按钮{ text: string, url: string }
trackingNumber物流单号string
shippingCarrier物流公司string
shippingAt发货时间Date
delivered是否已发货boolean
digitalItems数字产品列表DigitalOrderItem[]
autoDelivery是否自动发货boolean
isDigital是否为数字产品boolean
maxDownloadCount最大下载次数number
maxDownloadDay最大下载天数number
errorMessage错误信息string

ClientInfo 属性 ​

属性说明类型
platform平台string
oS操作系统string
device设备string
application应用信息ApplicationInfo

ApplicationInfo 属性 ​

属性说明类型
isWebBrowser是否为网页浏览器boolean
name应用名称string
version应用版本string

相关文档 ​