The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Get Catalog Change API

The Get Catalog Change API defines all offer and availability changes applicable to your catalogs by getting all the distinct unprocessed Catalog changes made on Salesforce Objects (Subjects). Some examples of changes include offer or bundle modifications such as changes in description, attachments, and cardinality changes. Additionally, this API defines any changes that impact the eligibility or effectivity of an offer.

For this API to function properly, set the custom setting CacheAPI.RegenerateBatchCacheProcessor to True. When set to True, the API registers the catalog change as a simpleOffer or availability for those SObjects that could lead to a catalog-level change during derivation. This custom setting is applicable for Cache Management APIs (Regenerate APIs) only to avoid processing all the catalog level jobs during the Regeneration API.

  • simpleOffer: Changes made in the offer or bundle structure that only affect the properties of an offer, such as a change in description, attachments, cardinality changes, etc.

  • availability: Changes that impact the eligibility or effectivity of an offer in a catalog.

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

GET

ParameterExampleDefaultOptional/RequiredNotes
pageSize/services/apexrest/h_cpq/v3/admin/catalogs/regenerate/catalogChange?pageSize=105OptionalBy default, this API returns five catalog changes at a time
offset/services/apexrest/h_cpq/v3/admin/catalogs/regenerate/catalogChange?pageSize=10&offset=00Optional

This example shows how you can specify pageSize and offset parameters for this API if you wish to customize which catalog changes it returns and how many.

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

You can run this API in parallel for different sets of pageSize and offset. For example, if there are 100 cachedAPIChange entries (CAC1, CAC2.....CAC100), default pageSize =10, and offset is 0, then you can run parallel threads for the GetCatalog Change API with different offset values.

HeaderDescription
Content-Typeapplication/json

The sample output shows cached API change Ids. returnStatus indicates success or failure with an error reason. List <Id> of records contains the unprocessed Id of the CachedAPIChange__c object.

CodeDescription
200OK
500Internal Server Error