@coveo/headless
    Preparing search index...

    Module Commerce

    The Coveo Headless Commerce sub-package exposes exposes the engine, controllers, actions, and utility functions to build a commerce search experience.

    import { buildCommerceEngine, getSampleCommerceEngineConfiguration, buildSearch } from '@coveo/headless/commerce';

    const engine = buildCommerceEngine({
    configuration: getSampleCommerceEngineConfiguration(),
    });

    const search = buildSearch(engine);
    search.executeFirstSearch();

    Engine

    CommerceEngine
    CommerceEngineOptions
    buildCommerceEngine

    Controllers - DidYouMean

    DidYouMeanState

    Controllers - NotifyTrigger

    NotifyTrigger
    NotifyTriggerState

    Controllers - QueryTrigger

    QueryTrigger
    QueryTriggerState

    Controllers - RedirectionTrigger

    RedirectionTrigger
    RedirectionTriggerState

    Controllers - SearchBox

    SearchBoxState

    Controllers - UrlManager

    UrlManager
    UrlManagerState

    Buildable controllers - Cart

    Cart
    CartState
    buildCart

    Buildable controllers - CategoryFieldSuggestions

    CategoryFieldSuggestions
    CategoryFieldSuggestionsState

    Buildable controllers - CategoryFilterSuggestions

    CategoryFilterSuggestions
    CategoryFilterSuggestionsState
    buildCategoryFilterSuggestions

    Buildable controllers - Context

    Context
    ContextState
    buildContext

    Buildable controllers - FieldSuggestionsGenerator

    FieldSuggestionsGenerator
    buildFieldSuggestionsGenerator

    Buildable controllers - FilterSuggestions

    FilterSuggestions
    FilterSuggestionsState
    buildFilterSuggestions

    Buildable controllers - FilterSuggestionsGenerator

    FilterSuggestionsGenerator
    buildFilterSuggestionsGenerator

    Buildable controllers - InstantProducts

    InstantProducts
    InstantProductsState
    buildInstantProducts

    Buildable controllers - NotifyTrigger

    buildNotifyTrigger

    Buildable controllers - ProductListing

    ProductListing
    ProductListingState
    buildProductListing

    Buildable controllers - ProductView

    ProductView
    buildProductView

    Buildable controllers - QueryTrigger

    buildQueryTrigger

    Buildable controllers - RecentQueriesList

    RecentQueriesList
    RecentQueriesState
    buildRecentQueriesList

    Buildable controllers - Recommendations

    Recommendations
    buildRecommendations

    Buildable controllers - RedirectionTrigger

    buildRedirectionTrigger

    Buildable controllers - Search

    SearchState
    buildSearch

    Buildable controllers - SearchBox

    buildSearchBox

    Buildable controllers - StandaloneSearchBox

    StandaloneSearchBox
    StandaloneSearchBoxState
    buildStandaloneSearchBox

    Sub-controllers - BreadcrumbManager

    Sub-controllers - CategoryFacet

    CategoryFacet
    CategoryFacetState

    Sub-controllers - DateFacet

    DateFacet
    DateFacetState

    Sub-controllers - DidYouMean

    DidYouMean

    Sub-controllers - FacetGenerator

    FacetGenerator
    FacetGeneratorState

    Sub-controllers - LocationFacet

    LocationFacet
    LocationFacetState

    Sub-controllers - NumericFacet

    NumericFacet
    NumericFacetState

    Sub-controllers - Pagination

    Pagination
    PaginationState

    Sub-controllers - ParameterManager

    ParameterManager
    ParameterManagerState

    Sub-controllers - RegularFacet

    RegularFacet
    RegularFacetState

    Sub-controllers - Sort

    Sort
    SortState

    Actions - Cart

    CartActionCreators
    loadCartActions

    Actions - CategoryFacet

    CategoryFacetSetActionCreators
    CoreFacetActionsCreators
    loadCategoryFacetSetActions
    loadCoreFacetActions

    Actions - Configuration

    ConfigurationActionCreators
    loadConfigurationActions

    Actions - Context

    ContextActionCreators
    loadContextActions

    Actions - DateFacet

    DateFacetActionCreators
    loadDateFacetActions

    Actions - InstantProducts

    InstantProductsActionCreators
    loadInstantProductsActions

    Actions - NumericFacet

    NumericFacetActionCreators
    loadNumericFacetActions

    Actions - Pagination

    PaginationActionCreators
    loadPaginationActions

    Actions - Product

    ProductActionCreators
    loadProductActions

    Actions - ProductListing

    ProductListingActionCreators
    loadProductListingActions

    Actions - ProductListingParameters

    ProductListingParametersActionCreators
    loadProductListingParametersActions

    Actions - Query

    QueryActionCreators
    loadQueryActions

    Actions - QuerySet

    QuerySetActionCreators
    loadQuerySetActions

    Actions - QuerySuggest

    QuerySuggestActionCreators
    loadQuerySuggestActions

    Actions - RecentQueries

    RecentQueriesActionCreators
    loadRecentQueriesActions

    Actions - Recommendations

    RecommendationsActionCreator
    loadRecommendationsActions

    Actions - RegularFacet

    RegularFacetActionCreators
    loadRegularFacetActions

    Actions - Search

    SearchActionCreators
    loadSearchActions

    Actions - SearchParameters

    SearchParametersActionCreators
    loadSearchParametersActions

    Actions - Sort

    SortActionCreators
    loadSortActions

    Actions - StandaloneSearchBoxSet

    StandaloneSearchBoxSetActionCreators
    loadStandaloneSearchBoxSetActions

    Actions - Triggers

    TriggersActionCreators
    loadTriggersActions

    Enumerations

    SortBy
    SortDirection

    Functions

    buildController
    buildDateRange
    buildFieldsSortCriterion
    buildProductTemplatesManager
    buildRelevanceSortCriterion
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getCommerceApiBaseUrl
    getOrganizationEndpoint
    getSampleCommerceEngineConfiguration
    loadLocationFacetActions
    validateRelativeDate

    Interfaces

    AnalyticsConfiguration
    ApplyQueryTriggerModificationPayload
    BaseFacetValue
    BaseProduct
    BaseSolutionTypeSubControllers
    BaseUrlManagerProps
    CartInitialState
    CartItem
    CartItemParam
    CartItemWithMetadata
    CartProps
    CategoryFacetSearchResult
    CategoryFacetValue
    CategoryFacetValueRequest
    CommerceEngineConfiguration
    CommerceSearchParameters
    ContextOptions
    ContextProps
    Controller
    CoreEngine
    CoreInstantProductPayload
    DateFilterRange
    DateRangeRequest
    DeselectableValue
    EngineConfiguration
    ExternalEngineOptions
    FacetValueRequest
    FetchRecommendationsPayload
    FetchRedirectUrlPayload
    FieldSuggestionsFacet
    HighlightKeyword
    InstantProductsOptions
    InstantProductsProps
    InteractiveProduct
    InteractiveProductOptions
    InteractiveResultCore
    LocationFacetActionCreators
    LocationFacetValue
    LoggerOptions
    Middleware
    NumericRangeRequest
    PaginationProps
    ParameterManagerInitialState
    ParameterManagerProps
    Parameters
    Product
    ProductListingSummaryState
    ProductTemplatesManager
    PromoteChildToParentPayload
    QueryCorrection
    RecentQueriesListInitialState
    RecentQueriesListOptions
    RecentQueriesListProps
    RecommendationsOptions
    RecommendationsProps
    RecommendationsState
    RecommendationsSummaryState
    RegisterRecentQueriesCreatorPayload
    RegisterStandaloneSearchBoxPayload
    RegularFacetValue
    Relay
    ResetStandaloneSearchBoxPayload
    SearchAndListingSubControllers
    SearchBoxProps
    SearchParameters
    SearchSubControllers
    SearchSummaryState
    SetContextPayload
    SortInitialState
    SortProps
    StandaloneSearchBoxOptions
    StandaloneSearchBoxProps
    Subscribable
    Suggestion
    Summary
    Template
    ToggleSelectLocationFacetValuePayload
    ToggleSelectNumericFacetValuePayload
    Transaction
    Unsubscribe
    UpdateInstantProductQueryPayload
    UpdateNumericFacetValuesPayload
    UpdateQueryPayload
    UrlManagerInitialState
    UrlManagerProps
    UserLocation
    View
    WordCorrection

    Namespaces

    HighlightUtils
    Selectors

    Type Aliases

    AnalyticsRuntimeEnvironment
    ApplySortPayload
    CartActionPayload
    CategoryFacetSearch
    CategoryFacetSearchState
    ChildProduct
    ClearExpiredInstantProductsPayload
    ClearQuerySuggestPayload
    CoreEngineNext
    DateFacetValue
    DeselectAllValuesInCoreFacetPayload
    FacetType
    FetchMoreRecommendationsPayload
    FetchQuerySuggestionsPayload
    GeneratedFacetControllers
    GeneratedFieldSuggestionsControllers
    GeneratedFilterSuggestionsControllers
    InteractiveProductProps
    LocationFacetValueRequest
    LogLevel
    MappedGeneratedFacetController
    NextPagePayload
    NumericFacetValue
    PaginationOptions
    PlatformEnvironment
    PrepareForSearchWithQueryPayload
    PreviousPagePayload
    ProductClickPayload
    ProductTemplate
    ProductTemplateCondition
    ProductViewPayload
    PurchasePayload
    RegisterInstantProductPayload
    RegisterQuerySetQueryPayload
    RegisterQuerySuggestPayload
    RegisterRecommendationsSlotPaginationPayload
    RegisterRecommendationsSlotPayload
    RegularFacetSearch
    RegularFacetSearchResult
    RegularFacetSearchState
    RestoreProductListingParametersPayload
    RestoreSearchParametersPayload
    SearchBoxOptions
    SelectPagePayload
    SelectQuerySuggestionPayload
    SetItemsPayload
    SetLocationPayload
    SetPageSizePayload
    SetViewPayload
    SortByFields
    SortByFieldsFields
    SortByRelevance
    SortCriterion
    ToggleExcludeDateFacetValuePayload
    ToggleExcludeFacetValuePayload
    ToggleExcludeNumericFacetValuePayload
    ToggleSelectCategoryFacetValuePayload
    ToggleSelectDateFacetValuePayload
    ToggleSelectFacetValuePayload
    UpdateAnalyticsConfigurationPayload
    UpdateAutoSelectionForAllCoreFacetsPayload
    UpdateBasicConfigurationPayload
    UpdateCategoryFacetNumberOfValuesPayload
    UpdateCoreFacetFreezeCurrentValuesPayload
    UpdateCoreFacetIsFieldExpandedPayload
    UpdateCoreFacetNumberOfValuesPayload
    UpdateDateFacetValuesPayload
    UpdateIgnoreQueryTriggerPayload
    UpdateItemQuantityPayload
    UpdateQuerySetQueryPayload

    Variables

    productListingSerializer
    ProductTemplatesHelpers
    searchSerializer
    updateIgnoreQueryTrigger