OrderModification

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()
    note: string;
  @ManyToOne(type => Order, order => order.modifications, { onDelete: 'CASCADE' })
    order: Order;
  @ManyToMany(type => OrderItem)
    @JoinTable()
    orderItems: OrderItem[];
  @OneToMany(type => Surcharge, surcharge => surcharge.orderModification)
    surcharges: Surcharge[];
  @Column()
    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
}

Extends

Members

constructor

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

note

property
type:
string

order

property
type:
Order

orderItems

property
type:
OrderItem[]

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