Skip to main content

Zone

Zone​

@vendure/corezone.entity.ts

A Zone is a grouping of one or more Country entities. It is used for calculating applicable shipping and taxes.

Signature
class Zone extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<Zone>)
    @Column() name: string;
    @ManyToMany(type => Region)
    @JoinTable()
    members: Region[];
    @Column(type => CustomZoneFields)
    customFields: CustomZoneFields;
    @OneToMany(type => Channel, country => country.defaultShippingZone)
    defaultShippingZoneChannels: Channel[];
    @OneToMany(type => Channel, country => country.defaultTaxZone)
    defaultTaxZoneChannels: Channel[];
    @OneToMany(type => TaxRate, taxRate => taxRate.zone)
    taxRates: TaxRate[];
}

constructor​

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

name​

property
string

members​

property
Region[]

customFields​

property
CustomZoneFields

defaultShippingZoneChannels​

property
Channel[]

defaultTaxZoneChannels​

property
Channel[]

taxRates​

property
TaxRate[]