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

Buildable controllers - Cart

Buildable controllers - CategoryFieldSuggestions

Buildable controllers - Context

Buildable controllers - FieldSuggestions

Buildable controllers - FieldSuggestionsGenerator

Buildable controllers - InstantProducts

Buildable controllers - NotifyTrigger

Buildable controllers - ProductListing

Buildable controllers - ProductView

Buildable controllers - QueryTrigger

Buildable controllers - RecentQueriesList

Buildable controllers - Recommendations

Buildable controllers - RedirectionTrigger

Buildable controllers - Search

Buildable controllers - SearchBox

Buildable controllers - StandaloneSearchBox

Sub-controllers - BreadcrumbManager

Sub-controllers - CategoryFacet

Sub-controllers - DateFacet

Sub-controllers - DidYouMean

Sub-controllers - FacetGenerator

Sub-controllers - NumericFacet

Sub-controllers - Pagination

Sub-controllers - ParameterManager

Sub-controllers - RegularFacet

Sub-controllers - Sort

Actions - Cart

Actions - CategoryFacet

Actions - Configuration

Actions - Context

Actions - DateFacet

Actions - InstantProducts

Actions - NumericFacet

Actions - Pagination

Actions - Product

Actions - ProductListing

Actions - ProductListingParameters

Actions - Query

Actions - QuerySet

Actions - QuerySuggest

Actions - RecentQueries

Actions - Recommendations

Actions - RegularFacet

Actions - Search

Actions - SearchParameters

Actions - Sort

Actions - StandaloneSearchBoxSet

Actions - Triggers

Enumerations

Functions

Interfaces

Namespaces

References

Type Aliases

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

Variables

References

Re-exports AnalyticsConfiguration
Re-exports AnalyticsRuntimeEnvironment
Re-exports BreadcrumbValue
Re-exports buildController
Re-exports buildDateRange
Re-exports Controller
Re-exports CoreEngine
Re-exports CoreInstantProductPayload
Re-exports DateFilterRange
Re-exports DateRangeRequest
Re-exports DeselectableValue
Re-exports deserializeRelativeDate
Re-exports DidYouMeanState
Re-exports EngineConfiguration
Re-exports ExternalEngineOptions
Re-exports FacetValueRequest
Re-exports getAnalyticsNextApiBaseUrl
Re-exports getOrganizationEndpoint
Re-exports HighlightKeyword
Re-exports HighlightUtils
Re-exports InteractiveResultCore
Re-exports LoggerOptions
Re-exports LogLevel
Re-exports Middleware
Re-exports NavigatorContext
Re-exports NotifyTrigger
Re-exports NotifyTriggerState
Re-exports NumericRangeRequest
Re-exports PlatformEnvironment
Re-exports QueryCorrection
Re-exports QueryTrigger
Re-exports QueryTriggerState
Re-exports RecentQueriesListInitialState
Re-exports RecentQueriesListOptions
Re-exports RecentQueriesListProps
Re-exports RedirectionTrigger
Re-exports RedirectionTriggerState
Re-exports Relay
Re-exports SearchBoxState
Re-exports SearchParameters
Re-exports StandaloneSearchBoxOptions
Re-exports StandaloneSearchBoxProps
Re-exports Subscribable
Re-exports Suggestion
Re-exports Template
Re-exports Unsubscribe
Re-exports UrlManager
Re-exports UrlManagerInitialState
Re-exports UrlManagerProps
Re-exports UrlManagerState
Re-exports validateRelativeDate
Re-exports WordCorrection