A single line on an Order which contains information about the ProductVariant and quantity ordered, as well as the price and tax information.
Extends: VendureEntity
Implements: HasCustomFields
ChannelThe Channel of the Seller for a multivendor setup.
IDShippingLineThe ShippingLine to which this line has been assigned. This is determined by the configured ShippingLineAssignmentStrategy.
IDProductVariantThe ProductVariant which is being ordered.
IDTaxCategoryIDAssetOrderOrderLineReference[]Sale[]numbernumberThe quantity of this OrderLine at the time the order was placed (as per the OrderPlacedStrategy).
numberThe 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.
numberThis is the price as listed by the ProductVariant (and possibly modified by the OrderItemPriceCalculationStrategy), which, depending on the current Channel, may or may not include tax.
booleanWhether the listPrice includes tax, which depends on the settings of the current Channel.
Adjustment[]TaxLine[]Cancellation[]Allocation[]CustomOrderLineFieldsnumberThe price of a single unit, excluding tax and discounts.
numberThe price of a single unit, including tax but excluding discounts.
numberNon-zero if the unitPrice has changed since it was initially added to Order.
numberNon-zero if the unitPriceWithTax has changed since it was initially added to Order.
numberThe 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.
numberThe price of a single unit including discounts and tax
numberThe 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.
numberThe proratedUnitPrice including tax.
numbernumbernumbernumberThe total price of the line excluding tax and discounts.
numberThe total price of the line including tax but excluding discounts.
numberThe price of the line including discounts, excluding tax.
numberThe price of the line including discounts and tax.
Discount[]numberThe total tax on this line.
numberThe 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.
numberThe proratedLinePrice including tax.
number(adjustment: Adjustment) => (newQuantity: number) => Sets this line's quantity to newQuantity, rescaling its PROMOTION-type adjustments to
match. Used where a quantity reduction bypasses OrderCalculator recalculation (see
OrderModifier.cancelOrderByOrderLines()), to preserve the invariant that PROMOTION
amounts are stored scaled to the current quantity.
A newQuantity of 0 sets the quantity but leaves the adjustments untouched: the getters
short-circuit on an empty line either way, so scaling them to zero would only erase the
record of the discount that had applied, which plugins and accounting exports read back.
(type?: AdjustmentType) => Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team