Consumer Goods Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Consumer Goods Cloud
Retail Execution
Standard Objects for Retail Execution
Account
Asset
AssessmentIndicatorDefinition
AssessmentIndDefinedValue
AssessmentIndValue
AssessmentTask
AssessmentTaskContentDocument
AssessmentTaskDefinition
AssessmentTaskIndDefinition
AssessmentTaskOrder
Assortment
AssortmentProduct
DeliveryTask
InStoreLocation
Operatinghours
OtherComponentTask
Product2
Promotion
PromotionChannel
PromotionProduct
PromotionProductCategory
RetailLocationGroup
RetailStore
RetailStoreGroupAssignment
RetailStoreKpi
RetailVisitKpi
StoreActionPlanTemplate
StoreAssortment
StoreProduct
Task
User
VehicleUserAssignment
Visit
Visitor
VisitedParty
Associated Objects for Retail Execution
Custom Objects for Retail Execution
Retail Execution Standard Metadata APIs
Retail Order Customization
Sync Management
Direct Store Delivery
Einstein Visit and Activity Recommendation
Trade Promotion Management
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
API End-of-Life Policy
PDF

Product2

Represents a product that your company sells. Custom fields extend the standard Product object for use in Consumer Goods Cloud. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

Field Details
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A text description of this record. Label is Product Description.
DisplayUrl
Type
url
Properties
Create, Filter, Nillable, Sort, Update
Description
URL leading to a specific version of a record in the linked external data source.
ExternalDataSourceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the related external data source.
ExternalId
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique identifier of a record in the linked external data source. For example, ID #123.
Family
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the product family associated with this record.
Possible values are:
  • None
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this record is active (true) or not (false). Inactive Product2 records are hidden in many areas in the user interface. You can change the IsActive flag on a Product2 object as often as necessary. Label is Active.
The default value is false.
IsArchived
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the product is archived.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this object.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this object.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Default name of this record. Label is Product Name.
ProductCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Default product code for this record. Your org defines the product code naming pattern.
QuantityUnitOfMeasure
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unit of the product; for example, kilograms, liters, or cases. This field comes with only one value (Each) so consider creating your own. The QuantityUnitOfMeasure field on ProductItem inherits this field’s values.
Possible values are:
  • Each
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates the record type of the record.
This field is a relationship field.
Relationship Name
RecordType
Relationship Type
Lookup
Refers To
RecordType
StockKeepingUnit
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The SKU for the product. Use in tandem with or instead of the ProductCode field. For example, you can track the manufacturer’s identifying code in the Product Code field and assign the product a SKU when you resell it.
cgcloud__Asset_Template__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to asset template.
This field is a relationship field.
Relationship Name
cgcloud__Asset_Template__r
Relationship Type
Lookup
Refers To
cgcloud__Asset_Template__c
cgcloud__Bill_Of_Material_Header_Code__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Header code of the product, if it is a BOM component. For standard products the field will be empty.
cgcloud__Category__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates the product category that this product record is referring to.
Possible values are:
  • Beverages
  • Chips
  • Detergent
  • Frozen—Frozen Goods
  • Hygiene
  • Snacks
cgcloud__Competitive_Product__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Marks a product as a competitor's product.
The default value is false.
cgcloud__Consumer_Goods_External_Product_Id__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Holds the unique external id.
cgcloud__Consumer_Goods_Product_Code__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Stores the unique identification of a product.
cgcloud__Container_Size_Unit__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Describes the unit of a container size.
Possible values are:
  • gal
  • l
  • ml
  • m³
  • oz
cgcloud__Container_Size__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Describes the numeric value for container size.
cgcloud__Container_Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Describes the type of container of the product.
Possible values are:
  • Bottle
  • Can
  • Plastic
