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