Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

6.6 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: LineItem

internal.LineItem

Base abstract entity for all entities

Hierarchy

Properties

adjustments

adjustments: LineItemAdjustment[]

Defined in

packages/medusa/dist/models/line-item.d.ts:20


allow_discounts

allow_discounts: boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:30


beforeInsert

Private beforeInsert: any

Defined in

packages/medusa/dist/models/line-item.d.ts:51


cart

cart: Cart

Defined in

packages/medusa/dist/models/line-item.d.ts:12


cart_id

cart_id: string

Defined in

packages/medusa/dist/models/line-item.d.ts:11


claim_order

claim_order: ClaimOrder

Defined in

packages/medusa/dist/models/line-item.d.ts:18


claim_order_id

claim_order_id: string

Defined in

packages/medusa/dist/models/line-item.d.ts:17


created_at

created_at: Date

Inherited from

BaseEntity.created_at

Defined in

packages/medusa/dist/interfaces/models/base-entity.d.ts:6


description

description: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:25


discount_total

Optional discount_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:48


fulfilled_quantity

fulfilled_quantity: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:37


gift_card_total

Optional gift_card_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:50


has_shipping

has_shipping: null | boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:31


id

id: string

Inherited from

BaseEntity.id

Defined in

packages/medusa/dist/interfaces/models/base-entity.d.ts:5


includes_tax

includes_tax: boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:41


is_giftcard

is_giftcard: boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:28


is_return

is_return: boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:27


metadata

metadata: Record<string, unknown>

Defined in

packages/medusa/dist/models/line-item.d.ts:40


order

order: Order

Defined in

packages/medusa/dist/models/line-item.d.ts:14


order_edit

Optional order_edit: null | OrderEdit

Defined in

packages/medusa/dist/models/line-item.d.ts:23


order_edit_id

Optional order_edit_id: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:22


order_id

order_id: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:13


original_item_id

Optional original_item_id: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:21


original_tax_total

Optional original_tax_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:47


original_total

Optional original_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:46


product_id

product_id: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:35


quantity

quantity: number

Defined in

packages/medusa/dist/models/line-item.d.ts:36


raw_discount_total

Optional raw_discount_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:49


refundable

Optional refundable: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:42


returned_quantity

returned_quantity: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:38


shipped_quantity

shipped_quantity: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:39


should_merge

should_merge: boolean

Defined in

packages/medusa/dist/models/line-item.d.ts:29


subtotal

Optional subtotal: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:43


swap

swap: Swap

Defined in

packages/medusa/dist/models/line-item.d.ts:16


swap_id

swap_id: string

Defined in

packages/medusa/dist/models/line-item.d.ts:15


tax_lines

tax_lines: LineItemTaxLine[]

Defined in

packages/medusa/dist/models/line-item.d.ts:19


tax_total

Optional tax_total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:44


thumbnail

thumbnail: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:26


title

title: string

Defined in

packages/medusa/dist/models/line-item.d.ts:24


total

Optional total: null | number

Defined in

packages/medusa/dist/models/line-item.d.ts:45


unit_price

unit_price: number

Defined in

packages/medusa/dist/models/line-item.d.ts:32


updated_at

updated_at: Date

Inherited from

BaseEntity.updated_at

Defined in

packages/medusa/dist/interfaces/models/base-entity.d.ts:7


variant

variant: ProductVariant

Defined in

packages/medusa/dist/models/line-item.d.ts:34


variant_id

variant_id: null | string

Defined in

packages/medusa/dist/models/line-item.d.ts:33

Methods

afterUpdateOrLoad

afterUpdateOrLoad(): void

Returns

void

Defined in

packages/medusa/dist/models/line-item.d.ts:53


beforeUpdate

beforeUpdate(): void

Returns

void

Defined in

packages/medusa/dist/models/line-item.d.ts:52