Entity representing an order

Hierarchy

  • BaseMongoEntity
    • OrderEntity

Implements

Constructors

Properties

cancelReason: null | CancelReason

Reason for the order being canceled (null if not cancelled)

canceledAt: null | Date

Date the order was canceled (null if not canceled)

cartId?: string

Unique identifier for the cart this order is linked to

checkoutId?: string

Unique identifier for the checkout this order is linked to

closedAt: null | Date

Date the order was closed (null if not closed)

customFields?: Record<string, unknown>

Custom fields for the order

customer: Customer

Customer info for the order

lineItems: LineItem[]

List of line items in the order

organizationId: string

Unique identifier for the organization this order is linked to

status: Status

Status of the order

subtotalPrice: number

Subtotal price for the order

totalPrice: number

Total price for the order (subtotal + tax)

totalTax: number

Total tax for the order

Generated using TypeDoc