Skip to main content

VendureConfig

All possible configuration options are defined by the VendureConfig interface.

Signature

apiOptions

propertyApiOptions

Configuration for the GraphQL APIs, including hostname, port, CORS settings, middleware etc.

assetOptions

propertyAssetOptions

Configuration for the handling of Assets.

authOptions

propertyAuthOptions

Configuration for authorization.

catalogOptions

Configuration for Products and Collections.

customFields

propertyCustomFields
Default:{}

Defines custom fields which can be used to extend the built-in entities.

settingsStoreFields

propertySettingsStoreFieldsv3.4.0

Defines key-value fields that can be set and read via the getKeyValue/setKeyValue GraphQL APIs and via the SettingsStoreService. These differ from custom fields in that they are not associated with a specific entity, but can be scoped globally or to a specific user etc, and defining them does not require any changes to the database schema.

dbConnectionOptions

propertyDataSourceOptions

The connection options used by TypeORM to connect to the database. See the TypeORM documentation for a full description of all available options.

defaultChannelToken

propertystring | null
Default:null

The token for the default channel. If not specified, a token will be randomly generated.

defaultLanguageCode

propertyLanguageCode
Default:<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>.en

The default languageCode of the app.

entityIdStrategy

propertyEntityIdStrategy<any>
Default:<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>

Defines the strategy used for both storing the primary keys of entities in the database, and the encoding & decoding of those ids when exposing entities via the API. The default uses a simple auto-increment integer strategy.

entityOptions

importExportOptions

Configuration settings for data import and export.

orderOptions

propertyOrderOptions

Configuration settings governing how orders are handled.

paymentOptions

Configures available payment processing methods.

plugins

propertyArray<DynamicModule | Type<any>>
Default:[]

An array of plugins.

promotionOptions

Configures the Conditions and Actions available when creating Promotions.

shippingOptions

Configures the available checkers and calculators for ShippingMethods.

logger

Default:<a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a>

Provide a logging service which implements the VendureLogger interface. Note that the logging of SQL queries is controlled separately by the dbConnectionOptions.logging property.

taxOptions

propertyTaxOptions

Configures how taxes are calculated on products.

jobQueueOptions

Configures how the job queue is persisted and processed.

schedulerOptions

propertySchedulerOptionsv3.3.0

Configures the scheduler mechanism and tasks.

systemOptions

propertySystemOptionsv1.6.0

Configures system options

Was this chapter helpful?
Report Issue
Edited Feb 25, 2026ยทEdit this page