Push and update your catalog data

This is for:

Developer
In this article

To push or update your catalog data in your source (typically a Catalog source), you have to interact with the Coveo Stream API.

The Coveo Stream API supports several operations for managing your catalog data. The following table indicates the operations available in the Coveo Stream API depending on whether you want to perform full or partial updates:

Update type Operation

Full catalog data updates

Update (recommended)

Load

Partial catalog data updates

Partial item updates

Shallow merge

Usage

The following table maps which operation to use depending on your use case:

Operation Use case

Update

  • Push your catalog data to your source.

  • Update the entire catalog data in your source via multiple update operations.

  • To update all the fields in a given item.

  • Add and delete items.

Load

To overwrite the entire catalog data in your source with the provided data.
This operation shouldn’t be used for sources with more than 1,000,000 items, as it may lead to timeouts, excessive memory usage, or degraded performance.

Tip
Leading practice

Update operations provide the same benefits as the load operation but with better performance and fewer limitations.

Partial item updates

To update one or more fields in a given item without overwriting the entire item.
This is useful when you want to update only specific fields without affecting the rest of the item data.

Shallow merge

To update one or more fields in an item.
This operation should be used when it’s impossible to validate the existence of an item in the source before partially updating it.
It can be used only with the Catalog source.

Required privileges

The following table indicates the privileges required for your organization's groups to view or edit elements of the Catalogs (platform-ca | platform-eu | platform-au) page and its associated panels (see Manage privileges and Privilege reference). The Commerce domain is only available to organizations in which Coveo for Commerce features are enabled.

Action Service - Domain Required access level

View catalogs

Commerce - Catalogs
Content - Sources
Content - Fields
Organization - Organization

View

Edit catalogs

Content - Fields
Content - Sources
Organization - Organization

View

Commerce - Catalogs

Edit

Search - Execute Query

Allowed