Skip to main content
Report Bug
Getting Started
Guides
Reference
Plugins
Community
How to use
Search docs...
Ctrl
K
8.5k
v1.0.0 (Current)
▼
v1.0.0 (Current)
▼
Getting Started
Introduction
Quick Start
Add to an Existing Project
Project Structure
Incremental Adoption
Registry Access
Platform
Getting Started
Configuration
Capability Catalog
Editions
Upgrading Vendure Platform
Changing Edition
License Guard Runbook
MCP Setup
MCP Tool Catalog
MCP Tools
Org Hierarchy
Getting Started
Configuration
Strategies
API Reference
Permissions & Roles
Events
Storefront
Upgrading
MCP Tools
Approval Workflows
Getting Started
Configuration
Conditions
Resolvers
Entity Handlers
Notifications
Events
Order Approvals
Org-Hierarchy Integration
MCP Tools
Upgrading
Entity Access Control
Getting Started
Configuration
Conditions
GraphQL API
MCP Tools
Quote Management
Getting Started
Configuration
Storefront Usage
MCP Tools
Upgrading
Tax ID Management
Getting Started
MCP Tools
PunchOut
Getting Started
Configuration
Trading Partners
cXML Document Log
Strategies
Storefront Integration
Org-Hierarchy Integration
Events
Security and Compliance
MCP Tools
Price Rules
Getting Started
Core Concepts
Price Lists
Setting Up Price Rules
Validation Rules
Bulk Editing
Storefront Usage
MCP Tools
Configurator
Getting Started
MCP Tools
Product Types
Getting Started
Configuration & API
MCP Tools
Packaging Units
Getting Started
Configuration
Storefront Usage
MCP Tools
Shopping List
Getting Started
Configuration
API Reference
Events
Storefront Integration
MCP Tools
Upgrading
Quick Order
Getting Started
Configuration
Storefront
MCP Tools
Reorder from History
Getting Started
Configuration
API Reference
Storefront
MCP Tools
Store Credit
Getting Started
Configuration
Storefront
MCP Tools
Gift Cards
Getting Started
Configuration
Email Setup
Storefront
MCP Tools
Shared Carts
Getting Started
Storefront Usage
Admin Oversight
MCP Tools
Workflow Engine
Getting Started
Configuration
MCP Tools
Audit Trail
Getting Started
Configuration
Audit Log Sources
Audit Log Sink
Retention & Export
Tamper-Proof Storage
Programmatic API
MCP Tools
Content Versioning
Getting Started
Version Strategies
Draft Mode
Dashboard Integration
GraphQL API
MCP Tools
SSO
Configuration
API Reference
Role Mapping
Troubleshooting
MCP Tools
Providers
OIDC Setup
SAML Setup
Advanced Search
Getting Started
Searching
Semantic Search
InstantSearch
Switching Search Engines
Custom Mappings
External Indexes
Geo Search
Search Analytics
Search Analytics MCP Tools
Languages
MCP Tools
Global Search
Getting Started
Configuration
MCP Tools
Integration
Org-Hierarchy + Approval Workflows
Org-Hierarchy + Price Rules
Reference
TypeScript API
AdvancedSearchPlugin
AdvancedSearchCollectionConfig
AdvancedSearchInitOptions
AdvancedSearchPluginType
AdvancedSearchReindexBatchEntity
AdvancedSearchService
BaseCustomMappingDefinition
BaseExternalIndexConfig
CollectionConfigService
CollectionNameService
CreateAdvancedSearchPlugin
CreateCollectionExternalIndex
CurateSearch
DocumentContext
EmbeddingModelConfig
EmbedFromField
EvaluateSearchEngineReadiness
EventDrivenSource
ExternalIndex
ExternalIndexConfig
ExternalIndexPollConfig
ExternalIndexService
ExternalIndexSubscriptions
ExternalSearchService
InfixField
ObjectCustomMapping
ObjectCustomMappingDefinition
OverrideService
PolledSource
PrimitiveCustomMapping
PrimitiveCustomMappingDefinition
ProductSearchFilter
ProductSearchStrategy
ReindexOutcome
SearchEngineDefinition
SearchEngineReadiness
SearchEngineReadinessCheck
SearchEngineReadinessCheckId
SearchEngineReadinessService
SearchEngineReadinessStatus
SearchIndexBatchService
SearchIndexService
SearchJobBufferService
SemanticSearchOptions
SortableField
SynonymService
TypesenseDocument
TypesenseService
ValueFunctionArgs
Approval Workflows Plugin
AdministratorRoleResolver
ApprovalChainLevel
ApprovalChainLevelDraft
ApprovalChainStrategy
ApprovalCondition
ApprovalConditionConfig
ApprovalConditionInput
ApprovalDecision
ApprovalDecisionEvent
ApprovalDecisionType
ApprovalDecisionValue
ApprovalEmailHandlerOptions
ApprovalEntityHandler
ApprovalMarkerService
ApprovalNotificationHandler
ApprovalOperationStrategy
ApprovalOrderProcess
ApprovalOrdersPlugin
ApprovalPluginOptions
ApprovalPolicy
ApprovalRequest
ApprovalRequestEvent
ApprovalRequestStatus
ApprovalResolver
ApprovalResolverConfig
ApprovalResolverInput
ApprovalWorkflow
ApprovalWorkflowInput
ApprovalWorkflowsData
ApprovalWorkflowStrategy
CheckApprovalConditionFn
CreateApprovalDemoOrdersPopulator
CreateApprovalEmailHandlers
CreateApprovalWorkflowsPopulator
CustomerGroupCondition
DefaultApprovalChainStrategy
DefaultApprovalOperationStrategy
DefaultApprovalWorkflowStrategy
IsStandardChain
LogNotificationHandler
OrderApprovalHandler
OrderLineValidationResult
OrderTotalThresholdCondition
ProductInCategoryCondition
ResolveApproversFn
ResolvedApprover
SpecificAdministratorsResolver
STANDARD_APPROVAL_DECISIONS
ValidateOrderLinesForApproval
AuditGovernancePlugin
AuditGovernanceOptions
AuditGovernancePluginOptions
AuditLogExportParams
AuditLogExportResult
AuditLogExportStrategy
AuditLogExportTask
AuditLogRetentionEvent
AuditLogRetentionStrategy
AuditLogRetentionTask
ExportContext
ExternalAuditLogSink
GovernanceAuditLogWriteStrategy
HttpSiemLogSink
HttpSiemLogSinkOptions
JsonFileExportStrategy
JsonFileExportStrategyOptions
TimeBasedRetentionStrategy
AuditTrailPlugin
ActorService
AddMetadataFn
AdminApiLogSourceStrategy
AuditLogBoundary
AuditLogConnection
AuditLogEdge
AuditLogEntry
AuditLogEntryInput
AuditLogMetadata
AuditLogService
AuditLogSink
AuditLogSourceStrategy
AuditLogWriteStrategy
AuditTrailConfigurationError
AuditTrailConfigurationErrorCode
CreateAuditLogEntryInput
CreatedAtFilters
CursorData
CursorPaginationParams
CursorQueryParams
DatabaseLogSink
DatabaseLogSinkOptions
DecodeCursor
DEFAULT_SENSITIVE_FIELD_PATTERNS
DefaultAuditedOperations
DefaultAuditLogWriteStrategy
EncodeCursor
EventBusLogSourceStrategy
InMemoryAuditLogSink
IsBuiltInAuditLogSink
PageInfo
PluginInitOptions
QueryParams
ReadAccessAuditedOperations
ResolvedAuditTrailOptions
SortOption
Content Versioning Plugin
CollectionChangeOp
CollectionVersionStrategy
ContentVersioningData
ContentVersioningEntities
CreateContentVersioningPopulator
EntityVersion
FacetValueVersionStrategy
FacetVersionStrategy
ProductVariantVersionStrategy
ProductVersionStrategy
VersionChainService
VersionCollectionChange
VersionedCollection
VersionedCollectionService
VersionRestoredEvent
VersionService
VersionSnapshot
VersionStatus
VersionStrategy
VersionStrategyConfig
VersionStrategyPermissions
EntityAccessControlPlugin
AccessFilterCondition
AccessFilterConditionConfig
AccessPolicy
AccessPolicyPermission
AccessPolicyService
ApplyFilterInput
CreateEntityAccessControlPopulator
EntityAccessControlData
EntityAccessControlPluginOptions
OrderStateCondition
PolicyBasedAccessControlStrategy
Gift Cards Plugin
DefaultGiftCardElementContentStrategy
DispatchDueGiftCardsTask
ElementContentContext
GiftCard
GiftCardConfig
GiftCardCustomFields
GiftCardDispatchEvent
GiftCardElementContentStrategy
GiftCardPurchaseGuardValidator
GiftCardService
GiftCardsPluginOptions
GiftCardTemplate
TemplateElement
TemplateLayout
GlobalSearchPlugin
ALL_CHANNELS_SENTINEL
AssetSearchEntry
CollectionSearchEntry
CreateCompositeId
CustomerSearchEntry
DATABASE_INDEX_BUILT_AT_SETTING_KEY
DefaultSearchEntries
FieldAccessor
GLOBAL_SEARCH_EXTERNAL_INDEX
GLOBAL_SEARCH_INDEX_NAME
GLOBAL_SEARCH_PLUGIN_OPTIONS
GLOBAL_SEARCH_SETTINGS_NAMESPACE
GlobalSearchDocument
GlobalSearchIndexEntry
GlobalSearchIndexEntryConfig
GlobalSearchIndexItem
GlobalSearchInput
GlobalSearchItem
GlobalSearchPermission
GlobalSearchPluginOptions
GlobalSearchResult
LoggerCtx
OrderSearchEntry
ParseCompositeId
ProductSearchEntry
RECENT_SEARCHES_SETTING_KEY
Org Accounts Plugin
ACTIVE_COMPANY_ID_HEADER
ActiveCompanyContext
ActiveCompanyMiddleware
ActiveCompanyStrategy
AllowCompanyPermission
BUILT_IN_COMPANY_PERMISSIONS
BuiltInCompanyPermissionName
Company
CompanyAccountService
CompanyAddress
CompanyAddressEvent
CompanyAddressScopeStrategy
CompanyAddressService
CompanyContextParam
CompanyEvent
CompanyPaymentMethod
CompanyPaymentMethodEvent
CompanyPaymentMethodService
CompanyPermission
CompanyPermissionEvent
CompanyPermissionName
CompanyPermissionService
CompanyProcess
CompanyRegistrationStrategy
CompanyRole
CompanyRoleEvent
CompanyRoleScope
CompanyRoleService
CompanyService
CompanyState
CompanyStates
CompanyStateTransitionError
CompanyStateTransitionEvent
CompanyTransitionData
CompanyUser
CompanyUserAssignmentStrategy
CompanyUserEvent
CompanyUserInvitedEvent
CompanyUserProcess
CompanyUserService
CompanyUserState
CompanyUserStates
CompanyUserStateTransitionError
CompanyUserStateTransitionEvent
CompanyUserTransitionData
CreateOrgAccountsPopulator
CustomerCreationStrategy
DefaultActiveCompanyStrategy
DefaultCompanyAddressScopeStrategy
DefaultCompanyProcess
DefaultCompanyRegistrationStrategy
DefaultCompanyUserAssignmentStrategy
DefaultCompanyUserProcess
DefaultCustomerCreationStrategy
DefaultInvitationStrategy
DefaultOrderAttributionStrategy
DefaultPermissionEvaluationStrategy
GlobalRoleDefinition
InvitationStrategy
InvitationTokenError
OrderAttributionStrategy
OrgAccountsData
OrgAccountsPluginOptions
OrgAccountsService
PermissionEvaluationStrategy
PlaceOrdersOrderProcess
OrgHierarchyPlugin
ACTIVE_BUSINESS_UNIT_ID_HEADER
ActiveBusinessUnitMiddleware
BusinessUnitAddressScopeStrategy
BusinessUnitAssignmentStrategy
BusinessUnitEvent
BusinessUnitOrderAttributionStrategy
CompanyBusinessUnit
CompanyBusinessUnitAddress
CompanyBusinessUnitService
CreateOrgHierarchyPopulator
OrgHierarchyData
OrgHierarchyOptions
OrgHierarchyPluginOptions
PackagingUnitsPlugin
CreatePackagingUnitsPopulator
PACKAGING_UNITS_PLUGIN_OPTIONS
PackagingUnit
PackagingUnitPermission
PackagingUnitsData
PackagingUnitService
PackagingUnitsPluginInitOptions
PackagingUnitStockService
PackagingUnitTranslation
ProductPackagingUnit
ProductPackagingUnitService
ProductVariantPackagingUnit
ProductVariantPackagingUnitService
PriceRulesPlugin
AssignmentMatchContext
CreatePriceRulesPopulator
CustomerAssignmentStrategy
CustomerGroupAssignmentStrategy
DayOfWeekCondition
DefaultPricingCalculatorStrategy
DefaultShopperIdentityStrategy
MatchedList
OrderHistoryCondition
OrderRecipe
PrefixedEntryGroup
PRICE_RULES_PLUGIN_OPTIONS
PriceListAssignmentInputData
PriceListAssignmentStrategy
PriceListCondition
PriceListConditionConfig
PriceListConditionInput
PriceListEntryInputData
PriceListEntryService
PriceListEntryValue
PriceListEntryVersionStore
PriceListInputData
PriceListMatcherService
PriceListPriceCalculationStrategy
PriceListService
PriceListsPermission
PriceRulePluginInitOptions
PriceRulesData
PricingCalculatorInput
PricingCalculatorStrategy
PricingService
PricingTrace
ResolveCrossList
ScopeSimulation
ShopperIdentity
ShopperIdentityStrategy
ShouldSkipPriceRulesFn
QuoteNegotiationPlugin
CreateQuoteEmailHandlers
CreateQuoteNegotiationPopulator
DefaultQuoteDocumentStrategy
QuoteApprovalHandler
QuoteComment
QuoteCommentEvent
QuoteCommentService
QuoteDocumentContext
QuoteDocumentResult
QuoteDocumentService
QuoteDocumentStrategy
QuoteEmailHandlerOptions
QuoteNegotiationAction
QuoteNegotiationData
QuoteNegotiationDef
QuoteNegotiationOptions
QuoteNegotiationPluginOptions
QuoteNegotiationStatus
QuoteNegotiationWorkflow
QuoteNegotiationWorkflowStrategy
QuoteNotificationHandler
QuoteRevisionService
QuoteTemplate
QuoteTemplateLineItem
QuoteTemplateService
QuoteTotalThresholdCondition
QuoteRequestsPlugin
CreateQuoteManagementPopulator
DefaultQuoteCustomerScopeStrategy
DefaultQuoteWorkflowStrategy
GetSourceQuoteId
Quote
QUOTE_ACTION_SIGNAL
QUOTE_PLUGIN_OPTIONS
QuoteAction
QuoteActionPayload
QuoteActionValue
QuoteCheckoutActiveOrderStrategy
QuoteConversionService
QuoteCustomerScopeStrategy
QuoteCustomerService
QUOTED_SHIPPING_METADATA_KEY
QuoteDef
QuotedPriceOrderItemPriceStrategy
QuotedShippingCalculator
QuotedShippingEligibilityChecker
QuoteEvent
QuoteEventType
QuoteLifecycleWorkflow
QuoteLineItem
QuoteManagementData
QuoteManagementPermission
QuotePopulateContext
QuotePopulateHooks
QuoteRequestedEvent
QuoteRequestsPluginOptions
QuoteService
QuoteStatusValue
QuoteVersion
QuoteVersionEvent
QuoteVersionService
QuoteWorkflow
QuoteWorkflowInput
QuoteWorkflowSignals
QuoteWorkflowStrategy
SearchAnalyticsPlugin
AnalyticsService
AnalyticsStrategy
ClickhouseAnalyticsStrategy
ClickhouseOptions
CreateQueryId
MockDataService
SearchAnalyticsPluginOptions
SearchEventBase
SearchEventType
SearchListViewedEvent
SearchQueryLogData
SearchResultClickedEvent
SqlAnalyticsStrategy
Shopping List Plugin
CreateShoppingListPopulator
DefaultShoppingListCustomerScopeStrategy
DefaultShoppingListMergeStrategy
DefaultShoppingListOrderStrategy
ShoppingList
ShoppingListCustomerScopeStrategy
ShoppingListData
ShoppingListEvent
ShoppingListItem
ShoppingListItemEvent
ShoppingListItemValidationStrategy
ShoppingListMergedEvent
ShoppingListMergeStrategy
ShoppingListOrderStrategy
ShoppingListPluginInitOptions
ShoppingListService
ShoppingListManagedPlugin
CreateShoppingListSharePopulator
ManagedShoppingListOrderStrategy
ManagedShoppingListService
ShoppingListPermission
ShoppingListShare
ShoppingListShareData
ShoppingListSharedEvent
SsoFederationPlugin
FederatedOidcAuthenticationStrategy
FederatedOidcProviderConfig
FederatedProviderConfig
FederatedSsoIdentityProviderStrategy
FederatedSsoRoleAssignmentStrategy
FederatedSsoUserData
SAML_STRATEGY_NAME_PREFIX
SamlAttributeMapping
SamlAuthenticationStrategy
SamlProviderConfig
SamlService
SsoFederationOptions
SsoRoleMappingStrategy
SsoPlugin
DEFAULT_CALLBACK_PATH_PREFIX
DEFAULT_OIDC_SCOPES
DEFAULT_SESSION_TIMEOUT
DefaultSsoIdentityProviderStrategy
DefaultSsoRoleAssignmentStrategy
OIDC_STRATEGY_NAME_PREFIX
OidcAuthenticationStrategy
OidcClaimsMapping
OidcProviderConfig
OidcService
SSO_PLUGIN_OPTIONS
SsoIdentityProviderStrategy
SsoPluginOptions
SsoProviderConfig
SsoProviderInfo
SsoRoleAssignmentStrategy
SsoService
SsoUserData
Store Credit Plugin
DefaultStoreCreditCodeStrategy
DefaultStoreCreditCustomerScopeStrategy
DefaultStoreCreditRedemptionValidator
PerCustomerRedemptionLimitOptions
PerCustomerRedemptionLimitValidator
STORE_CREDIT_PAYMENT_ELIGIBILITY_CHECKER_CODE
STORE_CREDIT_PAYMENT_METHOD_CODE
StoreCredit
StoreCreditCodeStrategy
StoreCreditCodeStrategyOptions
StoreCreditCustomerScopeStrategy
StoreCreditError
StoreCreditEvent
StoreCreditHistoryEntry
StoreCreditHistoryEntryType
StoreCreditPaymentMethodHandler
StoreCreditPermission
StoreCreditPluginOptions
StoreCreditRedemptionValidator
StoreCreditService
StoreCreditTransaction
StoreCreditTransactionService
StoreCreditValidationResult
Storefront Client
CreateClient
CreateInstantSearchClient
DEFAULT_CHANNEL_TOKEN
DEFAULT_HEADER_NAMES
GraphQLErrorEntry
InstantSearchClient
InstantSearchClientOptions
InstantSearchMode
InstantSearchSort
Provider
RequestMiddleware
RequestOptions
UnsupportedSearchParameterError
VendureClient
VendureClientConfig
VendureClientError
VendureGraphQLError
VendureHeaderNames
VendureProviders
VendureRawResponse
VendureRequest
VendureResponse
VendureResult
TaxIdManagementPlugin
CreateTaxIdManagementPopulator
EuReverseChargeTaxExemptionStrategy
NoopValidationStrategy
TaxExemptionArgs
TaxExemptionResult
TaxExemptionStrategy
TaxIdAwareTaxLineCalculationStrategy
TaxIdManagementData
TaxIdManagementPluginOptions
TaxIdService
TaxIdType
TaxIdValidationResult
TaxIdValidationService
TaxIdValidationStatus
TaxIdValidationStrategy
ViesValidationStrategy
VendurePlatform
AdvancedSearchPlatformOptions
Bootstrap
BootstrapWorker
PluginOptionsCb
VendurePlatformOptions
WorkflowEnginePlugin
DbosJobQueueRateLimit
DbosJobQueueStrategy
DbosJobQueueStrategyOptions
DemoWorkflowPlugin
DrainJobQueue
GetCurrentJobRequestContext
InferSignalPayload
ListWorkflowsInput
OrderApprovalWorkflow
SignalArgDefinition
SignalArgTypeToTs
SignalDef
SignalDefinition
SignalMap
StartWorkflowOptions
VendureWorkflow
WorkflowClass
WorkflowDatabaseConnectionOptions
WorkflowDetail
WorkflowEngineOptions
WorkflowHandle
WorkflowInput
WorkflowListEntry
WorkflowRun
WorkflowService
WorkflowStatus
WorkflowStep
WorkflowStepConfig
WorkflowStepInfo
Sign in
Sign in