cgcloud__Criteria_Text_0__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_5__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_6__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_7__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_8__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criteria_Text_9__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Criteria in a text form.
cgcloud__Criterion_1_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_1_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_1_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_1_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_1_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_1_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_1_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'Category'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_1_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Criterion_2_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_2_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_2_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_2_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_2_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_2_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_2_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'SubCategory'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_2_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Criterion_3_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_3_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_3_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_3_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_3_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_3_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_3_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'Brand'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_3_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Criterion_4_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_4_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_4_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_4_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_4_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_4_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_4_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'Flavor'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_4_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Criterion_5_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_5_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_5_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_5_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_5_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_5_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_5_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'Package'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_5_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Criterion_6_Product_Code__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product code belonging to Criterion_6_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_6_Product__r.cgcloud__Consumer_Goods_Product_Code__c
cgcloud__Criterion_6_Product_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Product description belonging to Criterion_6_Product.
This field is a calculated field.
Formula
cgcloud__Criterion_6_Product__r.cgcloud__Description_1__c
cgcloud__Criterion_6_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the product in the hierarchy of the product which is on Product_Level 'Product'.
This field is a relationship field.
Relationship Name
cgcloud__Criterion_6_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__Custom_Sort__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Use to customize the sorting order of the products. Is unique.
cgcloud__Delivery_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Delivery status valid from date.
cgcloud__Delivery_Valid_Thru__c
Type
date
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Delivery status valid thru date.
cgcloud__Description_1_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the first description of language 1.
cgcloud__Description_1_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the first description of language 2.
cgcloud__Description_1_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the first description of language 3.
cgcloud__Description_1_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the first description of language 4.
cgcloud__Description_1__c
Type
string
Properties
Filter, Nillable, Sort
Description
Description 1 based on the user specific language.
This field is a calculated field.
Formula
CASE($User.cgcloud__Language_Postfix__c,
"Language1", cgcloud__Description_1_Language_1__c,
"Language2", BLANKVALUE(cgcloud__Description_1_Language_2__c,cgcloud__Description_1_Language_1__c),
"Language3", BLANKVALUE(cgcloud__Description_1_Language_3__c,cgcloud__Description_1_Language_1__c),
"Language4", BLANKVALUE(cgcloud__Description_1_Language_4__c,cgcloud__Description_1_Language_1__c),
cgcloud__Description_1_Language_1__c)
cgcloud__Description_2_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the second description of language 1.
cgcloud__Description_2_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the second description of language 2.
cgcloud__Description_2_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the second description of language 3.
cgcloud__Description_2_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the second description of language 4.
cgcloud__Description_2__c
Type
string
Properties
Filter, Nillable, Sort
Description
Description 2 based on the user specific language.
This field is a calculated field.
Formula
CASE($User.cgcloud__Language_Postfix__c,
"Language1", cgcloud__Description_2_Language_1__c,
"Language2", BLANKVALUE(cgcloud__Description_2_Language_2__c,cgcloud__Description_2_Language_1__c),
"Language3", BLANKVALUE(cgcloud__Description_2_Language_3__c,cgcloud__Description_2_Language_1__c),
"Language4", BLANKVALUE(cgcloud__Description_2_Language_4__c,cgcloud__Description_2_Language_1__c),
cgcloud__Description_2_Language_1__c)
cgcloud__Estimated_Value__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the estimated value of the asset.
cgcloud__Field_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Field status valid from date.
cgcloud__Field_Valid_Thru__c
Type
date
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Field status valid thru date.
cgcloud__Fund_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Fund Role status valid from date.
cgcloud__Fund_Valid_Thru__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Fund Role status valid thru date.
cgcloud__GTIN__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Universal Product Number (UPC) number of the product.
cgcloud__Height__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the height of the asset.
cgcloud__Is_Bill_Of_Material_Label__c
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Defines a secondary label for the Is_Bill_Of_Material__c field.
This field is a calculated field.
Formula
cgcloud__Is_Bill_Of_Material__c
cgcloud__Is_Bill_Of_Material__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Boolean flag to identify BOM products.
The default value is false.
cgcloud__KAM_Product__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to the specifics for a product on the lowest level of the product hierarchy, which is the corresponding product on planning level (Product Price Group level).
This field is a relationship field.
Relationship Name
cgcloud__KAM_Product__r
Relationship Type
Lookup
Refers To
Product2
cgcloud__KAM_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
KAM status valid from date.
cgcloud__KAM_Valid_Thru__c
Type
date
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
KAM status valid thru date.
cgcloud__Manufacturer_Item_Number__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Number assigned to the manufacturer.
cgcloud__Manufacturer__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the manufacturer.
cgcloud__New_Item_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
New Item status valid from date.
cgcloud__New_Item_Valid_Thru__c
Type
date
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
New Item status valid thru date.
cgcloud__Order_Ability__c
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
This is an "apex roll up summary field" to identify the Order able products only. Order Able products are identified by the units of measure which have Order Ability set to true.
cgcloud__Pack_Size_Unit__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unit of the product pack size.
Possible values are:
  • box
  • pk
