Overview

The int_algolia cartridge keeps your site’s data in sync with Algolia.

Key concepts

• B2C object. A business object of any B2C class such as Product, Pricebook, ProductInventoryList, or ProductInventoryRecord. A Product object has built-in and custom attributes, such as ID, name, shortDescription, longDescription, and more.

• Algolia product record. The JSON product object stored in the Algolia index. It has a different structure to that of a B2C Product object and contains all relevant data you configure the jobs to export, such as price, in_stock. Some of these attributes are simple values and some are more complex, see Indexing attributes.

Overview of the indexing jobs

AlgoliaProductIndex_v2

This job performs a full catalog update.

For more details, see Full catalog indexing.

AlgoliaProductDeltaIndex_v2

This job performs delta updates on your Algolia product records using the B2C Delta Export feature.

For more details, see Ongoing indexing.

AlgoliaProductPriceIndex_v2

This job updates price information for all your Algolia products.

For more details, see Ongoing indexing.

AlgoliaProductInventoryIndex_v2

This job updates inventory information for all your Algolia products.

For more details, see Ongoing indexing.

AlgoliaCategoryIndex_v2

This job updates your category indices.

For more details, see Ongoing indexing.

What data does the cartridge send?

For details on which attributes get indexed by default and how to extend them, see Indexing attributes.

Indexing performance considerations

For guidance on optimizing indexing performance, see Performance considerations.