Skip to main content
Report Bug
Getting Started
Guides
Reference
Plugins
Community
How to use
Search docs...
Ctrl
K
8.5k
v3.8.0 (Current)
▼
v3.8.0 (Current)
▼
Getting Started
Installation
Introducing GraphQL
Try the API
Core Concepts
Overview
Pricing
Products
Promotions
Assets
Search
Facets & Filters
Collections
Cart
Payment
Customers
Orders
Fulfillment
Inventory
Currency
Zones
Language
Taxes
User Management
Roles
Permissions
Job Queue
Healthchecks
Auth
Channels
Email
Shipping
Developer Guide
Overview
The API Layer
The Service Layer
CLI
AI-assisted Development
Configuration
Custom Fields
Error Handling
Events
Migrations
Plugins
Security
API Keys
Strategies & Configurable Operations
Testing
Updating
Worker & Job Queue
Settings Store
REST Endpoint
Custom Permissions
Database Entity
Extend GraphQL API
Custom Strategies in Plugins
Channel Aware
Translatable
Has Custom Fields
Cache
Dataloaders
DB Subscribers
Importing Data
Logging
Scheduled Tasks
Stand-alone Scripts
Translations
Uploading Files
Nest DevTools
Telemetry
How-to Guides
CMS Integration Plugin
Codegen
Configurable Products
Digital Products
GitHub OAuth Authentication
Google OAuth Authentication
Multi-vendor Marketplaces
Paginated List
Publish Plugin
S3 Asset Storage
Telemetry
React Admin Dashboard
Getting Started
Extending Overview
Public API & Imports
Creating Pages
List Pages
Detail Pages
Tabbed Pages
Customizing Pages
Customizing List Pages
Customizing Detail Pages
Customizing Login Page
Page Blocks
Action Bar Items
Toolbar Items
Extension Targets
Insights Widgets
History Entries
Customizing Forms
Input Component Examples
Relation Selector Components
Navigation
Alerts
Data Fetching
Theming
Localization
Deployment
Tech Stack
Migration
Custom Providers
Building a Storefront
Storefront Starters
Connect API
Codegen
Navigation Menu
Listing Products
Product Detail
Active Order
Checkout Flow
Customer Accounts
Deployment
Overview
Production Configuration
Using Docker
Horizontal Scaling
Getting Data into Production
Server Resource Requirements
Deploying Admin UI
Deploy to Northflank
Deploy to Digital Ocean App Platform
Deploy to Railway
Deploy to Render
Deploy to Google Cloud Run
MCP Server
Quick Start
OAuth & Consent
Assistant inside Vendure
Assistant outside Vendure
Registering Custom Tools
Production Hardening
Logging & Observability
Administration
Built-in Tool Reference
OAuth Protocol Reference
Reference
Overview
TypeScript API
Assets
AssetNamingStrategy
AssetOptions
AssetPreviewStrategy
AssetStorageStrategy
DefaultAssetNamingStrategy
StoredMediaUpload
Auth
ApiKeyStrategy
AuthenticationStrategy
AuthOptions
BcryptPasswordHashingStrategy
CookieOptions
CustomerChannelAssignmentStrategy
DefaultPasswordValidationStrategy
DefaultSessionCacheStrategy
DefaultVerificationTokenStrategy
EntityAccessControlStrategy
ExternalAuthenticationService
InMemorySessionCacheStrategy
NativeAuthenticationStrategy
NoopSessionCacheStrategy
PasswordHashingStrategy
PasswordValidationStrategy
PermissionDefinition
SessionCacheStrategy
SuperadminCredentials
VerificationTokenStrategy
Cache
CacheConfig
CacheService
CacheStrategy
DefaultCachePlugin
RedisCachePlugin
RedisCacheStrategy
RequestContextCacheService
SelfRefreshingCache
SqlCacheStrategy
Common
AsyncQueue
Bootstrap
CurrencyCode
EntityRelationPaths
I18nService
ID
InjectableStrategy
Injector
JobState
JsonCompatible
LanguageCode
Middleware
PaginatedList
Permission
PriceCalculationResult
ProcessContext
VENDURE_VERSION
Admin Ui
AdminUiAppConfig
AdminUiAppDevModeConfig
AdminUiConfig
ConfigurableOperationDef
ConfigArgs
ConfigArgType
ConfigurableOperationDefOptions
ConfigurableOperationDefType
ConfigurableOperationTranslationKey
ConfigurableOperationTranslator
DefaultFormComponentId
DefaultFormConfigHash
LocalizedStringArray
Configuration
ApiOptions
CollectionFilter
DefaultConfig
DefaultSlugStrategy
EncryptionStrategy
EntityDuplicator
EntityId Decorator
EntityIdStrategy
EntityOptions
MergeConfig
ProductVariantPriceSelectionStrategy
ProductVariantPriceUpdateStrategy
RuntimeVendureConfig
SecretAccessStrategy
SettingsStoreFields
SlugStrategy
SystemOptions
TrustProxyOptions
VendureConfig
CustomFields
CustomFieldConfig
CustomFieldType
IsLocalizedCustomFieldType
StructCustomFieldConfig
StructFieldConfig
TypedCustomSingleFieldConfig
ValidateCustomFieldValue
Data Access
Calculated
CalculatedPropertySubscriber
DataSourceHolder
EntityHydrator
FindOptionsArrayToObject
FindOptionsRelationsInput
FindOptionsSelectInput
GetDatabaseType
GetDataSource
GetEntityOrThrowOptions
HydrateOptions
ListQueryBuilder
ToTypeOrmFindOptions
TransactionalConnection
TypeOrmFindOptions
VendureDatabaseType
VendureFindManyOptions
VendureFindOneOptions
DefaultSearchPlugin
DefaultSearchPluginInitOptions
MysqlSearchStrategy
PostgresSearchStrategy
SearchStrategy
SqliteSearchStrategy
Entities
Address
Administrator
AnonymousSession
ApiKey
Asset
AuthenticatedSession
AuthenticationMethod
Channel
Collection
Country
Customer
CustomerGroup
CustomerHistoryEntry
Facet
FacetValue
Fulfillment
GlobalSettings
HistoryEntry
Interfaces
Order
OrderableAsset
OrderHistoryEntry
OrderLine
OrderLineReference
OrderModification
Payment
PaymentMethod
Product
ProductOption
ProductOptionGroup
ProductVariant
ProductVariantPrice
Promotion
Province
Refund
Region
Role
Seller
Session
SettingsStoreEntry
ShippingLine
ShippingMethod
StockLevel
StockLocation
StockMovement
Surcharge
Tag
TaxCategory
TaxRate
User
VendureEntity
Zone
Errors
Error Types
ErrorHandlerStrategy
ErrorResultUnion
I18nError
IsGraphQlErrorResult
Events
BlockingEventHandlerOptions
Event Types
EventBus
VendureEntityEvent
VendureEvent
Fulfillment
FulfillmentHandler
FulfillmentProcess
FulfillmentState
FulfillmentStates
FulfillmentTransitionData
Health Check
HealthCheckError
HealthCheckRegistryService
HealthCheckStrategy
HealthIndicator
HealthIndicatorFunction
HealthIndicatorResult
HealthIndicatorStatus
HttpHealthCheckStrategy
TypeORMHealthCheckStrategy
Import Export
AssetImporter
AssetImportStrategy
DefaultAssetImportStrategy
DefaultAssetImportStrategyOptions
FastImporterService
Importer
ImportExportOptions
ImportParser
InitialData
Populate
Populator
JobQueue
DefaultJobQueuePlugin
InMemoryJobBufferStorageStrategy
InMemoryJobQueueStrategy
InspectableJobQueueStrategy
Job
JobBuffer
JobBufferStorageStrategy
JobQueueOptions
JobQueueService
JobQueueStrategy
PollingJobQueueStrategy
SqlJobQueueStrategy
SubscribableJob
Types
Logger
DefaultLogger
LogLevel
VendureLogger
Migration
DeduplicateTranslations
GenerateMigration
MigrateAssetTranslationData
MigrateProductOptionGroupData
MigrationDiagnostic
MigrationOptions
RescaleOrderLinePromotionAdjustments
RevertLastMigration
RunMigrations
RunMigrationsOptions
TranslationTableColumnNames
TranslationTableToDeduplicate
Money
BigIntMoneyStrategy
DefaultMoneyStrategy
Money Decorator
MoneyStrategy
RoundMoney
Orders
ActiveOrderService
ActiveOrderStrategy
ChangedPriceHandlingStrategy
CustomOrderStates
DefaultActiveOrderStrategy
DefaultGuestCheckoutStrategy
DefaultOrderItemPriceCalculationStrategy
DefaultOrderPlacedStrategy
DefaultStockAllocationStrategy
GuestCheckoutStrategy
Merge Strategies
OrderByCodeAccessStrategy
OrderCodeStrategy
OrderInterceptor
OrderItemPriceCalculationStrategy
OrderLineDiscountDistributionStrategy
OrderMergeStrategy
OrderOptions
OrderPlacedStrategy
OrderProcess
OrderRecalculationStrategy
OrderSellerStrategy
StockAllocationStrategy
Payment
DefaultPaymentProcess
DefaultRefundProcess
DummyPaymentHandler
Payment Method Types
PaymentMethodConfigOptions
PaymentMethodEligibilityChecker
PaymentMethodHandler
PaymentOptions
PaymentProcess
PaymentState
PaymentStates
PaymentTransitionData
RefundDestinationStrategy
RefundProcess
RefundState
RefundStates
RefundTransitionData
Plugin
Plugin Utilities
PluginCommonModule
VendurePlugin
VendurePluginMetadata
Products Stock
CatalogOptions
DefaultProductVariantPriceCalculationStrategy
DefaultStockDisplayStrategy
DefaultStockLocationStrategy
MultiChannelStockLocationStrategy
ProductVariantPriceCalculationStrategy
StockDisplayStrategy
StockLocationStrategy
Promotions
FacetValueChecker
Promotion Action
Promotion Condition
PromotionOptions
Request
Allow Decorator
Api Decorator
ApiType
Ctx Decorator
DeserializedCachedSession
Relations Decorator
RequestContext
RequestContextService
Transaction Decorator
Scheduled Tasks
CleanSessionsTask
DefaultSchedulerPlugin
DefaultSchedulerStrategy
ScheduledTask
SchedulerOptions
SchedulerService
SchedulerStrategy
Service Helpers
EntityDuplicatorService
OrderCalculator
OrderModifier
ProductPriceApplicator
SlugValidator
TranslatableSaver
TranslatorService
Services
AdministratorService
AssetService
AuthService
ChannelService
CollectionService
CountryService
CustomerChannelAssignmentService
CustomerGroupService
CustomerService
EntitySlugService
FacetService
FacetValueService
FulfillmentService
GlobalSettingsService
HistoryService
InitializerService
OrderService
OrderTestingService
PaymentMethodService
PaymentService
ProductOptionGroupService
ProductOptionService
ProductService
ProductVariantService
PromotionService
ProvinceService
RoleService
SearchService
SellerService
SessionService
SettingsStoreService
ShippingMethodService
SlugService
StockLevelLockOptions
StockLevelReadOptions
StockLevelService
StockLocationService
StockMovementService
TagService
TaxCategoryService
TaxRateService
UserService
ZoneService
SettingsStore
CleanupOrphanedSettingsStoreEntriesOptions
CleanupOrphanedSettingsStoreEntriesResult
OrphanedSettingsStoreEntry
SetSettingsStoreValueResult
SettingsStoreFieldConfig
SettingsStoreRegistration
SettingsStoreScopeFunction
SettingsStoreScopes
Shipping
CheckShippingEligibilityCheckerFn
DefaultShippingLineAssignmentStrategy
ShippingCalculator
ShippingEligibilityChecker
ShippingEligibilityCheckerConfig
ShippingLineAssignmentStrategy
ShippingOptions
ShouldRunCheckFn
State Machine
FSM
StateMachineConfig
Transitions
Tax
AddressBasedTaxZoneStrategy
DefaultTaxLineCalculationStrategy
DefaultTaxZoneStrategy
OrderTaxCalculationStrategy
TaxLineCalculationStrategy
TaxOptions
TaxZoneStrategy
Telemetry
Instrument
InstrumentationStrategy
TelemetryModule
TelemetryService
WrappedMethodArgs
Testing
CreateErrorResultGuard
CreateTestEnvironment
DriverOptions
ErrorResultGuard
GetSuperadminContext
RegisterInitializer
SimpleGraphQLClient
TestConfig
TestDbInitializer
TestEnvironment
TestingLogger
TestServer
TestServerOptions
Worker
BootstrapWorker
VendureWorker
WorkerHealthCheckConfig
Core Plugins
AdminUiPlugin
AdminUiPluginOptions
AssetServerPlugin
AssetServerOptions
CacheConfig
HashedAssetNamingStrategy
HexColorString
ImageTransformMode
ImageTransformPreset
ImageTransformStrategy
LocalAssetStorageStrategy
PresetOnlyStrategy
S3AssetStorageStrategy
SharpAssetPreviewStrategy
DashboardPlugin
DashboardPluginOptions
EmailPlugin
Email Plugin Types
Email Utils
EmailEventHandler
EmailEventHandlerWithAsyncData
EmailEventListener
EmailGenerator
EmailPluginOptions
EmailSender
EmailSendEvent
TemplateLoader
Transport Options
GraphiQLPlugin
HardenPlugin
DefaultVendureComplexityEstimator
HardenPluginOptions
JobQueuePlugin
BullMQJobQueuePlugin
BullMQJobQueueStrategy
BullMQPluginOptions
McpPlugin
McpAuthorizationCode
McpAuthorizationRequest
McpDnsRebindingOptions
McpLoggingOptions
McpLogRedactFn
McpOauthClient
McpOauthGrant
McpOauthGrantStatus
McpOauthOptions
McpPluginOptions
McpRateLimitOptions
McpToolCallEvent
McpToolCallLog
McpToolExecutionService
McpToolExposureMode
McpToolSummary
TelemetryPlugin
GetSdkConfiguration
OtelLogger
RegisterMethodHooks
TelemetryPluginOptions
MCP SDK
AssertCustomFieldsWritable
BooleanFilter
DateFilter
EmailAddressSchema
FindOrCreateActiveOrder
GRAPHQL_INT_MAX
GRAPHQL_INT_MIN
IdSchema
Int32Schema
ListInput
ListOptions
LongText
MAX_ID_LIST_LENGTH
MAX_LIST_PAGE_SIZE
McpActiveOrder
McpCallerGrant
McpCallerInfo
McpJsonSchema
McpStandardSchema
McpStandardSchemaIssue
McpStandardSchemaResult
McpTool
McpToolBehavior
McpToolHandler
McpToolMetadata
McpToolSchema
McpToolset
NumberFilter
Page
PaginationFields
ShortText
SlicePage
StringFilter
ToDecimalString
GraphQL API
Admin API
Enums
Input Objects
Mutations
Queries
Types
Shop API
Enums
Input Objects
Mutations
Queries
Types
Dashboard API
Components
AssetGallery
AssetPickerDialog
ChannelChip
ConfigurableOperationSentence
CopyableText
DetailPageButton
FacetValueChip
FacetValueFacetedFilter
FacetValueSelector
PermissionGuard
VendureImage
Detail Views
DetailPage
UseDetailPage
UseGeneratedForm
Extensions Api
ActionBar
Alerts
Custom Providers
DataTables
DefineDashboardExtension
DetailForms
FormComponents
HistoryEntries
Insights Filters
Login
Navigation
Page Blocks
RefundDestinations
Routes
Toolbar
Widgets
Form Components
AffixedInput
BooleanInput
CheckboxInput
DateTimeInput
FormFieldWrapper
MoneyInput
NumberInput
PasswordInput
RichTextInput
SlugInput
TextareaInput
TextInput
TranslatableFormFieldWrapper
Hooks
UseAlerts
UseAuth
UseChannel
UseCustomFieldConfig
UseDashboardUserContext
UseDisplayLocale
UseDragAndDrop
UseFacetValueBrowser
UseIsServerConfigLoaded
UseLocalFormat
UsePaginatedList
UsePermissions
UseSortedLanguages
UseUiLanguageLoader
UseWidgetConfig
UseWidgetFilters
List Views
Bulk Actions
DataTable
DataTableCellComponent
DataTableViewsTabs
ListPage
PaginatedListDataTable
PageLayout
Page
PageActionBar
PageBlock
PageTitle
UsePageBlock
Vite Plugin
VendureDashboardPlugin
Admin UI API
Action Bar
ActionBarContext
ActionBarDropdownMenuItem
ActionBarItem
ActionBarLocationId
AddActionBarDropdownMenuItem
AddActionBarItem
PageLocationId
RouterLinkDefinition
Alerts
AlertConfig
AlertContext
RegisterAlert
Bulk Actions
BulkAction
RegisterBulkAction
Components
AssetPickerDialogComponent
ChipComponent
CurrencyInputComponent
DataTable2Component
DataTableComponent
DatetimePickerComponent
DropdownComponent
FacetValueSelectorComponent
ObjectTreeComponent
OrderStateLabelComponent
ProductVariantSelectorComponent
RichTextEditorComponent
ZoneSelectorComponent
Custom Detail Components
CustomDetailComponent
CustomDetailComponentConfig
CustomDetailComponentLocationId
RegisterCustomDetailComponent
Custom History Entry Components
CustomerHistoryEntryComponent
HistoryEntryComponent
HistoryEntryConfig
OrderHistoryEntryComponent
RegisterHistoryEntryComponent
Custom Input Components
Default Inputs
FormInputComponent
RegisterFormInputComponent
Custom Table Components
CustomColumnComponent
DataTableComponentConfig
RegisterDataTableComponent
Dashboard Widgets
DashboardWidgetConfig
RegisterDashboardWidget
SetDashboardWidgetLayout
WidgetLayoutDefinition
Directives
IfMultichannelDirective
IfPermissionsDirective
List Detail Views
BaseDetailComponent
BaseEntityResolver
BaseListComponent
DetailComponentWithResolver
TypedBaseDetailComponent
TypedBaseListComponent
Nav Menu
AddNavMenuItem
AddNavMenuSection
Navigation Types
NavMenuItem
NavMenuSection
Pipes
AssetPreviewPipe
DurationPipe
FileSizePipe
HasPermissionPipe
LocaleCurrencyNamePipe
LocaleCurrencyPipe
LocaleDatePipe
LocaleLanguageNamePipe
LocaleRegionNamePipe
TimeAgoPipe
React Components
ActionBar
Card
CdsIcon
FormField
Link
PageBlock
PageDetailLayout
RichTextEditor
React Extensions
ReactCustomDetailComponentConfig
ReactDataTableComponentConfig
RegisterReactCustomDetailComponent
RegisterReactDataTableComponent
RegisterReactFormInputComponent
RegisterReactRouteComponent
RegisterReactRouteComponentOptions
React Hooks
UseDetailComponentData
UseFormControl
UseInjector
UseLazyQuery
UseMutation
UsePageMetadata
UseQuery
UseRichTextEditor
UseRouteParams
Routes
RegisterRouteComponent
RegisterRouteComponentOptions
Services
DataService
ModalService
NotificationService
Tabs
PageTabConfig
RegisterPageTab
Ui Devkit
AdminUiExtension
CompileUiExtensions
Helpers
UiDevkitClient
UiExtensionBuildCommand
UiExtensionCompilerOptions
UiExtensionCompilerProcessArgument
Sign in
Sign in