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.
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.