cgcloudPromotionc

Promotion is an activity of a user that includes the definition of prices for a time segment. This object is available in API version 54.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description Most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description Most recent date on which a user viewed this record.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Unique identification of the record.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
RecordTypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the record type of the record. This is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType
cgcloud__Active__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Decides whether a promotion is available. The default value is `true`.
cgcloud__Aggregation_Category__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores information about the aggregation category.
cgcloud__Anchor_Account_Set__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the customer set. This is a relationship field. Relationship Name cgcloud__Anchor_Account_Set__r Relationship Type Lookup Refers To cgcloud__Account_Set__c
cgcloud__Anchor_Account__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the customer. This is a relationship field. Relationship Name cgcloud__Anchor_Account__r Relationship Type Lookup Refers To Account
cgcloud__Commit_Date__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date on which the promotion was committed. This field is used to fetch the prices and discounts of a promotion.
cgcloud__Count_Tactics__c	Type double Properties Filter, Nillable, Sort Description Number of tactics associated with this promotion. This is a calculated field.
cgcloud__Custom1_Date_From__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date of a project-specific time range. For example, pre-dip.
cgcloud__Custom1_Date_Thru__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date of a project-specific time range. For example, pre-dip.
cgcloud__Custom2_Date_From__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date of a project-specific time range. For example, pre-dip.
cgcloud__Custom2_Date_Thru__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date of a project-specific time range. For example, pre-dip.
cgcloud__Date_From__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Promotion date from.
cgcloud__Date_Thru__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Promotion date thru.
cgcloud__Delivery_Date_From__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Delivery date from.
cgcloud__Delivery_Date_Thru__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Delivery date thru.
cgcloud__Effective_Brands__c	Type textarea Properties Create, Nillable, Update Description Stores a list (JSON array) of the effective Brand SfIds for this promotion.
cgcloud__Effective_Categories__c	Type textarea Properties Create, Nillable, Update Description Stores a list (JON array) of the effective Category Sf IDs for this promotion.
cgcloud__ExternalId__c	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description ID of the promotion that's used as a reference in external systems. Integration uses this ID to import tactic-specific actuals into the offplatform back end.
cgcloud__Filter_Criteria__c	Type textarea Properties Create, Nillable, Update Description Stores the .json file that's used to apply product filters for the promotion.
cgcloud__Group_Text_Language_1__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the Group Text in language 1.
cgcloud__Group_Text_Language_2__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the Group Text in language 2.
cgcloud__Group_Text_Language_3__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the Group Text in language 3.
cgcloud__Group_Text_Language_4__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the Group Text in language 4.
cgcloud__Group_Text__c	Type string Properties Filter, Nillable, Sort Description Formula. This is a calculated field. Formula `1CASE($User.cgcloud__Language_Postfix__c, 2"Language1", cgcloud__Group_Text_Language_1__c, 3"Language2", BLANKVALUE(cgcloud__Group_Text_Language_2__c,cgcloud__Group_Text_Language_1__c), 4"Language3", BLANKVALUE(cgcloud__Group_Text_Language_3__c,cgcloud__Group_Text_Language_1__c), 5"Language4", BLANKVALUE(cgcloud__Group_Text_Language_4__c,cgcloud__Group_Text_Language_1__c), 6cgcloud__Group_Text_Language_1__c)`
cgcloud__In_Calculation_Time_Frame__c	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Checks the condition for calculation-relevant promotions within the offset timeframe (90 days) from today's date, and returns a boolean value. This is a calculated field. Formula `1IF(((TODAY() - $Setup.cgcloud__Promotion_Calculation_Server_Offset__c.cgcloud__Days_Before__c) <= cgcloud__Date_Thru__c) && 2(cgcloud__Date_From__c <= (TODAY() + $Setup.cgcloud__Promotion_Calculation_Server_Offset__c.cgcloud__Days_After__c)), true, 3false)`
cgcloud__Is_Frozen__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a dynamic product set is to be frozen so that it can't be changed anymore. This can be set manually or via a a workflow rule. The default value is `false`.
cgcloud__Is_Locked__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the promotion is locked. The default value is `false`.
cgcloud__Is_Push_In_Progress__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the push process for this promotion is currently in progress. This attribute is applicable for pushable promotions. The default value is `false`.
cgcloud__KPI_Dirty__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is set as true whenever there is any modification in the promotion record. The default value is `false`.
cgcloud__KPI_Value_1__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Writeback Synchronized KPI 1.
cgcloud__KPI_Value_2__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Writeback Synchronized KPI 2.
cgcloud__KPI_Value_3__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Writeback Synchronized KPI 3.
cgcloud__KPI_Value_4__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Writeback Synchronized KPI 4.
cgcloud__Last_Push_Update_Executed__c	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Timestamp when the parent promotion was last pushed.
cgcloud__Last_Push_Update_Received__c	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Timestamp when the child promotion received the last push update.
cgcloud__Lock_Deletion__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Configures promotions to indicate whether a promotion deletion is locked based on phases. The default value is `false`.
cgcloud__Manual_Calculation_Input__c	Type textarea Properties Create, Defaulted on create, Nillable, Update Description Stores the configuration of manually updated KPIs in .json format.
cgcloud__Manual_Calculation_Input_2__c	Type textarea Properties Description Continuation of Manual_Calculation_Input__c. Filled if the manual calculation input .json is bigger than 128k. This field is available in API version 55.0 and later.
cgcloud__Manual_Calculation_Input_3__c	Type textarea Properties Description Continuation of Manual_Calculation_Input_2__c. Filled if the manual calculation input .json is bigger than 256k. This field is available in API version 55.0 and later.
cgcloud__Note__c	Type textarea Properties Create, Nillable, Update Description General notes about the promotion.
cgcloud__Order_Date_From__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Order date from.
cgcloud__Order_Date_Thru__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Order date thru.
cgcloud__Outdated_Staging_Records__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this attribute must be recalculated when conditions are changed. The default value is `false`.
cgcloud__Parent_Promotion__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the parent promotion. This is a relationship field. Relationship Name cgcloud__Parent_Promotion__r Relationship Type Lookup Refers To cgcloud__Promotion__c
cgcloud__Phase__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Phase of the promotion. Possible values are: `Cancelled` `Committed` `ForApproval`—For Approval `Modeling` `Planning` `Preparation` `Rejected` The default value is `Preparation`.
cgcloud__Placement_Date_From__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Placement date from.
cgcloud__Placement_Date_Thru__c	Type date Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Placement date thru.
cgcloud__Promotion_Template_Description__c	Type string Properties Filter, Nillable, Sort Description Stores the description of the selected promotion template. This is a calculated field. Formula `1cgcloud__Promotion_Template__r.cgcloud__Description__c`
cgcloud__Promotion_Template__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the promotion template. This is a relationship field. Relationship Name cgcloud__Promotion_Template__r Relationship Type Lookup Refers To cgcloud__Promotion_Template__c
cgcloud__Push_Target_Account_Selection__c	Type textarea Properties Create, Nillable, Update Description Only filled for Pushable promotions. Contains a .json file with the selected push target accounts.
cgcloud__Reference_Date__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Reference date that's used for hierarchy search. The date is retrieved from the promotion template used reference date field.
cgcloud__Relevant_For_Account_Plan__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the promotion is relevant for Account Plan Calculation. The default value is `true`.
cgcloud__Sales_Org__c	Type string Properties Filter, Nillable, Sort Description Sales org of the promotion. This is a calculated field. Formula `1TEXT (cgcloud__Promotion_Template__r.cgcloud__Sales_Org__c)`
cgcloud__Scenario_1_Manual_Inputs__c	Type textarea Properties Create, Nillable, Update Description Stores the promotion-specific manual input for Scenario 1.
cgcloud__Scenario_1_Parameters__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores scenario parameters for Scenario 1 in .json format.
cgcloud__Scenario_2_Manual_Inputs__c	Type textarea Properties Create, Nillable, Update Descriptio Stores promotion-specific manual input for Scenario 2.
cgcloud__Scenario_2_Parameters__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores scenario parameters for Scenario 2 in .json format.
cgcloud__Scenario_3_Manual_Inputs__c	Type textarea Properties Create, Nillable, Update Description Stores promotion-specific manual input for Scenario 3.
cgcloud__Scenario_3_Parameters__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores scenario parameters for Scenario 3 in .json format.
cgcloud__Scenario_4_Manual_Inputs__c	Type textarea Properties Create, Nillable, Update Description Stores promotion-specific manual input for Scenario 4.
cgcloud__Scenario_4_Parameters__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores scenario parameters for Scenario 4 in .json format.
cgcloud__Scenario_5_Manual_Inputs__c	Type textarea Properties Create, Nillable, Update Description Stores promotion-specific manual input for Scenario 5.
cgcloud__Scenario_5_Parameters__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores scenario parameters for Scenario 5 in .json format.
cgcloud__Selected_Scenario__c	Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Indicates the active scenario for the promotion.
cgcloud__Skip_Version_Update__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Flag that's used to skip the version update. This flag is stored as false in the database, but the system verifies the input value to detect whether the version is to be upgraded. The default value is `false`.
cgcloud__Slogan_Language_1__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the slogan in language 1.
cgcloud__Slogan_Language_2__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the slogan in language 2.
cgcloud__Slogan_Language_3__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the slogan in language 3.
cgcloud__Slogan_Language_4__c	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the slogan in language 4.
cgcloud__Slogan__c	Type string Properties Filter, Nillable, Sort Description Formula This is a calculated field. Formula `1CASE($User.cgcloud__Language_Postfix__c, 2"Language1", cgcloud__Slogan_Language_1__c, 3"Language2", BLANKVALUE(cgcloud__Slogan_Language_2__c,cgcloud__Slogan_Language_1__c), 4"Language3", BLANKVALUE(cgcloud__Slogan_Language_3__c,cgcloud__Slogan_Language_1__c), 5"Language4", BLANKVALUE(cgcloud__Slogan_Language_4__c,cgcloud__Slogan_Language_1__c), 6cgcloud__Slogan_Language_1__c)`
cgcloud__Sub_Accounts_Selection__c	Type textarea Properties Create, Nillable, Update Description Determines the selection of the valid sub accounts of the parent customer.
cgcloud__Sync_Relevant_Changes__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Used for push promotions. This object indicates whether any changes are done to this promotion, which is to be synced down to the child promotions. The default value is `false`.
cgcloud__Trade_Calendar_Color_Code_1__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar. Possible values are: `0x002266`—Violet Blue `0x003344`—Ink Blue `0x0070D2`—Navy Blue `0x00716B`—Pine Green `0x008899`—Sea Green `0x009E73`—Green Haze `0x00A1E0`—Pacific Blue `0x00aa99`—Aquamarine `0x023248`—Sherpa Blue `0x08A69E`—Persian Green `0x16325C`—Catalina Blue `0x224433`—Deep Green `0x2f539c`—Deep Violet `0x337722`—Forest Green `0x359b4c`—Emerald `0x408fcd`—Sky Blue `0x551155`—Red Violet `0x60B17D`—Ocean Green `0x61022A`—Tyrian Purple `0x76DED9`—Turquoise Blue `0x7B399C`—Vivid Violet `0x94E3B1`—Algae Green `0x993399`—Violet `0xA10010`—Carmine `0xC23934`—Flush Mahogany `0xE2CE7D`—Chenin `0xE69F00`—Gamboge `0xFf9900`—Yellow Orange `0xaa1133`—Cranberry `0xbbbb00`—Lime Green `0xdd4411`—Dark Orange `0xeeaa00`—Chrome Yellow The default value is `0x76DED9`.
cgcloud__Trade_Calendar_Color_Code_2__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar. Possible values are: `0x002266`—Violet Blue `0x003344`—Ink Blue `0x0070D2`—Navy Blue `0x00716B`—Pine Green `0x008899`—Sea Green `0x009E73`—Green Haze `0x00A1E0`—Pacific Blue `0x00aa99`—Aquamarine `0x023248`—Sherpa Blue `0x08A69E`—Persian Green `0x16325C`—Catalina Blue `0x224433`—Deep Green `0x2f539c`—Deep Violet `0x337722`—Forest Green `0x359b4c`—Emerald `0x408fcd`—Sky Blue `0x551155`—Red Violet `0x60B17D`—Ocean Green `0x61022A`—Tyrian Purple `0x76DED9`—Turquoise Blue `0x7B399C`—Vivid Violet `0x94E3B1`—Algae Green `0x993399`—Violet `0xA10010`—Carmine `0xC23934`—Flush Mahogany `0xE2CE7D`—Chenin `0xE69F00`—Gamboge `0xFf9900`—Yellow Orange `0xaa1133`—Cranberry `0xbbbb00`—Lime Green `0xdd4411`—Dark Orange `0xeeaa00`—Chrome Yellow The default value is `0x76DED9`.
cgcloud__Trade_Calendar_Color_Code_3__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar. Possible values are: `0x002266`—Violet Blue `0x003344`—Ink Blue `0x0070D2`—Navy Blue `0x00716B`—Pine Green `0x008899`—Sea Green `0x009E73`—Green Haze `0x00A1E0`—Pacific Blue `0x00aa99`—Aquamarine `0x023248`—Sherpa Blue `0x08A69E`—Persian Green `0x16325C`—Catalina Blue `0x224433`—Deep Green `0x2f539c`—Deep Violet `0x337722`—Forest Green `0x359b4c`—Emerald `0x408fcd`—Sky Blue `0x551155`—Red Violet `0x60B17D`—Ocean Green `0x61022A`—Tyrian Purple `0x76DED9`—Turquoise Blue `0x7B399C`—Vivid Violet `0x94E3B1`—Algae Green `0x993399`—Violet `0xA10010`—Carmine `0xC23934`—Flush Mahogany `0xE2CE7D`—Chenin `0xE69F00`—Gamboge `0xFf9900`—Yellow Orange `0xaa1133`—Cranberry `0xbbbb00`—Lime Green `0xdd4411`—Dark Orange `0xeeaa00`—Chrome Yellow The default value is `0x76DED9`.
cgcloud__Trade_Calendar_Color_Code_4__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar. Possible values are: `0x002266`—Violet Blue `0x003344`—Ink Blue `0x0070D2`—Navy Blue `0x00716B`—Pine Green `0x008899`—Sea Green `0x009E73`—Green Haze `0x00A1E0`—Pacific Blue `0x00aa99`—Aquamarine `0x023248`—Sherpa Blue `0x08A69E`—Persian Green `0x16325C`—Catalina Blue `0x224433`—Deep Green `0x2f539c`—Deep Violet `0x337722`—Forest Green `0x359b4c`—Emerald `0x408fcd`—Sky Blue `0x551155`—Red Violet `0x60B17D`—Ocean Green `0x61022A`—Tyrian Purple `0x76DED9`—Turquoise Blue `0x7B399C`—Vivid Violet `0x94E3B1`—Algae Green `0x993399`—Violet `0xA10010`—Carmine `0xC23934`—Flush Mahogany `0xE2CE7D`—Chenin `0xE69F00`—Gamboge `0xFf9900`—Yellow Orange `0xaa1133`—Cranberry `0xbbbb00`—Lime Green `0xdd4411`—Dark Orange `0xeeaa00`—Chrome Yellow The default value is `0x76DED9`.
cgcloud__Trade_Calendar_Color_Code_5__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar. Possible values are: `0x002266`—Violet Blue `0x003344`—Ink Blue `0x0070D2`—Navy Blue `0x00716B`—Pine Green `0x008899`—Sea Green `0x009E73`—Green Haze `0x00A1E0`—Pacific Blue `0x00aa99`—Aquamarine `0x023248`—Sherpa Blue `0x08A69E`—Persian Green `0x16325C`—Catalina Blue `0x224433`—Deep Green `0x2f539c`—Deep Violet `0x337722`—Forest Green `0x359b4c`—Emerald `0x408fcd`—Sky Blue `0x551155`—Red Violet `0x60B17D`—Ocean Green `0x61022A`—Tyrian Purple `0x76DED9`—Turquoise Blue `0x7B399C`—Vivid Violet `0x94E3B1`—Algae Green `0x993399`—Violet `0xA10010`—Carmine `0xC23934`—Flush Mahogany `0xE2CE7D`—Chenin `0xE69F00`—Gamboge `0xFf9900`—Yellow Orange `0xaa1133`—Cranberry `0xbbbb00`—Lime Green `0xdd4411`—Dark Orange `0xeeaa00`—Chrome Yellow The default value is `0x76DED9`.
cgcloud__Trade_Calendar_Transparency_1__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar.
cgcloud__Trade_Calendar_Transparency_2__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar.
cgcloud__Trade_Calendar_Transparency_3__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar.
cgcloud__Trade_Calendar_Transparency_4__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar.
cgcloud__Trade_Calendar_Transparency_5__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description Property Based Coloring of Promotion Bars in the Trade Calendar.
cgcloud__Version_Synced_Off_Platform__c	Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Version that Off Platform operations receive.
cgcloud__Version__c	Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Current version of the record. The system updates this field after each operation.
cgcloud__Volume_Percent__c	Type percent Properties Create, Filter, Nillable, Sort, Update Description SmartUI calculates this field every time the Sub Account list values are updated.

Associated Objects

This object has these associated objects. If the API version isn’t specified, they are available in the same API versions as this object. Otherwise, they are available in the specified API version and later.

cgcloud__Promotion__cChangeEvent: Change events are available for the object.
cgcloud__Promotion__cFeed: Feed tracking is available for the object.
cgcloud__Promotion__cHistory: History is available for the tracked fields of the object.
cgcloud__Promotion__cOwnerSharingRule: Sharing rules are available for the object.
cgcloud__Promotion__cShare: Sharing is available for the object.

Consumer Goods Cloud Developer Guide

cgcloud__Promotion__c

Supported Calls

Fields

Associated Objects

cgcloudPromotionc