The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.
The commerce analytics configuration.
Optional
cartThe initial cart state to restore.
The commerce context options.
Optional
environmentThe environment in which the organization is hosted.
The dev
and stg
environments are only available internally for Coveo employees (e.g., Professional Services).
Defaults to prod
.
Optional
nameThe Engine name (e.g., myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.
The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3
)
Optional
preprocessAllows for augmenting a Platform request before it is sent.
Optional
proxyThe base URL to use to proxy Coveo commerce requests (e.g., https://example.com/commerce
).
This is an advanced option that you should only set if you need to proxy Coveo commerce requests through your own server. In most cases, you should not set this option.
By default, no proxy is used and the Coveo commerce requests are sent directly to the Coveo platform through the
platform organization endpoint resolved from the organizationId
and
environment
values provided in your engine configuration (i.e.,
https://<organizationId>.org.coveo.com
or
https://<organizationId>.org<environment>.coveo.com
, if the environment
values is specified and
different from prod
).
If you set this option, you must also implement the following proxy endpoints on your server, otherwise the commerce engine will not work properly:
POST
/facet
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/facet
POST
/listing
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/listing
POST
/productSuggest
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/productSuggest
POST
/querySuggest
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/querySuggest
POST
/recommendations
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/recommendations
POST
/search
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/commerce/v2/search
Optional
renewA function that fetches a new access token. The function must return a Promise that resolves to a string (the new access token).
The commerce engine configuration.