InstantProducts

This is for:

Developer
Important

The Headless commerce engine, controllers, and actions are in open beta and therefore under active development. Reach out to your Coveo team for support in adopting them.

The InstantProducts controller allows the end user to manage instant products queries.

Methods

clearExpired

Clears all expired instant products queries.

interactiveProduct

Creates an InteractiveProduct sub-controller.

Parameters

  • props: Omit<InteractiveProductCoreProps, 'responseIdSelector'>

    The properties for the InteractiveProduct sub-controller.

Returns InteractiveProduct: An InteractiveProduct sub-controller.

promoteChildToParent

Finds the specified parent product and the specified child product of that parent, and makes that child the new parent. The children and totalNumberOfChildren properties of the original parent are preserved in the new parent.

This method is useful when leveraging the product grouping feature to allow users to select nested products.

E.g., if a product has children (such as color variations), you can call this method when the user selects a child to make that child the new parent product, and re-render the product as such in the storefront.

Note: In the controller state, a product that has children will always include itself as its own child so that it can be rendered as a nested product, and restored as the parent product through this method as needed.

Parameters

  • childPermanentId: string

    The permanentid of the child product that will become the new parent.

  • parentPermanentId: string

    The permanentid of the current parent product of the child product to promote.

updateQuery

Updates the specified query and shows instant products for it.

Parameters

  • query: string

    The query to get instant products for. For more precise instant products, query suggestions are recommended.

subscribe

Adds a callback that’s invoked on state change.

Parameters

  • listener: () => void

    A callback that’s invoked on state change.

Returns Unsubscribe: A function to remove the listener.

Attributes

state

The state of the InstantProducts controller.

Properties

  • error: CommerceAPIErrorResponse | SerializedError | null

    An error returned when executing an instant products request, if any. This is null otherwise.

  • isLoading: boolean

    Determines if a search is in progress for the current query.

  • products: Product[]

    The instant products for the current query.

  • query: string

    The current query for instant products.

Initialize

buildInstantProducts

Creates an InstantProducts controller instance.

Parameters

  • engine: CommerceEngine

    The headless commerce engine.

  • props: InstantProductsProps

    The configurable InstantProducts properties.

Returns InstantProducts

InstantProductsProps

The configurable InstantProducts properties.

Properties

InstantProductsOptions

Properties

  • cacheTimeout?: number

    Number in milliseconds that cached products will be valid for. Defaults to 1 minute. Set to 0 so that products never expire.

  • searchBoxId?: string

    A unique identifier for the search box.

InteractiveProduct

Properties

  • warningMessage?: string

  • beginDelayedSelect: function

    Prepares to select the result after a certain delay, sending analytics if it was never selected before.

In a DOM context, it’s recommended to call this method on the touchstart event.

  • cancelPendingSelect: function

    Cancels the pending selection caused by beginDelayedSelect.

In a DOM context, it’s recommended to call this method on the touchend event.

  • select: function

    Selects the result, logging a UA event to the Coveo Platform if the result wasn’t selected before.

In a DOM context, it’s recommended to call this method on all of the following events: * contextmenu * click * mouseup * mousedown

Product

Properties

  • position: number

    The 1-based product’s position across the non-paginated result set.

    E.g., if the product is the third one on the second page, and there are 10 products per page, its position is 13 (not 3).

  • additionalFields: Record<string, unknown>

    The requested additional fields for the product.

  • children: Omit<BaseProduct, 'children' | 'totalNumberOfChildren'>

    The child products of the product, fetched through product grouping.

  • clickUri: string

    The URL of the product.

  • permanentid: string

    The SKU of the product.

  • totalNumberOfChildren: number

    The total number of child products fetched through product grouping.

  • ec_brand?: string

    The brand of the product.

    From the ec_brand field.

  • ec_category?: string

    The category of the product (e.g., "Electronics;Electronics|Televisions;Electronics|Televisions|4K Televisions").

    From the ec_category field.

  • ec_description?: string

    The description of the product.

    From the ec_description field.

  • ec_gender?: string

    The gender the product is intended for.

  • ec_images?: string[]

    The URLs of additional product images.

    From the ec_images field.

  • ec_in_stock?: boolean

    Whether the product is currently in stock.

    From the ec_in_stock field.

  • ec_item_group_id?: string

    The ID used for the purpose of product grouping.

    From the ec_item_group_id field.

  • ec_name?: string

    The name of the product.

    From the ec_name field.

  • ec_price?: number

    The base price of the product.

    From the ec_price field.

  • ec_product_id?: string

    The product ID.

  • ec_promo_price?: number

    The promotional price of the product.

    From the ec_promo_price field.

  • ec_rating?: number

    The product rating, from 0 to 10.

    From the ec_rating field.

  • ec_shortdesc?: string

    A short description of the product.

    From the ec_shortdesc field.

  • ec_thumbnails?: string[]

    The URLs of the product image thumbnails.

    From the ec_thumbnails field.

Unsubscribe

Call signatures

  • (): void;