OrderModification

@vendure/core Source

An entity which represents a modification to an order which has been placed, and then modified afterwards by an administrator.

Signature

class OrderModification extends VendureEntity {    constructor(input?: DeepPartial<OrderModification>)    @Column()    note: string;    @Index()    @ManyToOne(type => Order, order => order.modifications, { onDelete: 'CASCADE' })    order: Order;    @OneToMany(type => OrderModificationLine, line => line.modification)    lines: OrderModificationLine[];    @OneToMany(type => Surcharge, surcharge => surcharge.orderModification)    surcharges: Surcharge[];    @Money()    priceChange: number;    @ManyToOne(type => Payment)    @JoinColumn()    payment?: Payment;    @ManyToOne(type => Refund)    @JoinColumn()    refund?: Refund;    @Column('simple-json', { nullable: true }) shippingAddressChange: OrderAddress;    @Column('simple-json', { nullable: true }) billingAddressChange: OrderAddress;    isSettled: boolean}

Extends: VendureEntity

constructor

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

note

propertystring

order

propertyOrder

lines

propertyOrderModificationLine[]

surcharges

propertySurcharge[]

priceChange

propertynumber

payment

propertyPayment

refund

propertyRefund

shippingAddressChange

propertyOrderAddress

billingAddressChange

propertyOrderAddress

isSettled

propertyboolean