Catalog Profile API

The Catalog Profile API uses the catalogCode, which is a unique code that identifies a catalog, to generate its data profile and cache it. You define a catalogCode when you create a sales catalog. The data profile of a catalog consists of various details combined into a single object.

The data profile contains such information as:

  • List of offer IDs related to the catalog.

  • Rule sets attached to offers.

  • Metrics:

    • Number of promotions in the catalog.

    • Number of products in the catalog.

    • Number of parent-child items in the catalog.



If you specify just one of these two parameters, it will follow the behavior described in the following table and accept your defined time for the parameter you specified. If you are using one or both parameters, you must specify them with the same values for all of the Populate Cache APIs in this sequence.

effectiveStartTime2001-07-04T12:08:56Current date and timeOptionaleffectiveStartTime is the time that you want your cached catalog entries to be effective. It should be in the UTC date-time format. Your effectiveStartTime must occur after the current time for which you are executing the Populate Cache APIs or you will receive an error message.
expirationTime2001-07-04T12:08:56effectiveStartTime + TimeToLiveOptionalexpirationTime is the time that you want your cached catalog entries to expire. It should also be in the UTC date-time format. Your expirationTime must occur after your effectiveStartTime or you receive an error message. TimeToLive is a custom setting created in CPQ Configuration Setup. It has a default value of 30 days.

Here is an example of how to pass the URI parameters:

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

This API can be run in parallel for multiple catalogs. For example, if you have 100 catalogs (Catalog1, Catalog2..Catalog 100), you can run the API for all 100 catalogs in 100 parallel threads.


This example shows the JSON of catalog data profile containing the offers and metadata information:

500Internal Server Error