Consumer Goods Cloud Developer Guide
jWinter '27 preview (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Get Started with Consumer Goods Cloud
cgcloud__Account_Sub_Account__c
cgcloud__Account_Plan__c
cgcloud__Account_Plan_Category__c
cgcloud__Account_Plan_User_Filter__c
cgcloud__Account_Product_Profile__c
cgcloud__Auto_Number_Sequence__c
cgcloud__Business_Year__c
cgcloud__Condition_Search_Group__c
cgcloud__Condition_Search_Rule__c
cgcloud__Custom_Period__c
cgcloud__Custom_Calendar__c
cgcloud__Fund__c
cgcloud__Fund_Product__c
cgcloud__Fund_Template__c
cgcloud__Fund_Transaction__c
cgcloud__Fund_Transaction_Header__c
cgcloud__Fund_Transaction_Row__c
cgcloud__Fund_Transaction_Template__c
cgcloud__KPI_Definition__c
cgcloud__KPI_Map__c
cgcloud__KPI_Set__c
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Payment_Template__c
cgcloud__Payment__c
cgcloud__Payment_External_Reference__c
cgcloud__Payment_Tactic__c
cgcloud__Payment_Tactic_Fund__c
cgcloud__Payment_Tactic_Product__c
cgcloud__Payment_Tactic_Product_Manual_Input__c
cgcloud__Product_Part__c
cgcloud__Product_Assortment_Product_Share__c
cgcloud__Promotion_Calculation_Server_Offset__c
cgcloud__Promotion_Product_Share__c
cgcloud__Promotion_Push_Status__c
cgcloud__Rate_Based_Funding__c
cgcloud__RBF_Template__c
cgcloud__RBF_Category__c
cgcloud__RBF_Product_Manual_Input__c
cgcloud__RTR_Report_Configuration__c
cgcloud__Smart_UI_Lightning_Settings__c
cgcloud__Tactic_Fund__c
cgcloud__Tactic_Condition_Creation_Definition__c
cgcloud__Tactic_Product_Condition__c
cgcloud__Tactic_Template_Cond_Creation_Def__c
cgcloud__Tactic_Template_Fund_Template__c
cgcloud__UI_Contract__c
cgcloud__User_View__c
cgcloud__View__c
cgcloud__Week_Day_Share_Profile__c
Derive and Copy Promotions with MetadataWizard and Business Object API
API End-of-Life Policy
Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Custom Objects for Trade Promotion Management
The Consumer Goods Cloud data model provides objects and fields to support Trade
Promotion Management (TPM).
To learn about the custom objects that are common between Retail Execution and Trade Promotion Management, refer to Custom Objects for Retail Execution and Trade Promotion Management
-
cgcloud__Account_Sub_Account__c
Defines the account to sub-account relationship. This object is available in API version 54.0 and later. -
cgcloud__Account_Plan__c
Contains the details of the account data for one planning account, one business year and one or multiple categories. This object is available in API version 54.0 and later. -
cgcloud__Account_Plan_Category__c
Categories of the account plan including the manual inputs. Categories can be assigned to an account plan. A category can only be assigned to one account/business year combination. This object is available in API version 54.0 and later. -
cgcloud__Account_Plan_User_Filter__c
Contains the filter selections of a user for a planning account. This object is available in API version 54.0 and later. -
cgcloud__Account_Product_Profile__c
This object stores statistical profiles that indicate the distribution of weekly data between a customer and category. This object is available in API version 54.0 and later. -
cgcloud__Auto_Number_Sequence__c
Stores information about the numbered index of the next transaction log record. This object is available in API version 54.0 and later. -
cgcloud__Business_Year__c
This object stores the attributes of the Business Year. This object is available in API version 54.0 and later. -
cgcloud__Condition_Search_Group__c
Holds the attributes of Condition Search Group. This object is available in API version 55.0 and later. -
cgcloud__Condition_Search_Rule__c
Holds the attributes of Condition Search Rule. This object is available in API version 55.0 and later. -
cgcloud__Custom_Period__c
This object stores the attributes of the custom period. This object is available in API version 54.0 and later. -
cgcloud__Custom_Calendar__c
This object stores the attributes of the custom calendar. This object is available in API version 54.0 and later. -
cgcloud__Fund__c
A fund is the amount of money that's given to an employee for a special reason during a specific business period. This money is used to pay special activities such as promotion campaigns. This object is available in API version 54.0 and later. -
cgcloud__Fund_Product__c
A Fund object can be linked to multiple brands or categories based on the fund template settings. This object is available in API version 54.0 and later. -
cgcloud__Fund_Template__c
Template for the creation of a Fund. This object is available in API version 54.0 and later. -
cgcloud__Fund_Transaction__c
Holds the fund transaction details. This object is available in API version 54.0 and later. -
cgcloud__Fund_Transaction_Header__c
Fund Transaction Header object facilitates the creation of multiple fund transactions in either a multiple source or target fund business scenario. This object dictates key fields such as the fund transaction template. The source or target funds for the fund transaction records to be created are based on transaction types such as Transfer, drawback, and more. This object is available in API version 54.0 and later. -
cgcloud__Fund_Transaction_Row__c
Transaction rows for the funds. This object is available in API version 54.0 and later. -
cgcloud__Fund_Transaction_Template__c
Template for the creation of a transaction for the Fund. This object is available in API version 54.0 and later. -
cgcloud__KPI_Definition__c
Contains the description of a single measure. The fields of the table can be derived from the current KPI_Set .json file. This object is available in API version 54.0 and later. -
cgcloud__KPI_Map__c
Holds the information about the KPI Map configuration. This object is available in API version 54.0 and later. -
cgcloud__KPI_Set__c
This table contains information about KPI Set Configuration. This object is available in API version 54.0 and later. -
cgcloud__KPI_Set_KPI_Definition__c
Junction object between KPI Definition and KPI Definition Set. This object is available in API version 54.0 and later. -
cgcloud__Payment_Template__c
Stores the details of the payment template that's to be used for payments. This object is available in API version 54.0 and later. -
cgcloud__Payment__c
This object stores the value that retailers expect as compensation for running promotions, which are executed by using tactics. This object is available in API version 54.0 and later. -
cgcloud__Payment_External_Reference__c
This object contains the hyperlinks that are related to a payment record. This object is available in API version 54.0 and later. -
cgcloud__Payment_Tactic__c
This object represents the relationship between Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. -
cgcloud__Payment_Tactic_Fund__c
This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. -
cgcloud__Payment_Tactic_Product__c
This object contains payment tactic products and assigned values at the LDP level or at the level that the project defines as payment product level. This object is available in API version 54.0 and later. -
cgcloud__Payment_Tactic_Product_Manual_Input__c
Stores manual inputs for payment tactic-specific manual inputs. This object is available in API version 54.0 and later. -
cgcloud__Product_Part__c
Stores the details of the relationship between two products. Describes which and how many products (ChildPKey) are assembled into a parent product (ParentPKey). In comparison to a product assortment, the result is a real product. This relation is only used as information; it can't be used to define a set of products to be used in other applications. This object is available in API version 54.0 and later. -
cgcloud__Product_Assortment_Product_Share__c
This object stores the details of categories that are assigned to a Product assortment. This object is available in API version 54.0 and later. -
cgcloud__Promotion_Calculation_Server_Offset__c
Stores the time range during which the server (Offplatform) calculates a Promotion. This object is available in API version 54.0 and later. -
cgcloud__Promotion_Product_Share__c
This object holds the details of categories that are assigned to a promotion. This object is available in API version 54.0 and later. -
cgcloud__Promotion_Push_Status__c
Contains for each push process an entry that contains the status and statistics for the push. This object is available in API version 54.0 and later. -
cgcloud__Rate_Based_Funding__c
This object stores general information along with metadata that's associated with the RBF Template from which it was created. This object is available in API version 54.0 and later. -
cgcloud__RBF_Template__c
Creation template for Rate-based Funding (RBF) records. This object is available in API version 54.0 and later. -
cgcloud__RBF_Category__c
Junction object between Rate Based Funding and Product for driving RBF and Product association. This object is available in API version 54.0 and later. -
cgcloud__RBF_Product_Manual_Input__c
This object represents the junction between Rate-based Funding and Product. This object is available in API version 54.0 and later. -
cgcloud__RTR_Report_Configuration__c
This object contains Real Time Report (RTR) Configurations. One record defines the data that's to be loaded for a report and what or how it gets shown in a declarative manner. This object is available in API version 54.0 and later. -
cgcloud__Smart_UI_Lightning_Settings__c
Internal Object contains Smart UI configurations. This object is available in API version 54.0 and later. -
cgcloud__Tactic_Fund__c
This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. -
cgcloud__Tactic_Condition_Creation_Definition__c
Holds the details of tactic condition creation definition. This object is available in API version 55.0 and later. -
cgcloud__Tactic_Product_Condition__c
Use this object to store the internal conditions that are generated out of promotions. This object is available in API version 54.0 and later. -
cgcloud__Tactic_Template_Cond_Creation_Def__c
Contains the configuration of condition creation definitions that will be generated for the related tactic. This object is available in API version 55.0 and later. -
cgcloud__Tactic_Template_Fund_Template__c
Junction object between tactic template and fund template. This object defines the valid fund types for the given tactic template. This object is available in API version 54.0 and later. -
cgcloud__UI_Contract__c
This object contains the contract information for templates that are used in the smart UI. This object is available in API version 54.0 and later. -
cgcloud__User_View__c
This object is a User and View relation junction object. This object is available in API version 54.0 and later. -
cgcloud__View__c
This object stores the filter criteria for the trade calendar. This object is available in API version 54.0 and later. -
cgcloud__Week_Day_Share_Profile__c
Contains statistical profiles of the distribution of weekly data among different days of a week. This object is available in API version 54.0 and later.