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.

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

• Type: textarea
• Properties: Create, Filter, Nillable, Sort, Update
• Description: A text description of this record. Label is Product Description.

• Type: url
• Properties: Create, Filter, Nillable, Sort, Update
• Description: URL leading to a specific version of a record in the linked external data source.

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: ID of the related external data source.

• 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.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Name of the product family associated with this record.

• Possible values:

  • None

• 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.
• Default value: false

• Type: boolean
• Properties: Defaulted on create, Filter, Group, Sort
• Description: Indicates whether the product is archived.
• Default value: false

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp for when the current user last viewed a record related to this object.

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp for when the current user last viewed this object.

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: Required. Default name of this record. Label is Product Name.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Default product code for this record. Your org defines the product code naming pattern.

• 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:

  • Each

• 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

• 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.

• 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

• 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.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Indicates the product category that this product record is referring to.

• Possible values:

  • Beverages
  • Chips
  • Detergent
  • Frozen—Frozen Goods
  • Hygiene
  • Snacks

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Marks a product as a competitor’s product.
• Default value: false

• Type: string
• Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
• Description: Holds the unique external id.

• Type: string
• Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
• Description: Stores the unique identification of a product.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Describes the unit of a container size.

• Possible values:

  • gal
  • l
  • ml
  • m³
  • oz

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: Describes the numeric value for container size.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Describes the type of container of the product.

• Possible values:

  • Bottle
  • Can
  • Plastic

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Criteria in a text form.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_1_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_1_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_1_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_1_Product__r.cgcloud__Description_1__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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_2_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_2_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_2_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_2_Product__r.cgcloud__Description_1__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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_3_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_3_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_3_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_3_Product__r.cgcloud__Description_1__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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_4_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_4_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_4_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_4_Product__r.cgcloud__Description_1__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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_5_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_5_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_5_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_5_Product__r.cgcloud__Description_1__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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product code belonging to Criterion_6_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_6_Product__r.cgcloud__Consumer_Goods_Product_Code__c

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Product description belonging to Criterion_6_Product.

  This field is a calculated field.

• Formula:

  1cgcloud__Criterion_6_Product__r.cgcloud__Description_1__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

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Use to customize the sorting order of the products. Is unique.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Delivery status valid from date.

• Type: date
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: Delivery status valid thru date.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the first description of language 1.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the first description of language 2.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the first description of language 3.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the first description of language 4.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Description 1 based on the user specific language.

  This field is a calculated field.

• Formula:

  1CASE($User.cgcloud__Language_Postfix__c,
  2"Language1", cgcloud__Description_1_Language_1__c,
  3"Language2", BLANKVALUE(cgcloud__Description_1_Language_2__c,cgcloud__Description_1_Language_1__c),
  4"Language3", BLANKVALUE(cgcloud__Description_1_Language_3__c,cgcloud__Description_1_Language_1__c),
  5"Language4", BLANKVALUE(cgcloud__Description_1_Language_4__c,cgcloud__Description_1_Language_1__c),
  6cgcloud__Description_1_Language_1__c)

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the second description of language 1.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the second description of language 2.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the second description of language 3.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the second description of language 4.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Description 2 based on the user specific language.

  This field is a calculated field.

• Formula:

  1CASE($User.cgcloud__Language_Postfix__c,
  2"Language1", cgcloud__Description_2_Language_1__c,
  3"Language2", BLANKVALUE(cgcloud__Description_2_Language_2__c,cgcloud__Description_2_Language_1__c),
  4"Language3", BLANKVALUE(cgcloud__Description_2_Language_3__c,cgcloud__Description_2_Language_1__c),
  5"Language4", BLANKVALUE(cgcloud__Description_2_Language_4__c,cgcloud__Description_2_Language_1__c),
  6cgcloud__Description_2_Language_1__c)

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the estimated value of the asset.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Field status valid from date.

• Type: date
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: Field status valid thru date.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Fund Role status valid from date.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Fund Role status valid thru date.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Universal Product Number (UPC) number of the product.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the height of the asset.

• 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:

  1cgcloud__Is_Bill_Of_Material__c

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Boolean flag to identify BOM products.
• Default value: false

• 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

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: KAM status valid from date.

• Type: date
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: KAM status valid thru date.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Number assigned to the manufacturer.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Name of the manufacturer.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: New Item status valid from date.

• Type: date
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: New Item status valid thru date.

• 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.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Unit of the product pack size.

• Possible values:

  • box
  • pk

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: Numeric value for the product pack size.

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Specifies whether the asset requires connection to a power supply.
• Default value: false

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Defines the state of the product.

• Possible values:

  • Liquid
  • Solid

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

• Description: Describes the Product Level.

• Default value: Product

• Possible values:

  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • Product
  • SubCategory

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Additional short product identifier.

• 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

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: The type of the product.

• Possible values:

  • Advertising—Advertising Material
  • AssetType
  • Commodity
  • CountingGroup
  • Empty
  • Service

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: This is an “apex roll up summary field”. Internally required.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Describes the sales org which the product belongs to.

  This field is a calculated field.

• Formula:

  1TEXT(cgcloud__Product_Template__r.cgcloud__Sales_Org__c)

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Sell In Code of the product.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the Sell Out Code of the product.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the short description of language 1.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the short description of language 2.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the short description of language 3.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the short description of language 4.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Short description based on the user specific language.

  This field is a calculated field.

• Formula:

  1CASE($User.cgcloud__Language_Postfix__c,
  2"Language1", cgcloud__Short_Description_Language_1__c,
  3"Language2", BLANKVALUE(cgcloud__Short_Description_Language_2__c,cgcloud__Short_Description_Language_1__c),
  4"Language3", BLANKVALUE(cgcloud__Short_Description_Language_3__c,cgcloud__Short_Description_Language_1__c),
  5"Language4", BLANKVALUE(cgcloud__Short_Description_Language_4__c,cgcloud__Short_Description_Language_1__c),
  6cgcloud__Short_Description_Language_1__c)

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the size of the asset.

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: State of the product.

• Possible values:

  • 0—Preparation
  • 1—Plan
  • 2—Check
  • 3—Startup
  • 4—Active
  • 5—Paused
  • 6—Phase Out
  • 7—Remainders
  • 8—Passive
  • 9—Deleted

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Tax classification of the product.

• Possible values:

  • f—Full
  • n—Normal
  • r—Reduced

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Identifies the products for the promotion transfer process.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Holds the weight of the asset.

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

• Product2ChangeEvent: Change events are available for the object.
• Product2Feed: Feed tracking is available for the object.
• Product2History: History is available for tracked fields of the object.
• Product2OwnerSharingRule: Sharing rules are available for the object.
• Product2Share: Sharing is available for the object.

j

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

SignatureTask

SignatureTaskLineItem

StoreActionPlanTemplate

StoreAssortment

StoreProduct

Task

User

VehicleUserAssignment

Visit

Visitor

VisitedParty

Associated Objects for Retail Execution

Custom Objects for Retail Execution

Standard DLO to DMO Mappings

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

Standard and Custom Objects for Future Use

API End-of-Life Policy

Previous Versions