Skip to main content

CustomerGroup

CustomerGroup​

@vendure/corecustomer-group.entity.ts

A grouping of Customers which enables features such as group-based promotions or tax rules.

Signature
class CustomerGroup extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<CustomerGroup>)
    @Column() name: string;
    @ManyToMany(type => Customer, customer => customer.groups)
    customers: Customer[];
    @Column(type => CustomCustomerGroupFields)
    customFields: CustomCustomerGroupFields;
    @OneToMany(type => TaxRate, taxRate => taxRate.zone)
    taxRates: TaxRate[];
}

constructor​

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

name​

property
string

customers​

property
Customer[]

customFields​

property
CustomCustomerGroupFields

taxRates​

property
TaxRate[]