Product2

Represents a product that your org sells.

This object has several fields that are used only for quantity and revenue schedules (for example, annuities). Schedules are available only for orgs that have enabled the products and schedules features. If these features aren’t enabled, the schedule fields don’t appear in the DescribeSObjectResult, and you can’t query, create, or update the fields.

Product2 objects represent products. As of API version 8.0, the Product object is no longer available. Requests that contain Product are refused, and responses don’t contain the Product object.

Note

Supported Calls

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

Fields

Field	Details
CanUseQuantitySchedule	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the product can have a quantity schedule (`true`) or not (`false`). Label is Quantity Scheduling Enabled.
CanUseRevenueSchedule	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the product can have a revenue schedule (`true`) or not (`false`). Label is Revenue Scheduling Enabled.
ConnectionReceivedId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.
ConnectionSentId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org.
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. Product families are configured as picklists in the user interface. To obtain a list of valid values, call `describeSObjects()` and process the DescribeSObjectResult for the values associated with the `Family` field. Label is Product Family.
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.
IsArchived	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Describes whether the product is archived. The default value is `false`.
IsDeleted	Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Default name of this record. Label is Product Name.
NumberOfQuantityInstallments	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If the product has a quantity schedule, the number of installments.
NumberOfRevenueInstallments	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If the product has a revenue schedule, the number of installments.
ProductClass	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description This field is read-only. Its value is determined by the value of the `Type` field and whether the product is associated with a `ProductAttribute` record. It describes whether a product is a simple product, a variation parent, or a product variation. Possible values are: `Simple`—This product has no variations `VariationParent`—This product is a variation parent. It’s the base product for one or more product variations and, though it has its own stock-keeping unit (SKU), isn’t a sellable entity. Instead, it’s the parent of sellable entities—its variations. `Variation`—This product is a variation of a parent product. Each variation has its own SKU. When the value of `ProductClass` = `VariationParent`, it never changes. The value of `ProductClass` changes between `Simple` and `Variation` when you attach or detach a `ProductAttribute` record to the product. The default value is `Simple`. This field is available in API version 50.0 and later. It was introduced in support of commerce implementations.
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.
QuantityInstallmentPeriod	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the product has a quantity schedule, the amount of time covered by the schedule.
QuantityScheduleType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the quantity schedule, if the product has one.
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.
RecalculateTotalPrice	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Changes behavior of OpportunityLineItem calculations when a line item has child schedule rows for the Quantity value. When enabled, if the rollup quantity changes, then the quantity rollup value is multiplied against the sales price to change the total price.
RevenueInstallmentPeriod	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the product has a revenue schedule, the time period covered by the schedule.
RevenueScheduleType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the revenue schedule, if the product has one.
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.
Type	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of product. The value of Type affects the read-only value of the `ProductClass` field. Possible values are `Base` and `Null`. When `Type` = `Base`, then `ProductClass` = `VariantionParent`. When `Type` = `Null`, then `ProductClass` = `Simple`. If you attach a `ProductAttribute` record to a product, then the product’s `ProductClass` value changes to `Variation`. Conversely, when you detach all `ProductAttribute` records from a product, the `ProductClass` value changes to `Simple`. This field is available in API version 50.0 and later. It was introduced in support of commerce implementations.

Schedule Enabled Flags

When enabling the schedules feature, orgs can decide whether to enable quantity schedules, revenue schedules, or both. In addition, you can use the API to control quantity and revenue scheduling at the product level via the CanUseQuantitySchedule and CanUseRevenueSchedule flags. A value of true for either flag indicates that the product and any OpportunityLineItems can have a schedule of that type. These flags can be set when creating or updating Product2 records.

Default Schedule Fields

The remaining schedule fields for this object define default schedules. Default schedule values are used to create an OpportunityLineItemSchedule when an OpportunityLineItem is created for the Product.

The default schedule fields support the following valid values (all fields are also nillable).

Field	Valid Values
RevenueScheduleType	Divide, Repeat
RevenueInstallmentPeriod	Daily, Weekly, Monthly, Quarterly, Yearly
NumberOfRevenueInstallments	Integer between 1 and 150, inclusive.
QuantityScheduleType	Divide, Repeat
QuantityInstallmentPeriod	Daily, Weekly, Monthly, Quarterly, Yearly
NumberOfQuantityInstallments	Integer between 1 and 150, inclusive

When you attempt to set the schedule fields when creating or updating, the API applies cross-field integrity checks. The integrity requirements are:

If the schedule type is nil, the installment period and number of installments must be nil.
If the schedule type is set to any value, then the installment period and number of installments must be non-nil.

Any create or update that fails these integrity checks is rejected with an error.

These default schedule fields, CanUseQuantitySchedule, and CanUseRevenueSchedule, are restricted picklist fields and are available only if the org has the schedules feature enabled.

Usage

Use this object to define the default product information for your org. This object is associated by reference with Pricebook2 objects via PricebookEntry objects. The same product can be represented in different price books as price book entries. In fact, the same product can be represented multiple times (as separate PricebookEntry records) in the same price book with different prices or currencies. A product can only have one price for a given currency within the same price book. To be used in custom price books, all standard prices must be added as price book entries to the standard price book.

You can query the products that have been configured for your org. For example, you can allow your client application to obtain valid product IDs for use when configuring PricebookEntry records via the API. Your client application can perform the following tasks on PricebookEntry objects:

Query
Create for the standard price book or custom price books.
Update
Delete
Change the IsActive field when creating or updating records

This object is defined only for those orgs that have products enabled as a feature. If the org doesn’t have the products feature, this object doesn’t appear in the describeGlobal() call, and you can't describe or query this object.

If you try to delete a product via the API but there's an opportunity that uses that product, the delete fails. The workaround is to delete the product in the user interface, which gives you an option to archive the product.

On opportunities and opportunity products, the workflow rules, validation rules, and Apex triggers fire when an update to a child opportunity product or schedule causes an update to the parent record. This means your custom application logic is enforced when there are updates to the parent record, ensuring higher data quality and compliance with your organization’s business policies.