@coveo/headless
    Preparing search index...

    Module Commerce

    The Coveo Headless Commerce sub-package 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();
    CartActionCreators
    loadCartActions
    CategoryFacetSetActionCreators
    CoreFacetActionsCreators
    loadCategoryFacetSetActions
    loadCoreFacetActions
    ConfigurationActionCreators
    loadConfigurationActions
    ContextActionCreators
    loadContextActions
    DateFacetActionCreators
    loadDateFacetActions
    InstantProductsActionCreators
    loadInstantProductsActions
    NumericFacetActionCreators
    loadNumericFacetActions
    PaginationActionCreators
    loadPaginationActions
    ProductActionCreators
    loadProductActions
    ProductEnrichmentActionCreators
    loadProductEnrichmentActions
    ProductListingActionCreators
    loadProductListingActions
    ProductListingParametersActionCreators
    loadProductListingParametersActions
    QueryActionCreators
    loadQueryActions
    QuerySetActionCreators
    loadQuerySetActions
    QuerySuggestActionCreators
    loadQuerySuggestActions
    RecentQueriesActionCreators
    loadRecentQueriesActions
    RecommendationsActionCreator
    loadRecommendationsActions
    RegularFacetActionCreators
    loadRegularFacetActions
    SearchActionCreators
    loadSearchActions
    SearchParametersActionCreators
    loadSearchParametersActions
    SortActionCreators
    loadSortActions
    SpotlightContentActionCreators
    loadSpotlightContentActions
    StandaloneSearchBoxSetActionCreators
    loadStandaloneSearchBoxSetActions
    TriggersActionCreators
    loadTriggersActions
    Cart
    CartState
    buildCart
    CategoryFieldSuggestions
    CategoryFieldSuggestionsState
    CategoryFilterSuggestions
    CategoryFilterSuggestionsState
    buildCategoryFilterSuggestions
    Context
    ContextState
    buildContext
    FieldSuggestionsGenerator
    buildFieldSuggestionsGenerator
    FilterSuggestions
    FilterSuggestionsState
    buildFilterSuggestions
    FilterSuggestionsGenerator
    buildFilterSuggestionsGenerator
    InstantProducts
    InstantProductsState
    buildInstantProducts
    buildNotifyTrigger
    buildProductEnrichment
    ProductListing
    ProductListingOptions
    ProductListingState
    buildProductListing
    ProductView
    buildProductView
    QueryTriggerOptions
    buildQueryTrigger
    RecentQueriesList
    RecentQueriesState
    buildRecentQueriesList
    Recommendations
    buildRecommendations
    buildRedirectionTrigger
    SearchOptions
    SearchState
    buildSearch
    buildSearchBox
    StandaloneSearchBox
    StandaloneSearchBoxState
    buildStandaloneSearchBox
    DidYouMeanState
    NotifyTrigger
    NotifyTriggerState
    QueryTrigger
    QueryTriggerState
    RedirectionTrigger
    RedirectionTriggerState
    SearchBoxState
    UrlManager
    UrlManagerState
    CommerceEngine
    CommerceEngineOptions
    buildCommerceEngine
    ResultType
    SortBy
    SortDirection
    buildController
    buildDateRange
    buildFieldsSortCriterion
    buildProductTemplatesManager
    buildRelevanceSortCriterion
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getCommerceApiBaseUrl
    getOrganizationEndpoint
    getSampleCommerceEngineConfiguration
    loadLocationFacetActions
    validateRelativeDate
    AnalyticsConfiguration
    ApplyQueryTriggerModificationPayload
    Badge
    BadgePlacement
    BadgesProduct
    BaseFacetValue
    BaseProduct
    BaseSolutionTypeSubControllers
    BaseUrlManagerProps
    CartInitialState
    CartItem
    CartItemParam
    CartItemWithMetadata
    CartProps
    CategoryFacetSearchResult
    CategoryFacetValue
    CategoryFacetValueRequest
    CommerceEngineConfiguration
    CommerceSearchParameters
    ContextOptions
    ContextProps
    Controller
    CoreEngine
    CoreInstantProductPayload
    CustomContext
    DateFilterRange
    DateRangeRequest
    DeselectableValue
    DidYouMeanOptions
    EngineConfiguration
    ExternalEngineOptions
    FacetValueRequest
    FetchBadgesPayload
    FetchRecommendationsPayload
    FetchRedirectUrlPayload
    FetchSearchPayload
    FieldSuggestionsFacet
    HighlightKeyword
    InstantProductsOptions
    InstantProductsProps
    InteractiveProduct
    InteractiveProductOptions
    InteractiveResultCore
    InteractiveSpotlightContent
    InteractiveSpotlightContentOptions
    LocationFacetActionCreators
    LocationFacetValue
    LoggerOptions
    Middleware
    NumericRangeRequest
    PaginationProps
    ParameterManagerInitialState
    ParameterManagerProps
    Parameters
    Product
    ProductEnrichment
    ProductEnrichmentOptions
    ProductEnrichmentProps
    ProductEnrichmentState
    ProductListingSummaryState
    ProductTemplatesManager
    PromoteChildToParentPayload
    QueryCorrection
    RecentQueriesListInitialState
    RecentQueriesListProps
    RecommendationsOptions
    RecommendationsProps
    RecommendationsState
    RecommendationsSummaryState
    RegisterProductEnrichmentOptionsPayload
    RegisterRecentQueriesCreatorPayload
    RegisterStandaloneSearchBoxPayload
    RegularFacetValue
    Relay
    ResetStandaloneSearchBoxPayload
    SearchAndListingSubControllers
    SearchBoxProps
    SearchParameters
    SearchSubControllers
    SearchSummaryState
    SetContextPayload
    SortInitialState
    SortProps
    SpotlightContent
    SpotlightContentClickPayload
    StandaloneSearchBoxOptions
    StandaloneSearchBoxProps
    Subscribable
    Suggestion
    Summary
    Template
    ToggleSelectLocationFacetValuePayload
    ToggleSelectNumericFacetValuePayload
    Transaction
    Unsubscribe
    UpdateInstantProductQueryPayload
    UpdateNumericFacetValuesPayload
    UpdateQueryPayload
    UrlManagerInitialState
    UrlManagerProps
    UserLocation
    View
    WordCorrection
    HighlightUtils
    Selectors
    CategoryFacet
    CategoryFacetState
    DateFacet
    DateFacetState
    DidYouMean
    FacetGenerator
    FacetGeneratorState
    LocationFacet
    LocationFacetState
    NumericFacet
    NumericFacetState
    Pagination
    PaginationState
    ParameterManager
    ParameterManagerState
    RegularFacet
    RegularFacetState
    Sort
    SortState
    AnalyticsRuntimeEnvironment
    ApplySortPayload
    BaseResult
    CartActionPayload
    CategoryFacetSearch
    CategoryFacetSearchState
    ChildProduct
    ClearExpiredInstantProductsPayload
    ClearQuerySuggestPayload
    CoreEngineNext
    DateFacetValue
    DeselectAllValuesInCoreFacetPayload
    FacetType
    FetchMoreRecommendationsPayload
    FetchQuerySuggestionsPayload
    GeneratedFacetControllers
    GeneratedFieldSuggestionsControllers
    GeneratedFilterSuggestionsControllers
    InteractiveProductProps
    InteractiveSpotlightContentProps
    LocationFacetValueRequest
    LogLevel
    MappedGeneratedFacetController
    NextPagePayload
    NumericFacetValue
    PaginationOptions
    PlatformEnvironment
    PrepareForSearchWithQueryPayload
    PreviousPagePayload
    ProductClickPayload
    ProductTemplate
    ProductTemplateCondition
    ProductViewPayload
    PurchasePayload
    RecentQueriesListOptions
    RegisterInstantProductPayload
    RegisterQuerySetQueryPayload
    RegisterQuerySuggestPayload
    RegisterRecommendationsSlotPaginationPayload
    RegisterRecommendationsSlotPayload
    RegularFacetSearch
    RegularFacetSearchResult
    RegularFacetSearchState
    RestoreProductListingParametersPayload
    RestoreSearchParametersPayload
    Result
    SearchBoxOptions
    SelectPagePayload
    SelectQuerySuggestionPayload
    SetCustomPayload
    SetItemsPayload
    SetLocationPayload
    SetPageSizePayload
    SetViewPayload
    SortByFields
    SortByFieldsFields
    SortByRelevance
    SortCriterion
    ToggleExcludeDateFacetValuePayload
    ToggleExcludeFacetValuePayload
    ToggleExcludeNumericFacetValuePayload
    ToggleSelectCategoryFacetValuePayload
    ToggleSelectDateFacetValuePayload
    ToggleSelectFacetValuePayload
    UpdateAnalyticsConfigurationPayload
    UpdateAutoSelectionForAllCoreFacetsPayload
    UpdateBasicConfigurationPayload
    UpdateCategoryFacetNumberOfValuesPayload
    UpdateCoreFacetFreezeCurrentValuesPayload
    UpdateCoreFacetIsFieldExpandedPayload
    UpdateCoreFacetNumberOfValuesPayload
    UpdateDateFacetValuesPayload
    updateIgnoreQueryTrigger
    UpdateIgnoreQueryTriggerPayload
    UpdateItemQuantityPayload
    UpdateQuerySetQueryPayload
    productListingSerializer
    ProductTemplatesHelpers
    searchSerializer
    VERSION