PricebookEntry Object Reference
Field Definitions
| Field Name | Type | Required | Unique | Description |
|---|---|---|---|---|
| Add_To_Cart_Text__c | Text | No | No | Text to be displayed on the Add to Cart buttons for the Product. If blank, the Pricebook2.Add_To_Cart_Text__c field will be used |
| Balloon_Price__c | Currency(18, 2) | No | No | If set this will be used as the amount that will be billed at the end of the subscription term. |
| Buy_It_Now_Text__c | Text | No | No | Text to be displayed on the Buy it Now buttons for the Product. If blank, the Pricebook2.Buy_It_Now_Text__c field will be used. |
| Can_Earn_Points__c | Checkbox(false) | No | No | If checked, customers can earn points by purchasing this product. |
| Can_Purchase_With_Currency__c | Checkbox(true) | No | No | If checked, customers can use currency to purchase this product. |
| Can_Purchase_With_Points__c | Checkbox(false) | No | No | If checked, customers can use points to purchase this product. |
| Deposit_Amount__c | Currency(18, 2) | No | No | If set the user will be charged this amount as a deposit during checkout. |
| Deposit_Points__c | Number(18, 0) | No | No | If set the user will be charged this amount of points as a deposit during checkout. |
| Disable_Quantity_Selection__c | Checkbox(false) | No | No | Prevents users from editing the quantity when purchasing this Product. If enabled, s_c__Order_Quantity_Maximum__c must be set (either on this PriceBookEntry or its related PriceBook) as it is used as the quantity when a customer purchases the Product |
| Display_If_Restricted__c | Checkbox(true) | No | No | |
| Earn_Points_Bonus__c | Number(18, 0) | No | No | The amount of bonus points earned by purchasing this product. Bonus points are earned on top of any other points earned, if any. |
| Earn_Points__c | Number(18, 0) | No | No | The amount of points earned by purchasing this product. If blank and Can Earn Points is true, the Price Book’s Default Earn Rate will be used to calculate the number of points earned. |
| Enable_Variable_Pricing__c | Checkbox(false) | No | No | Allow the customer to choose how much they would like to pay (e.g. for donations). The minimum price allowed is the Price or s_c__Sale_Price__c |
| Hide_Price_Text__c | Text | No | No | Text to be displayed in place of the price for the Products when s_c__Hide_Price__c is true. If blank the Pricebook2.Hide_Price_Text__c field will be used. |
| Hide_Price__c | Checkbox(false) | No | No | If enabled the Product will show s_c__Hide_Price_Text__c in place of a price, for example to show “Price on Application”. |
| 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 the Product2.Minimum_Sell_Price field is used. |
| Order_Quantity_Maximum__c | Number(18, 0) | No | No | The maximum quantity of any individual Product which can be added to a single Order. Products that track inventory will use either this or the current stock availability as the limit (whichever is lower). If blank the value in PriceBook.s_c__Order_Quantity_Maximum__c will be used. |
| Out_Of_Stock_Text__c | Text | No | No | Text to be displayed if the Product is out of stock. If blank the Pricebook2.Out_Of_Stock_Text__c field will be used. |
| Percentage__c | Percent(8, 6) | No | No | The percentage value to add to all orders that include this product. This is calculated on the toal amount of the order after any shipping and taxes. |
| Purchase_Points_Sale__c | Number(18, 0) | No | No | If set this will be used as the points price required to purchase this product. |
| Purchase_Points__c | Number(18, 0) | No | No | The amount of points required to purchase this product. If blank and Can Purchase With Points is true, the Price Book’s Default Purchase Rate will be used to calculate the number of points required. |
| Restricted_Text__c | Text | No | No | |
| Restricted__c | Checkbox(false) | No | No | |
| Sale_Price__c | Currency(18, 2) | No | No | If set this will be used as the amount users will be charged for the Product. If blank the Price field is used. |
| Setup_Price__c | Currency(18, 2) | No | No | If set this will be used as the amount that will be billed at the start of the subscription term. |
| Variable_Pricing_Options__c | MultiselectPicklist | No | No | The allowed prices if s_c__Enable_Variable_Pricing__c is enabled. Selecting “Other” allows the user to enter any amount as long as it’s higher than Price. Custom names should be in cents (e.g. 5000 for $50). |
| 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