***

title: "OrderLine"
generated: true
---------------

<GenerationInfo sourceFile="packages/core/src/entity/order-line/order-line.entity.ts" sourceLine="32" packageName="@vendure/core" />

A single line on an [Order](/current/core/reference/typescript-api/entities/order#order) which contains information about the [ProductVariant](/current/core/reference/typescript-api/entities/product-variant#productvariant) and
quantity ordered, as well as the price and tax information.

```ts title="Signature"
class OrderLine extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<OrderLine>)
    @Index()
    @ManyToOne(type => Channel, { nullable: true, onDelete: 'SET NULL' })
    sellerChannel?: Channel;
    @EntityId({ nullable: true })
    sellerChannelId?: ID;
    @Index()
    @ManyToOne(type => ShippingLine, shippingLine => shippingLine.orderLines, {
        nullable: true,
        onDelete: 'SET NULL',
    })
    shippingLine?: ShippingLine;
    @EntityId({ nullable: true })
    shippingLineId?: ID;
    @Index()
    @ManyToOne(type => ProductVariant, productVariant => productVariant.lines, { onDelete: 'CASCADE' })
    productVariant: ProductVariant;
    @EntityId()
    productVariantId: ID;
    @Index()
    @ManyToOne(type => TaxCategory)
    taxCategory: TaxCategory;
    @EntityId({ nullable: true })
    taxCategoryId: ID;
    @Index()
    @ManyToOne(type => Asset, asset => asset.featuredInVariants, { onDelete: 'SET NULL' })
    featuredAsset: Asset;
    @Index()
    @ManyToOne(type => Order, order => order.lines, { onDelete: 'CASCADE' })
    order: Order;
    @OneToMany(type => OrderLineReference, lineRef => lineRef.orderLine)
    linesReferences: OrderLineReference[];
    @OneToMany(type => Sale, sale => sale.orderLine)
    sales: Sale[];
    @Column()
    quantity: number;
    @Column({ default: 0 })
    orderPlacedQuantity: number;
    @Money({ nullable: true })
    initialListPrice: number;
    @Money()
    listPrice: number;
    @Column()
    listPriceIncludesTax: boolean;
    @Column('simple-json')
    adjustments: Adjustment[];
    @Column('simple-json')
    taxLines: TaxLine[];
    @OneToMany(type => Cancellation, cancellation => cancellation.orderLine)
    cancellations: Cancellation[];
    @OneToMany(type => Allocation, allocation => allocation.orderLine)
    allocations: Allocation[];
    @Column(type => CustomOrderLineFields)
    customFields: CustomOrderLineFields;
    unitPrice: number
    unitPriceWithTax: number
    unitPriceChangeSinceAdded: number
    unitPriceWithTaxChangeSinceAdded: number
    discountedUnitPrice: number
    discountedUnitPriceWithTax: number
    proratedUnitPrice: number
    proratedUnitPriceWithTax: number
    unitTax: number
    proratedUnitTax: number
    taxRate: number
    linePrice: number
    linePriceWithTax: number
    discountedLinePrice: number
    discountedLinePriceWithTax: number
    discounts: Discount[]
    lineTax: number
    proratedLinePrice: number
    proratedLinePriceWithTax: number
    proratedLineTax: number
    addAdjustment(adjustment: Adjustment) => ;
    clearAdjustments(type?: AdjustmentType) => ;
}
```

* Extends: [`VendureEntity`](/current/core/reference/typescript-api/entities/vendure-entity#vendureentity)

* Implements: HasCustomFields

<div className="members-wrapper">

### sellerChannel

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/channel#channel'>Channel</a>`}   />

The [Channel](/current/core/reference/typescript-api/entities/channel#channel) of the [Seller](/current/core/reference/typescript-api/entities/seller#seller) for a multivendor setup.

### sellerChannelId

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/common/id#id'>ID</a>`}   />

### shippingLine

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`}   />

The [ShippingLine](/current/core/reference/typescript-api/entities/shipping-line#shippingline) to which this line has been assigned.
This is determined by the configured [ShippingLineAssignmentStrategy](/current/core/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy).

### shippingLineId

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/common/id#id'>ID</a>`}   />

### productVariant

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`}   />

The [ProductVariant](/current/core/reference/typescript-api/entities/product-variant#productvariant) which is being ordered.

### productVariantId

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/common/id#id'>ID</a>`}   />

### taxCategory

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>`}   />

### taxCategoryId

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/common/id#id'>ID</a>`}   />

