---
schema_version: "1"
id: b476b7bfc7b6c5dcc48eaff96573137180f34038adfb5073fe920fd28f340b44
title: Populate API Cache
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/ind/264-0-0/comms_populate_api_cache.md
canonical_url: https://help.salesforce.com/s/articleView?id=ind.comms_populate_api_cache.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 138b30e39ee3264dff95a1ee8b105b1ea9bcc794a2af8da0d0ccfdc73e380047
description: This job processes existing data and populates the API cache as part of Digital Commerce Cache Management.
products:
  - Communications
  - Media
  - Energy and Utilities
release: "264"
---
# Populate API Cache

This job processes existing data and populates the API cache as part of Digital Commerce Cache Management.

Before running the Populate API Cache job, run these jobs:

- [Product Hierarchy Maintenance](https://help.salesforce.com/s/articleView?id=ind.comms_product_hierarchy_maintenance.htm&release=264.0.0&type=5 "This job builds a streamlined version of the product hierarchies in the Data Store sObjects, enabling the (formerly ) and Refresh Platform Cache (Incremental) jobs to use the hierarchy data.")
- [Clear Managed Platform Cache](https://help.salesforce.com/s/articleView?id=ind.comms_clear_managed_platform_cache.htm&release=264.0.0&type=5 "This job clears the org cache in the CPQPartition platform cache. The job does not affect other cache partitions.")
- [Refresh Platform Cache (Full)](https://help.salesforce.com/s/articleView?id=ind.comms_refresh_platform_cache_full.htm&release=264.0.0&type=5 "This job copies product hierarchy data to the platform cache and rebuilds the product attribute cache.") or [Refresh Platform Cache (Incremental)](https://help.salesforce.com/s/articleView?id=ind.comms_refresh_platform_cache_incremental.htm&release=264.0.0&type=5 "The Refresh Platform Cache (Incremental) job updates the platform cache with changes in the product hierarchy without deleting existing data. Run the Product Hierarchy Maintenance job before you start the Refresh Platform Cache (Incremental) to ensure that changes to product bundles are properly reflected in your implementation.")
- [Load API Metadata](https://help.salesforce.com/s/articleView?id=ind.comms_load_api_metadata.htm&release=264.0.0&type=5 "This populates the Vlocity API Metadata table as part of Digital Commerce Cache Management.")

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
      <colgroup>
        <col style="width:50%">
        <col style="width:50%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d285376e98">
            <p style="margin-bottom:0;">Applies to</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d285376e104">
            <p>All releases</p>
            <p style="margin-bottom:0;">By default, the Populate API Cache jobs are
              run for all catalogs.</p>
          </th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">Apex Name</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <p style="margin-bottom:0;"><span class="apiname">populateCacheCAJob</span> in
              <span class="apiname">TelcoAdminConsoleHandler</span>
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">Where to Run This Job</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <p style="margin-bottom:0;">Cacheable API Jobs link on the CMT Administration tab.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">Risks of Running This
              Job</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <p style="margin-bottom:0;">The cache will be cleared and repopulated, but you will not lose any
              data. There will be a temporary performance impact in a production
              environment. Run this job only during a maintenance window.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">When Not to Run This
              Job</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <p style="margin-bottom:0;">Do not run this job if cacheable definitions are not ready to be
              cached. Only run this job once you have completed your product catalog
              configuration.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">When to Run This Job</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <p>Cached information is a snapshot of current cacheable definitions at
              the time caching was invoked. Run this job when definitions are ready or
              when testing the cached information is required. After running this job,
              you will see the status, creation and completion dates of the individual
              API cache jobs.</p>
            <p style="margin-bottom:0;">When you initially run this job, select the
              checkboxes for all cache job options because some of the jobs have
              dependencies on other jobs. You can select all options by selecting the
              <strong class="uicontrol">Name</strong> checkbox on the option list after clicking
              <strong class="uicontrol">Start</strong>.
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Applies to" class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e98 ">
            <p style="margin-bottom:0;">More Information</p>
          </td>

          <td data-label="All releases By default, the Populate API Cache jobs are run for all catalogs." class="slds-cell-wrap" style="vertical-align:top;" headers="d285376e104 ">
            <ul>
              <li>
                <p>This job calls cache handlers that cache the catalog and product
                  information, such as product structure, cardinality, rules,
                  attributes, and pricing.</p>
              </li>

              <li>
                <p>All cache handlers must be selected and cached at least
                  once.</p>
              </li>

              <li>
                <p>The dependency order of handlers is descending.</p>
              </li>

              <li>
                <p>You must clear the entire contents of the cache response object if
                  you make changes to the product catalog data.</p>
              </li>

              <li>
                <p>For more information on best practice, see <a href="https://help.salesforce.com/s/articleView?id=ind.comms_populate_api_cache_best_practices.htm&amp;release=264.0.0&amp;type=5" title="Enhance the usability of Populate API cache by following the Populate API cache best practices whenever possible.">Populate API Cache Best Practices</a>
                </p>
              </li>

            </ul>
          </td>

        </tr>
      </tbody>
    </table>

- **[Populate API Cache Best Practices](https://help.salesforce.com/s/articleView?id=ind.comms_populate_api_cache_best_practices.htm&release=264.0.0&type=5)**  
    Enhance the usability of Populate API cache by following the Populate API cache best practices whenever possible.