Coveo Commerce Query

This is for:

Developer System Administrator
Warning
Legacy feature

This article pertains to the Coveo Hive framework which is now in maintenance mode.

Choose one of Coveo’s more modern, lightweight, and responsive libraries for any future search interface development. See the search interface Implementation guide for more details.

Coveo for Sitecore 5.0.761.5

Implements the Coveo JavaScript Search Framework CommerceQuery component, which sets the originLevel2 and the customData[context_listing] values in the call to the Coveo Usage Analytics service.

Usage notes

  • The Coveo for Sitecore Analytics rendering must be added to the page. The Coveo Commerce Query rendering only alters the search analytics call generated by the Coveo for Sitecore Analytics rendering.

Insertion location

Coveo Hive

The Coveo Commerce Query rendering is an Allowed Control in the following placeholder(s): UI Header, Recommendations Components

Example insertion sequence for the Coveo Commerce Query rendering.

Coveo Hive SXA

Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Commerce Query rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

Example insertion sequence for the Coveo Commerce Query rendering.

Data source options

Option name Description

Commerce query listing

See the listing component option.

Additional data attributes

Allows use of the Coveo JavaScript Search Framework CommerceQuery component options that aren’t directly available in the data source.

Sample generated HTML and corresponding visual output

<div class="CoveoCommerceQuery" data-listing="ACME Furniture"></div>

Sample API call via Coveo for Sitecore proxy:

Commerce Query Sample Usage Analytics Call | Coveo for Sitecore 5