Skip to main content

Class: LineItem

Hierarchy

  • BaseEntity

    LineItem

Constructors

constructor

new LineItem()

Inherited from

BaseEntity.constructor

Properties

adjustments

adjustments: LineItemAdjustment[]

Defined in

models/line-item.ts:85


allow_discounts

allow_discounts: boolean

Defined in

models/line-item.ts:127


cart

cart: Cart

Defined in

models/line-item.ts:53


cart_id

cart_id: string

Defined in

models/line-item.ts:49


claim_order

claim_order: ClaimOrder

Defined in

models/line-item.ts:77


claim_order_id

claim_order_id: string

Defined in

models/line-item.ts:73


created_at

created_at: Date

Inherited from

BaseEntity.created_at

Defined in

interfaces/models/base-entity.ts:16


description

description: string

Defined in

models/line-item.ts:112


discount_total

Optional discount_total: null | number

Defined in

models/line-item.ts:167


fulfilled_quantity

fulfilled_quantity: number

Defined in

models/line-item.ts:147


gift_card_total

Optional gift_card_total: null | number

Defined in

models/line-item.ts:168


has_shipping

has_shipping: boolean

Defined in

models/line-item.ts:130


id

id: string

Inherited from

BaseEntity.id

Defined in

interfaces/models/base-entity.ts:13


includes_tax

includes_tax: boolean

Defined in

models/line-item.ts:159


is_giftcard

is_giftcard: boolean

Defined in

models/line-item.ts:121


is_return

is_return: boolean

Defined in

models/line-item.ts:118


metadata

metadata: Record<string, unknown>

Defined in

models/line-item.ts:156


order

order: Order

Defined in

models/line-item.ts:61


order_edit

Optional order_edit: null | OrderEdit

Defined in

models/line-item.ts:106


order_edit_id

Optional order_edit_id: null | string

Defined in

models/line-item.ts:97


order_id

order_id: null | string

Defined in

models/line-item.ts:57


original_item_id

Optional original_item_id: null | string

Defined in

models/line-item.ts:91


original_tax_total

Optional original_tax_total: null | number

Defined in

models/line-item.ts:166


original_total

Optional original_total: null | number

Defined in

models/line-item.ts:165


quantity

quantity: number

Defined in

models/line-item.ts:144


refundable

Optional refundable: null | number

Defined in

models/line-item.ts:161


returned_quantity

returned_quantity: number

Defined in

models/line-item.ts:150


shipped_quantity

shipped_quantity: number

Defined in

models/line-item.ts:153


should_merge

should_merge: boolean

Defined in

models/line-item.ts:124


subtotal

Optional subtotal: null | number

Defined in

models/line-item.ts:162


swap

swap: Swap

Defined in

models/line-item.ts:69


swap_id

swap_id: string

Defined in

models/line-item.ts:65


tax_lines

tax_lines: LineItemTaxLine[]

Defined in

models/line-item.ts:80


tax_total

Optional tax_total: null | number

Defined in

models/line-item.ts:163


thumbnail

thumbnail: null | string

Defined in

models/line-item.ts:115


title

title: string

Defined in

models/line-item.ts:109


total

Optional total: null | number

Defined in

models/line-item.ts:164


unit_price

unit_price: number

Defined in

models/line-item.ts:133


updated_at

updated_at: Date

Inherited from

BaseEntity.updated_at

Defined in

interfaces/models/base-entity.ts:19


variant

variant: ProductVariant

Defined in

models/line-item.ts:141


variant_id

variant_id: string

Defined in

models/line-item.ts:137

Methods

beforeInsert

Private beforeInsert(): void

Returns

void

Defined in

models/line-item.ts:170