---
schema_version: "1"
id: 00d1a4acf0c35ba880219c07e17219d787b206fd5a5e5b25f57424615ae58748
title: Retrieving Additional Product2 or Promotion Fields
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries/cme/guides/comms-t-retrieving-additional-product2-or-promotion-fields.md
canonical_url: https://developer.salesforce.com/docs/industries/cme/guide/comms-t-retrieving-additional-product2-or-promotion-fields.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: ab6a6bbc0b63235dfd48fdb64f2b962105a025d51bfa4b3696596255d6d1c5bf
products:
  - Communications, Media, Energy and Utilities APIs (Managed Package)
  - Industries Developer Documentation
---
# Retrieving Additional Product2 or Promotion Fields

To return additional Product2 or Promotion fields that are not returned by default, use the [GetOffersByCatalog](https://developer.salesforce.com/docs/industries/cme/guide/comms-t-get-offers-by-catalog-api.md) and [GetOfferDetails](https://developer.salesforce.com/docs/industries/cme/guide/comms-t-get-offer-details-api.md) APIs.

For the response to contain additional fields from the Product2 or Promotion objects, you must first specify the fields as part of the GetOffersByCatalog or GetOfferDetails API metadata. Once configured, rerun the API Response Batch jobs to populate the cache response.

To return additional Product2 or Promotion fields:

1.  Navigate to the **All Tabs** page by clicking the **+** icon.

2.  From the list of tabs, select **Vlocity API Metadata**. The list of API objects is displayed.

    If the Vlocity API Metadata tab is not shown in the All Tabs list, see the [Creating a Custom Object Tab](https://help.salesforce.com/articleView?id=creating_custom_object_tabs.htm&type=5) topic in the Salesforce help.

3.  To display the metadata fields, select **All** from the Select Views list.

    ![Vlocity API Metadata fields](https://developer.salesforce.com/docs/media/api_metadata_lightning.png)

4.  Click the GetOffers API Name then select the **Edit** icon next to **API Params**.

5.  In the **API Params** field, enter the Product2 or Promotions fields that you want to retrieve using the API call. For example, to return the fields **IsActive** and **Family** from the Product2 catalog enter the following in the **API Params** field:

    ```nolang
    {"productFields":["IsActive","Family"]}
    ```

    You can return Promotion fields in a similar manner:

    ```nolang
    {"promotionFields":["pricelist","Service_continuation"]}
    ```

6.  From the Vlocity CMT Administration screen, click **Maintenance Jobs** and then click **Start** next to **Clear Managed Platform Cache**.

7.  From the Vlocity CMT Administration screen, click **Cacheable API** Jobs, then click **Start** next to **Delete Expired API Cache**.

8.  From the Vlocity CMT Administration screen, click **Cache Catalog Product Definition**, and run `Generate Catalog Product Definitions` job.

9.  Run the GetOffersByCatalog or GetOfferDetails API. The additional fields are displayed in the JSON output.

    Only fields that are populated in the catalog are displayed in the API results. The API does not return empty or undefined fields.

    **note:** Do not run the **Load API Metadata** job. Doing so will overwrite the data you specified in the API metadata field.

    **note:** The APIParms metadata returned by the GetOffers API overwrites the metadata returned by the Get Contains Products API. That is, if the APIParams field is configured with a specific value, and the GetOffers API is run, the metadata from GetOffers overwrites the metadata for the Get Contains Products API.