Derive Change Entities API

The Derive Change Entities API derives the scope of the impacted entities from the unprocessed CachedAPIChange Ids received from the GetCatalog Change API.

This API takes the catalog changes as input in the request body and derives the scope of the impacted cache records. For example, if you modified the pricing of an offer due to the PriceListEntry(PLE) change, then the impacted scope entity would be the pricing of the offer to which that PLE is associated and the baskets containing that offer.

You can obtain the List<cachedAPIChangeIds> or cachedAPIChangeIds required in the request body of this API from the cachedAPIChangeIds node in the response body of the GetCatalog Change API.

You must first run the GetCatalog Change API to obtain the List<cachedAPIChangeIds> or cachedAPIChangeIds required in the request body of this API.

/services/apexrest/vlocity_cmt/v3/admin/catalogs/regenerate/deriveChange

POST

This is a sample post for cachedAPIChangeIds.

cachedAPIChangeIds contain the ID of the cached API change object, which could be a list of changes.

This is sample input with the ID of the cached API change object.

This is an example of how you invoke the API using Apex:

You can run this API in parallel for different cachedAPIChangeIds. For example, if there are 100 unprocessed cachedAPIChange entries from GetCatalogChangeAPI (CAC1, CAC2.....CAC100), you can run parallel threads of the Derive Change API with each individual cachedAPIChangeIds.

If you are executing APIs in parallel using an orchestrator, you must use the uniqueDeriveIds parameter. This parameter ensures that duplicate records are not created and processed.

For example:

The return status indicates success or failure with a reason for the error. List<Id> of records contains the unprocessed Id of the CachedAPIChange__c object.