Order

@vendure/core Source

An Order is created whenever a Customer adds an item to the cart. It contains all the information required to fulfill an order: which ProductVariants in what quantities; the shipping address and price; any applicable promotions; payments etc.

An Order exists in a well-defined state according to the OrderState type. A state machine is used to govern the transition from one state to another.

Signature

class Order extends VendureEntity implements ChannelAware, HasCustomFields {    constructor(input?: DeepPartial<Order>)    @Column('varchar', { default: OrderType.Regular })    type: OrderType;    @OneToMany(type => Order, sellerOrder => sellerOrder.aggregateOrder)    sellerOrders: Order[];    @Index()    @ManyToOne(type => Order, aggregateOrder => aggregateOrder.sellerOrders)    aggregateOrder?: Order;    @EntityId({ nullable: true })    aggregateOrderId?: ID;    @Column()    @Index({ unique: true })    code: string;    @Column('varchar') state: OrderState;    @Column({ default: true })    active: boolean;    @Column({ nullable: true })    @Index()    orderPlacedAt?: Date;    @Column({ nullable: true, precision: 6 })    pricingUpdatedAt?: Date;    @Index()    @ManyToOne(type => Customer, customer => customer.orders)    customer?: Customer;    @EntityId({ nullable: true })    customerId?: ID;    @OneToMany(type => OrderLine, line => line.order)    lines: OrderLine[];    @OneToMany(type => Surcharge, surcharge => surcharge.order)    surcharges: Surcharge[];    @Column('simple-array')    couponCodes: string[];    @ManyToMany(type => Promotion, promotion => promotion.orders)    @JoinTable()    promotions: Promotion[];    @Column('simple-json') shippingAddress: OrderAddress;    @Column('simple-json') billingAddress: OrderAddress;    @OneToMany(type => Payment, payment => payment.order)    payments: Payment[];    @ManyToMany(type => Fulfillment, fulfillment => fulfillment.orders)    @JoinTable()    fulfillments: Fulfillment[];    @Column('varchar')    currencyCode: CurrencyCode;    @Column(type => CustomOrderFields)    customFields: CustomOrderFields;    @EntityId({ nullable: true })    taxZoneId?: ID;    @ManyToMany(type => Channel)    @JoinTable()    channels: Channel[];    @OneToMany(type => OrderModification, modification => modification.order)    modifications: OrderModification[];    @Money()    subTotal: number;    @Money()    subTotalWithTax: number;    @OneToMany(type => ShippingLine, shippingLine => shippingLine.order)    shippingLines: ShippingLine[];    @Money({ default: 0 })    shipping: number;    @Money({ default: 0 })    shippingWithTax: number;    discounts: Discount[]    total: number    totalWithTax: number    totalQuantity: number    taxSummary: OrderTaxSummary[]}

Order

An Order exists in a well-defined state according to the OrderState type. A state machine is used to govern the transition from one state to another.

Signature

class Order extends VendureEntity implements ChannelAware, HasCustomFields {    constructor(input?: DeepPartial<Order>)    @Column('varchar', { default: OrderType.Regular })    type: OrderType;    @OneToMany(type => Order, sellerOrder => sellerOrder.aggregateOrder)    sellerOrders: Order[];    @Index()    @ManyToOne(type => Order, aggregateOrder => aggregateOrder.sellerOrders)    aggregateOrder?: Order;    @EntityId({ nullable: true })    aggregateOrderId?: ID;    @Column()    @Index({ unique: true })    code: string;    @Column('varchar') state: OrderState;    @Column({ default: true })    active: boolean;    @Column({ nullable: true })    @Index()    orderPlacedAt?: Date;    @Column({ nullable: true, precision: 6 })    pricingUpdatedAt?: Date;    @Index()    @ManyToOne(type => Customer, customer => customer.orders)    customer?: Customer;    @EntityId({ nullable: true })    customerId?: ID;    @OneToMany(type => OrderLine, line => line.order)    lines: OrderLine[];    @OneToMany(type => Surcharge, surcharge => surcharge.order)    surcharges: Surcharge[];    @Column('simple-array')    couponCodes: string[];    @ManyToMany(type => Promotion, promotion => promotion.orders)    @JoinTable()    promotions: Promotion[];    @Column('simple-json') shippingAddress: OrderAddress;    @Column('simple-json') billingAddress: OrderAddress;    @OneToMany(type => Payment, payment => payment.order)    payments: Payment[];    @ManyToMany(type => Fulfillment, fulfillment => fulfillment.orders)    @JoinTable()    fulfillments: Fulfillment[];    @Column('varchar')    currencyCode: CurrencyCode;    @Column(type => CustomOrderFields)    customFields: CustomOrderFields;    @EntityId({ nullable: true })    taxZoneId?: ID;    @ManyToMany(type => Channel)    @JoinTable()    channels: Channel[];    @OneToMany(type => OrderModification, modification => modification.order)    modifications: OrderModification[];    @Money()    subTotal: number;    @Money()    subTotalWithTax: number;    @OneToMany(type => ShippingLine, shippingLine => shippingLine.order)    shippingLines: ShippingLine[];    @Money({ default: 0 })    shipping: number;    @Money({ default: 0 })    shippingWithTax: number;    discounts: Discount[]    total: number    totalWithTax: number    totalQuantity: number    taxSummary: OrderTaxSummary[]}