Skip to main content

Fulfillment

Fulfillment​

@vendure/corefulfillment.entity.ts

This entity represents a fulfillment of an Order or part of it, i.e. which OrderLines have been delivered to the Customer after successful payment.

Signature
class Fulfillment extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<Fulfillment>)
    @Column('varchar') state: FulfillmentState;
    @Column({ default: '' })
    trackingCode: string;
    @Column()
    method: string;
    @Column()
    handlerCode: string;
    @OneToMany(type => FulfillmentLine, fulfillmentLine => fulfillmentLine.fulfillment)
    lines: FulfillmentLine[];
    @ManyToMany(type => Order, order => order.fulfillments)
    orders: Order[];
    @Column(type => CustomFulfillmentFields)
    customFields: CustomFulfillmentFields;
}

constructor​

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

state​

property
FulfillmentState

trackingCode​

property
string

method​

property
string

handlerCode​

property
string

lines​

property
FulfillmentLine[]

orders​

property
Order[]

customFields​

property
CustomFulfillmentFields