cgcloud__Pack_Size__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Numeric value for the product pack size.
cgcloud__Power_Supply_Connected__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the asset requires connection to a power supply.
The default value is false.
cgcloud__Product_Form__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Defines the state of the product.
Possible values are:
  • Liquid
  • Solid
cgcloud__Product_Level__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Describes the Product Level.
Possible values are:
  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • Product
  • SubCategory
The default value is Product.
cgcloud__Product_Short_Code__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Additional short product identifier.
cgcloud__Product_Template__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to product template.
This field is a relationship field.
Relationship Name
cgcloud__Product_Template__r
Relationship Type
Lookup
Refers To
cgcloud__Product_Template__c
cgcloud__Product_Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of the product.
Possible values are:
  • Advertising—Advertising Material
  • AssetType
  • Commodity
  • CountingGroup
  • Empty
  • Service
cgcloud__Rounding_Rule_Validation__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
This is an "apex roll up summary field". Internally required.
cgcloud__Sales_Org__c
Type
string
Properties
Filter, Nillable, Sort
Description
Describes the sales org which the product belongs to.
This field is a calculated field.
Formula
TEXT(cgcloud__Product_Template__r.cgcloud__Sales_Org__c)
cgcloud__Sell_In_Code__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Sell In Code of the product.
cgcloud__Sell_Out_Code__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the Sell Out Code of the product.
cgcloud__Short_Description_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the short description of language 1.
cgcloud__Short_Description_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the short description of language 2.
cgcloud__Short_Description_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the short description of language 3.
cgcloud__Short_Description_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the short description of language 4.
cgcloud__Short_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Short description based on the user specific language.
This field is a calculated field.
Formula
CASE($User.cgcloud__Language_Postfix__c,
"Language1", cgcloud__Short_Description_Language_1__c,
"Language2", BLANKVALUE(cgcloud__Short_Description_Language_2__c,cgcloud__Short_Description_Language_1__c),
"Language3", BLANKVALUE(cgcloud__Short_Description_Language_3__c,cgcloud__Short_Description_Language_1__c),
"Language4", BLANKVALUE(cgcloud__Short_Description_Language_4__c,cgcloud__Short_Description_Language_1__c),
cgcloud__Short_Description_Language_1__c)
cgcloud__Size__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the size of the asset.
cgcloud__State__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State of the product.
Possible values are:
  • 0—Preparation
  • 1—Plan
  • 2—Check
  • 3—Startup
  • 4—Active
  • 5—Paused
  • 6—Phase Out
  • 7—Remainders
  • 8—Passive
  • 9—Deleted
cgcloud__Tax_Classification__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Tax classification of the product.
Possible values are:
  • f—Full
  • n—Normal
  • r—Reduced
cgcloud__Transfer_Record_Identifier__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies the products for the promotion transfer process.
cgcloud__Weight__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the weight of the asset.