Consumer Goods Cloud Developer Guide
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)
cgcloud__Account_Plan__c
cgcloud__Account_Plan_Category__c
cgcloud__Account_Plan_User_Filter__c
cgcloud__Account_Product_Profile__c
cgcloud__Account_Task__c
cgcloud__Account_Task_Template__c
cgcloud__Asset_Audit__c
cgcloud__Asset_Template__c
cgcloud__BO_API__c
cgcloud__BO_API_Entity__c
cgcloud__BO_API_Output_Entity__c
cgcloud__BO_API_Step_Input_Structure__c
cgcloud__BO_API_Transaction_Log__c
cgcloud__BO_API_Workflow__c
cgcloud__BO_API_Workflow_Entity__c
cgcloud__BO_API_Workflow_Step__c
cgcloud__BO_API_Workflow_Workflow_Step__c
cgcloud__Business_Year__c
cgcloud__Contract__c
cgcloud__Contract_Payment__c
cgcloud__Contract_Payment_Tactic__c
cgcloud__Contract_Payment_Template__c
cgcloud__Contract_Product__c
cgcloud__Contract_Tactic__c
cgcloud__Contract_Template__c
cgcloud__Custom_Period__c
cgcloud__Custom_Calendar__c
cgcloud__Field_Sales_Activity__c
cgcloud__Flatten_Org_Unit_Hierarchy__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__Inventory__c
cgcloud__Inventory_Control_Template__c
cgcloud__Inventory_Transaction__c
cgcloud__Inventory_Transaction_Template__c
cgcloud__Job_Definition_List__c
cgcloud__Job_Definition_List_Account__c
cgcloud__Job_Definition_List_Account_Set__c
cgcloud__Job_Definition_List_Product__c
cgcloud__Job_Definition_List_Template__c
cgcloud__Job_Definition_Template__c
cgcloud__Job_DL_Job_Definition_Template__c
cgcloud__Job_DL_Template_Def_Template__c
cgcloud__Job_List__c
cgcloud__Job_Template__c
cgcloud__KPI_Map__c
cgcloud__KPI_Set__c
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Order_Item_Inventory_Transaction__c
cgcloud__Order_Payment__c
cgcloud__Order_Payment_Inventory_Transaction__c
cgcloud__Order_Payment_Template__c
cgcloud__Order_Template_Order_Payment_Template__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_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__Route__c
cgcloud__Route_Account__c
cgcloud__Route_Template__c
cgcloud__RTR_Report_Configuration__c
cgcloud__Segmentation_Rule__c
cgcloud__Segmentation_Rule_Def__c
cgcloud__Segmentation_Rule_Def_Column__c
cgcloud__Segmentation_Rule_Template__c
cgcloud__Substitution__c
cgcloud__Tactic_Fund__c
cgcloud__Tactic_Product_Condition__c
cgcloud__Tactic_Template_Fund_Template__c
cgcloud__Tour__c
cgcloud__Tour_Check__c
cgcloud__Tour_Object_Reference__c
cgcloud__Tour_Template__c
cgcloud__Tour_Template_Object_Reference__c
cgcloud__Tour_Template_Tour_Check__c
cgcloud__Tour_Tour_Check__c
cgcloud__UI_Contract__c
cgcloud__User_Document__c
cgcloud__User_Document_Activity__c
cgcloud__User_Document_Template__c
cgcloud__User_Document_Template_Activity__c
cgcloud__User_View__c
cgcloud__Vehicle__c
cgcloud__Vehicle_Warehouse__c
cgcloud__View__c
cgcloud__Warehouse__c
cgcloud__Warehouse_Product__c
cgcloud__Warehouse_User__c
cgcloud__Week_Day_Share_Profile__c
API End-of-Life
Newer Version Available
Custom Objects for Future Use
The objects listed in this section are available in the org, but they are for internal
use only.
-
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__Account_Task__c
This objedt represents the details of the customer task (customer issue). This object is available in API version 54.0 and later. -
cgcloud__Account_Task_Template__c
Represents the details of the customer task template to be used for customer tasks. This object is available in API version 54.0 and later. -
cgcloud__Asset_Audit__c
Represents the details of an asset survey. This object is available in API version 54.0 and later. -
cgcloud__Asset_Template__c
An asset is a physical element that has a certain value which a manufacturer can place at a customer's location (retailer, bar, hotel, shop, and so on), and it can be associated to a POS (such as a shelf, cooler, fridge, and more). This object is available in API version 54.0 and later. -
cgcloud__BO_API__c
This table stores the header record of Business Object APIs. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Entity__c
This table stores the entity definitions of Business Object APIs. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Output_Entity__c
This table stores the output entities of the Business Object API. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Step_Input_Structure__c
This table stores the input structure configuration that the business object API workflow step expects. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Transaction_Log__c
This object stores information about Business Object API Transaction Log, which is a collection of one or more promotions that should be created or updated under the same name via the Promotion BO Creation API. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Workflow__c
This table stores the workflows that are defined for the Business Object. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Workflow_Entity__c
This object stores the entities that Business Object API Workflows use. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Workflow_Step__c
This table stores the definitions of the workflow step. This object is available in API version 54.0 and later. -
cgcloud__BO_API_Workflow_Workflow_Step__c
This table stores the junction object to identify the workflow steps that apply for each workflow. 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__Contract__c
Stores the details of the customer contract object, which is used to track various types of customer agreements. This object is available in API version 54.0 and later. -
cgcloud__Contract_Payment__c
Stores the details of the contract payment object. With this object, you can track the types of customer payment requests that are agreed via a contract. This object is available in API version 54.0 and later. -
cgcloud__Contract_Payment_Tactic__c
Stores the details of the relationship between a contract payment and contract tactics. By using this object, you can check the contract tactics for which the payment is applicable after the customer has fulfilled the agreement. This object is available in API version 54.0 and later. -
cgcloud__Contract_Payment_Template__c
Stores the details of the contract payment template, which is used for contract payments. This object is available in API version 54.0 and later. -
cgcloud__Contract_Product__c
Stores the details of the relationship between a customer contract and a product. With this object, you can capture product-specific agreements that are included in a customer contract. This object is available in API version 54.0 and later. -
cgcloud__Contract_Tactic__c
Relation between a Contract and a Tactic template. This object is available in API version 54.0 and later. -
cgcloud__Contract_Template__c
Contract and Tactic Templates object. This object is available in API version 54.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__Field_Sales_Activity__c
Stores the details of the field sales activity object. Field Sales Activity (FSA) covers a set of job definition lists. This object is available in API version 54.0 and later. -
cgcloud__Flatten_Org_Unit_Hierarchy__c
This object stores node org unit hierarchy information for the Customer Segmentation functionality. 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__Inventory__c
Stores the details of the inventory object. This object is available in API version 54.0 and later. -
cgcloud__Inventory_Control_Template__c
Stores the details of the inventory control template that's to be used for inventories. This object is available in API version 54.0 and later. -
cgcloud__Inventory_Transaction__c
Captures Inventory Transaction records. This object is available in API version 54.0 and later. -
cgcloud__Inventory_Transaction_Template__c
Stores the details of the inventory control template that's to be used for inventory control transactions. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_List__c
Stores the set of questions or surveys that are to be carried out in the respective call and contains further relevant configurations. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_List_Account__c
Stores the details of the relationship between job definition list and customer. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_List_Account_Set__c
Junction object between Job Definition List and Customer Set. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_List_Product__c
Stores the details of the relationship between the Job Definition List and Product related lists. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_List_Template__c
Template that controls the behavior of Job definition lists. This object is available in API version 54.0 and later. -
cgcloud__Job_Definition_Template__c
Stores the definition of questions or product surveys that are available in the system. This object is available in API version 54.0 and later. -
cgcloud__Job_DL_Job_Definition_Template__c
This object stores the questions or surveys that are used in the job definition list. This object is available in API version 54.0 and later. -
cgcloud__Job_DL_Template_Def_Template__c
Stores the list of job definition templates in the Job definition list template. When creating a job definition list based on this template, the assigned job definition templates are used to preset job definitions. This object is available in API version 54.0 and later. -
cgcloud__Job_List__c
Stores the job lists that are generated from non-standard job definition lists. This object is available in API version 54.0 and later. -
cgcloud__Job_Template__c
Stores whether a job is to be considered as either a task, a question, a product related question (survey), or any other object related job like capturing orders. 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__Order_Item_Inventory_Transaction__c
Holds the association details for the order item template, the inventory control template, and the inventory transaction template. This object is available in API version 54.0 and later. -
cgcloud__Order_Payment__c
Holds the attributes of the Order Payment object. This object is available in API version 54.0 and later. -
cgcloud__Order_Payment_Inventory_Transaction__c
Holds the association details for the order payment template, the inventory template, and the inventory transaction template. This object is available in API version 54.0 and later. -
cgcloud__Order_Payment_Template__c
Holds the attributes of the order payment template. This object is available in API version 54.0 and later. -
cgcloud__Order_Template_Order_Payment_Template__c
Holds the association details for the order template and the order payment template. 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 reflects 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 by which and how many other products (ChildPKey) that a product (ParentPKey) is assembled together (bill of material). 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_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__Route__c
Stores the details of the route object. This object is available in API version 54.0 and later. -
cgcloud__Route_Account__c
Stores the details of the relationship between routes and customers. This object is available in API version 54.0 and later. -
cgcloud__Route_Template__c
Stores the details of the route template object that's to be used for routes. 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__Segmentation_Rule__c
This object stores the details of the segmentation rule. This object is available in API version 54.0 and later. -
cgcloud__Segmentation_Rule_Def__c
Contains the available queries and its attributes to create segmentation rules. This object is available in API version 54.0 and later. -
cgcloud__Segmentation_Rule_Def_Column__c
This object defines the query attributes of the Segmentation Rule Definition. This object is available in API version 54.0 and later. -
cgcloud__Segmentation_Rule_Template__c
This object contains information that configures the behavior for the associated segmentation rules. This object is available in API version 54.0 and later. -
cgcloud__Substitution__c
The use case stores the details of the substitute object that specifies the basis of a substitution depending on a substitution period and user. 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_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_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__Tour__c
Stores the details of the tour object. This object is available in API version 54.0 and later. -
cgcloud__Tour_Check__c
Stores the details of the tour check object that's used as part of tour execution for tour checking. This object is available in API version 54.0 and later. -
cgcloud__Tour_Object_Reference__c
Stores the details of the object references of a tour. This object is available in API version 54.0 and later. -
cgcloud__Tour_Template__c
Stores the details of the tour template object that's to be used for tours. This object is available in API version 54.0 and later. -
cgcloud__Tour_Template_Object_Reference__c
Stores the details of the object references of a tour template. This object is available in API version 54.0 and later. -
cgcloud__Tour_Template_Tour_Check__c
Stores the details of the relationship between tour template and tour check, which is used to define the relevant tour checks on a tour. This object is available in API version 54.0 and later. -
cgcloud__Tour_Tour_Check__c
Stores the details of the relationship between tour and tour check. 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_Document__c
Stores the details of the daily report object. This object is available in API version 54.0 and later. -
cgcloud__User_Document_Activity__c
Stores the details of the relationship between the daily report and user activity. This object is available in API version 54.0 and later. -
cgcloud__User_Document_Template__c
Stores the details of the daily report template, which is to be used for daily reports. This object is available in API version 54.0 and later. -
cgcloud__User_Document_Template_Activity__c
Stores the details of the relationship between the daily report template and user activity. 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__Vehicle__c
Stores the details of the vehicle object. This object is available in API version 54.0 and later. -
cgcloud__Vehicle_Warehouse__c
This object stores the relationship between a vehicle and a warehouse. 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__Warehouse__c
Stores the details of the warehouse object. An organizational segmentation for the purpose of maintaining materials that are stored in different places. This object is available in API version 54.0 and later. -
cgcloud__Warehouse_Product__c
Stores the relationship between a warehouse and a product. This object is available in API version 54.0 and later. -
cgcloud__Warehouse_User__c
Stores the details of the relationship between a warehouse and a user. 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.