ProductUpdateExtension reference

This article provides reference material about ProductUpdateExtension class. All product update extensions have to be inherited from the ProductUpdateExtension which, in turn, inherits from the core Sana Extension class.

Properties

SourceName

The name of the data source being checked during the product index task.

public override string SourceName => "CustomProductUpdate";

Note

The "CustomProductUpdate" constant is the name that is used in this tutorial, but in real life add-ons it should be replaced with the name of the appropriate service that the add-on integrates with.

Methods

GetUpdatedProductsCount

Gets the total number of products that have been modified during the specified time period. This method does not require mandatory implementation, it is called by the product import task and the total count is needed for batching. If the value cannot be retrieved or is not overridden in a derived class, it returns null.

Only products with identifiers greater than and not including the lastProcessedId should be counted. If this value is null, all products modified in the specified time period should be counted. The modifiedAfter and modifiedBefore parameters specify the date/time range including boundaries in which the products were modified.

public override int? GetUpdatedProductsCount(string? lastProcessedId, DateTime modifiedAfter, DateTime modifiedBefore)
{
}

GetNextUpdatedProductIds

Gets the list of product IDs in alphabetical order greater than and not including the lastProcessedId and modified in the external product management system after modifiedAfter but before modifiedBefore including boundaries.

public override IList<string> GetNextUpdatedProductIds(string lastProcessedId, DateTime modifiedAfter, DateTime modifiedBefore)
{
}