Product2 Object Reference
Field Definitions
| Field Name | Type | Required | Unique | Description |
|---|---|---|---|---|
| Allow_Prepurchase__c | Checkbox(false) | No | No | [Future Use] If checked, a user can buy this Product as a prepurchase before the Available_On__c date. |
| Available_On__c | DateTime | No | No | The date from which this Product is available for purchase. If a future date is used, this Product will still be visible in the store but cannot be added to the cart. |
| Barcode__c | Text | No | Yes | A barcode value for this Product that also acts as an External ID. This must be unique across all products. This is not displayed on the site. |
| Booking_Duration__c | Number(18, 0) | No | No | The number of minutes this booking product lasts. |
| Booking_End_Buffer__c | Number(18, 0) | No | No | The number of minutes required to be unbooked after each booking. |
| Booking_Max_Attendees__c | Number(18, 0) | No | No | The maximum number of attendees that can attend a single booking of this product. i.e. If a booking is for a table for up to five people, you would set is to 5. |
| Booking_Require_Attendee_Details__c | Checkbox(false) | No | No | If enabled, the customer will be asked to provide the booking attendee details on the order summary page. |
| Booking_Start_Buffer__c | Number(18, 0) | No | No | The number of minutes required to be unbooked before each booking. |
| Brand_Id__c | Lookup(Account) | No | No | The Product’s brand, as an associated Account record where Account.Supplier__c is true. |
| Charge_Subscription__c | Checkbox(true) | No | No | If enabled and this is a subscription Product, the system will process the subscription and charge recurring payments. If disabled a Subscription__c record will be created but the system will not process the subscription or charge recurring payments, for example if you are managing subscriptions with an external finance company or the customer pays by direct deposit, etc. |
| Condition__c | Picklist | No | No | The Condition of this Product, can either be new, refurbished or used. This is used in the merchant feed. |
| Cost_Price__c | Currency(18, 2) | No | No | The cost price of the Product. This is only used for reporting purposes. |
| Discontinue_On__c | DateTime | No | No | The date from which this Product will no longer be available in the store |
| Display_Name__c | Text | No | No | The title of the Product to display in the store. If this is blank the Product.Name field will be used instead. |
| Downloads_Markdown__c | LongTextArea | No | No | The Product downloads content in Markdown / Liquid format. |
| Features_Markdown__c | LongTextArea | No | No | The Product features content in Markdown / Liquid format. |
| Has_Serial_Number__c | Checkbox(false) | No | No | If enabled the system will allow entering a serial number when the Product is sold through StoreConnect’s POS system. |
| Hs_Code__c | Text | No | No | Defines the Harmonized System (HS) code for this Product. |
| Import_ID__c | Text | No | Yes | Unique external ID that can be used when you are synchronising a product with an external system. This is can also be referenced via Data Loader and other data upload systems. |
| Is_Master__c | Checkbox(true) | No | No | Set to true if this Product has a set of variants or is a stand alone product that has no variants. A variant of a master should never have Is_Master__c set to true. |
| Is_Voucher__c | Checkbox(false) | No | No | Indicates the Product is for a Voucher. |
| Media_Upload__c | Formula | No | No | This formula displays a link to upload related Media for this Product. Entering Product and Position while loading Media will create the Product_Media__c join automatically for you. If further configuration is required, check the Product_Media__c record. |
| Meta_Description__c | LongTextArea | No | No | The content that appears within the meta description tag in the HEAD tag of the Product page. |
| Meta_Keywords__c | Text | No | No | The content that appears within the meta keywords tag in the HEAD tag of the Product page. |
| Meta_Title__c | Text | No | No | The content that appears within the meta title tag in the HEAD tag of the Product page. |
| Minimum_Sell_Price__c | Currency(18, 2) | No | No | If set this will be used as the minimum possible discounted price for this Product on StoreConnect POS. If blank there is no minimum price. Can be overridden by PriceBookEntry.Minimum_Sell_Price. |
| Placeholder_For_Id__c | Lookup(Product2) | No | No | Defines another Product to be displayed instead of this one when this product is Restricted |
| Position__c | Number(18, 0) | No | No | The position of this Product. Lower numbers are shown first, records without a number are sorted alphabetically by Name |
| Preview_On_Site__c | Formula | No | No | Link to the website page for this Product so you can see what it looks like with the current configuration. |
| Product_Trait_Template_Id__c | Lookup(Product_Trait_Template__c) | No | No | When Product Trait Templates have been set up, associating a Trait Template to the Product here will trigger an update that automatically adds all of the templated Product Trait Items, thus automatically setting a suite of Traits for the Product. These then need to be reviewed for your specific Product, to ensure it has all correct values. |
| Promotionable__c | Checkbox(true) | No | No | [Future Use] This field is not currently in use. It is slated for use in future development. |
| Require_Deposit__c | Checkbox(false) | No | No | If checked, this Product will charge a deposit at the checkout, rather than full price. The amount is in PricebookEntry.Deposit_Amount__c which must also be set for deposits to be used during checkout. |
| Search_Description_Markdown__c | LongTextArea | No | No | The description shown within the Google Merchant Feed and Facebook Catalog Feed as well as within in the structured data description and open graph description tags on the individual product pages. |
| Shipping_Dangerous_Goods__c | Checkbox(false) | No | No | [Future Use] If checked, shows that the Product is considered as a dangerous good |
| Shipping_Dimensions_Unit__c | Picklist | No | No | The unit of measure of all the shipping size dimensions of this Product. For example, millimetre, centimetre, metre, kilometre, inch, foot, yard, mile |
| Shipping_Height__c | Number(18, 2) | No | No | The height of the shipping packaging of this Product. Units are set by Shipping_Dimensions_Unit__c. |
| Shipping_Length__c | Number(18, 2) | No | No | The length of the shipping packaging of this Product. Units are set by Shipping_Dimension_Units__c. |
| Shipping_Methods__c | MultiselectPicklist | No | No | The shipping methods allowed for shipping this Product. For full description of how to set up shipping and assign shipping methods, see Shipping Configuration |
| Shipping_Packaging_Type__c | Picklist | No | No | The packaging type (code) used for shipping this Product with the Shipping_Provider__c. For example: envelope, item, bag, satchel, padded bag, carton, pallet |
| Shipping_Weight_Unit__c | Picklist | No | No | The unit of measure for this Product’s Shipping_Weight__c. For example: gram, kilogram, metric ton, ounce, pound, short ton |
| Shipping_Weight__c | Number(18, 2) | No | No | The weight of the shipping packagaing of this Product, in the measurements set in Shipping_Weight_Unit__c. |
| Shipping_Width__c | Number(18, 2) | No | No | The width of the shipping packaging of this Product. Units are set in Shipping_Dimensions_Unit__c. |
| Slug__c | Text | No | Yes | The unique slug which will be used to form this Product’s URL in the store. The value is automatically populated based on Name if left blank but must be unique across all Products. |
| Social_Image_Id__c | Lookup(Media__c) | No | No | The Image to show when the Product is shared on Social Media. If not provided, will use the Product’s first image. |
| Specifications_Markdown__c | LongTextArea | No | No | This contains the Product specifications content in Markdown / Liquid format |
| Subscription_Billing_Delay_Length__c | Number(5, 0) | No | No | Number of Billing_Delay_Unit__c durations after the period renewal date to delay before charging the subscription. This is useful if you need to run an automated or manual process to update the period subscription charge before invoicing. |
| Subscription_Billing_Delay_Unit__c | Picklist | No | No | The unit of measure of the Subscription_Billing_Delay_Length__c. |
| Subscription_Pricing__c | Picklist | No | No | The pricing method used if this is a subscipriont Product. If CPQ is installed, the value in SBQQ__SubscriptionPricing__c CPQ field will be used and this one will have no effect. |
| Subscription_Term_Count__c | Number(18, 0) | No | No | The number of full terms that this subscription will have if it is a One Time subscription Product. Term length is set by Subscription_Term__c and Subscription_Term_Unit__c. e.g. If Subscription_Term_Unit__c is “month” and Subscription_Term__c is 1, then a value of “12” here would be a monthly subscription that expires after 12 months. |
| Subscription_Term_Unit__c | Picklist | No | No | The unit of measure of the Subscription_Term__c if this is a subscription Product. If CPQ is installed, this will automatically be set to the organisation-wide unit in CPQ settings |
| Subscription_Term__c | Number(18, 0) | No | No | The term of this subscription if it is a subscription Product. Units are set by Subscription_Term_Unit__c. e.g. If Subscription_Term_Unit__c is “month” then a value of “12” here would be an annual subscription. If CPQ is installed the SBQQ_SubscriptionTerm__c field will be used and this one will have no effect. |
| Subscription_Type__c | Picklist | No | No | The type of subscription if this is a subscription Product. Evergreen and One Time are supported. If CPQ is installed, the SBQQ__SubscriptionType__c field will be used and this field will have no effect. |
| Summary_Markdown__c | LongTextArea | No | No | The Product summary content in Markdown / Liquid format |
| Supplier_Code__c | Text | No | Yes | The Supplier’s Internal Code for this Product |
| Support_Markdown__c | LongTextArea | No | No | The Product support content in Markdown / Liquid format |
| Sync_To_Google__c | Checkbox(true) | No | No | This sets whether to include this Product in the Google and Facebook Merchant feeds. To ensure your Products are fully configured to display correctly, follow the Google Merchant Feed guide. |
| Tax_Category_Code__c | Picklist | No | No | [Future Use]: Will be used in a future version. |
| Tax_Code__c | Text | No | No | Defines tax code for this product. Primarily set for third party tax services. |
| Track_Inventory__c | Checkbox(false) | No | No | If enabled the system will track the inventory levels of this Product. For a full description of how to configure inventory and stock levels, see Managing Stock Levels |
| UPC__c | Text | No | Yes | This is the UPC, EAN etc |
| Variant_Title__c | Text | No | No | This is the title of a variant Product. For example a Product “Bike” which have a “Red Small” variant. |
| Virtual__c | Checkbox(false) | No | No | Indicates the Product is not a physical product that requires Shipping. |
| Voucher_Email_Template__c | Text | No | No | Classic Email Template API Name to use when sending a Voucher |
| Voucher_Usage__c | Picklist | No | No | If a Voucher is created for this Product, this setting will be passed through to the Voucher record. |
| Warranty_Markdown__c | LongTextArea | No | No | The Product warranty content in Markdown / Liquid format |
| sC_Id__c | Text | No | Yes | StoreConnect External ID, do not modify in Salesforce |
For more information about how or when to use the above, see our documentation.
Back to Documentation