### featuredAsset

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/asset#asset'>Asset</a>`}   />

### order

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/order#order'>Order</a>`}   />

### linesReferences

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/order-line-reference#orderlinereference'>OrderLineReference</a>[]`}   />

### sales

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/stock-movement#sale'>Sale</a>[]`}   />

### quantity

\<MemberInfo kind="property" type={`number`}   />

### orderPlacedQuantity

\<MemberInfo kind="property" type={`number`}   />

The quantity of this OrderLine at the time the order was placed (as per the [OrderPlacedStrategy](/current/core/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy)).

### initialListPrice

\<MemberInfo kind="property" type={`number`}   />

The price as calculated when the OrderLine was first added to the Order. Usually will be identical to the
`listPrice`, except when the ProductVariant price has changed in the meantime and a re-calculation of
the Order has been performed.

### listPrice

\<MemberInfo kind="property" type={`number`}   />

This is the price as listed by the ProductVariant (and possibly modified by the [OrderItemPriceCalculationStrategy](/current/core/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy)),
which, depending on the current Channel, may or may not include tax.

### listPriceIncludesTax

\<MemberInfo kind="property" type={`boolean`}   />

Whether the listPrice includes tax, which depends on the settings of the current Channel.

### adjustments

\<MemberInfo kind="property" type={`Adjustment[]`}   />

### taxLines

\<MemberInfo kind="property" type={`TaxLine[]`}   />

### cancellations

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>[]`}   />

### allocations

\<MemberInfo kind="property" type={`<a href='/current/core/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]`}   />

### customFields

\<MemberInfo kind="property" type={`CustomOrderLineFields`}   />

### unitPrice

\<MemberInfo kind="property" type={`number`}   />

The price of a single unit, excluding tax and discounts.

### unitPriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The price of a single unit, including tax but excluding discounts.

### unitPriceChangeSinceAdded

\<MemberInfo kind="property" type={`number`}   />

Non-zero if the `unitPrice` has changed since it was initially added to Order.

### unitPriceWithTaxChangeSinceAdded

\<MemberInfo kind="property" type={`number`}   />

Non-zero if the `unitPriceWithTax` has changed since it was initially added to Order.

### discountedUnitPrice

\<MemberInfo kind="property" type={`number`}   />

The price of a single unit including discounts, excluding tax.

If Order-level discounts have been applied, this will not be the
actual taxable unit price (see `proratedUnitPrice`), but is generally the
correct price to display to customers to avoid confusion
about the internal handling of distributed Order-level discounts.

### discountedUnitPriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The price of a single unit including discounts and tax

### proratedUnitPrice

\<MemberInfo kind="property" type={`number`}   />

The actual unit price, taking into account both item discounts *and* prorated (proportionally-distributed)
Order-level discounts. This value is the true economic value of a single unit in this OrderLine, and is used in tax
and refund calculations.

### proratedUnitPriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The `proratedUnitPrice` including tax.

### unitTax

\<MemberInfo kind="property" type={`number`}   />

### proratedUnitTax

\<MemberInfo kind="property" type={`number`}   />

### taxRate

\<MemberInfo kind="property" type={`number`}   />

### linePrice

\<MemberInfo kind="property" type={`number`}   />

The total price of the line excluding tax and discounts.

### linePriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The total price of the line including tax but excluding discounts.

### discountedLinePrice

\<MemberInfo kind="property" type={`number`}   />

The price of the line including discounts, excluding tax.

### discountedLinePriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The price of the line including discounts and tax.

### discounts

\<MemberInfo kind="property" type={`Discount[]`}   />

### lineTax

\<MemberInfo kind="property" type={`number`}   />

The total tax on this line.

### proratedLinePrice

\<MemberInfo kind="property" type={`number`}   />

The actual line price, taking into account both item discounts *and* prorated (proportionally-distributed)
Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
and refund calculations.

### proratedLinePriceWithTax

\<MemberInfo kind="property" type={`number`}   />

The `proratedLinePrice` including tax.

### proratedLineTax

\<MemberInfo kind="property" type={`number`}   />

### addAdjustment

\<MemberInfo kind="method" type={`(adjustment: Adjustment) => `}   />

### clearAdjustments

\<MemberInfo kind="method" type={`(type?: AdjustmentType) => `}   />

</div>