Skip to main content

OrderModification

OrderModification​

@vendure/coreorder-modification.entity.ts

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;
    @OneToOne(type => Payment)
    @JoinColumn()
    payment?: Payment;
    @OneToOne(type => Refund)
    @JoinColumn()
    refund?: Refund;
    @Column('simple-json', { nullable: true }) shippingAddressChange: OrderAddress;
    @Column('simple-json', { nullable: true }) billingAddressChange: OrderAddress;
    isSettled: boolean
}

constructor​

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

note​

property
string

order​

property
Order

lines​

property
OrderModificationLine[]

surcharges​

property
Surcharge[]

priceChange​

property
number

payment​

property
Payment

refund​

property
Refund

shippingAddressChange​

property
OrderAddress

billingAddressChange​

property
OrderAddress

isSettled​

property
boolean