ShippingLine

@vendure/core Source

A ShippingLine is created when a ShippingMethod is applied to an Order. It contains information about the price of the shipping method, any discounts that were applied, and the resulting tax on the shipping method.

Signature

class ShippingLine extends VendureEntity implements HasCustomFields {    constructor(input?: DeepPartial<ShippingLine>)    @EntityId()    shippingMethodId: ID | null;    @Index()    @ManyToOne(type => ShippingMethod)    shippingMethod: ShippingMethod;    @Index()    @ManyToOne(type => Order, order => order.shippingLines, { onDelete: 'CASCADE' })    order: Order;    @Money()    listPrice: number;    @Column()    listPriceIncludesTax: boolean;    @Column('simple-json')    adjustments: Adjustment[];    @Column('simple-json')    taxLines: TaxLine[];    @OneToMany(type => OrderLine, orderLine => orderLine.shippingLine)    orderLines: OrderLine[];    @Column(type => CustomShippingLineFields)    customFields: CustomShippingLineFields;    price: number    priceWithTax: number    discountedPrice: number    discountedPriceWithTax: number    taxRate: number    discounts: Discount[]    addAdjustment(adjustment: Adjustment) => ;    clearAdjustments() => ;}

Extends: VendureEntity
Implements: HasCustomFields

constructor

method(input?: DeepPartial<ShippingLine>) => ShippingLine

shippingMethodId

propertyID | null

shippingMethod

propertyShippingMethod

order

propertyOrder

listPrice

propertynumber

listPriceIncludesTax

propertyboolean

adjustments

propertyAdjustment[]

taxLines

propertyTaxLine[]

orderLines

propertyOrderLine[]

customFields

propertyCustomShippingLineFields

price

propertynumber

priceWithTax

propertynumber

discountedPrice

propertynumber

discountedPriceWithTax

propertynumber

taxRate

propertynumber

discounts

propertyDiscount[]

addAdjustment

method(adjustment: Adjustment) =>

clearAdjustments

method() =>