{"title":"Pricebook2 Object Reference","slug":"pricebook2-object-reference","url":"https://support.storeconnect.com/articles/pricebook2-object-reference","url_markdown":"https://support.storeconnect.com/articles/pricebook2-object-reference.md","subtitle":null,"summary":"Reference documentation for the Pricebook2 object in StoreConnect.","type":"Developer_Documentation","video_url":"","keywords":"salesforce, object reference, Pricebook2, Pricebook2, api","last_modified":"2026-08-21T07:12:35+0000","body_markdown":"## Overview\n\n| Property | Value |\n|----------|-------|\n| **API Name** | `Pricebook2` |\n| **Label** | Pricebook2 |\n| **Plural Label** | Pricebook2s |\n| **Type** | Standard Object |\n\n## Fields\n\n| Field Label | API Name | Type | Required | Description |\n|-------------|----------|------|----------|-------------|\n| Add to Cart Text | `s_c__Add_To_Cart_Text__c` | Text(128) | No | Text to be displayed on Add to Cart buttons for Products. Can be overridden for individual Products with PriceBookEntry.s_c__Add_To_Cart_Text__c. If blank, the text 'Add to Cart' will be used. |\n| Buy it Now Text | `s_c__Buy_It_Now_Text__c` | Text(128) | No | Text to be displayed on Buy it Now buttons for Products. Can be overridden for individual Products with PriceBookEntry.s_c__Buy_It_Now_Text__c. If blank, the text 'Buy it Now' will be used. |\n| Default Earn Rate | `s_c__Default_Earn_Rate__c` | Number(18,4) | No | The default conversion rate for earning points from purchases. Used if product can earn points and the Pricebook Entry does not specify an earn points value. |\n| Default Purchase Rate | `s_c__Default_Purchase_Rate__c` | Number(18,2) | No | The default conversion rate for when purchasing using points. This value is used if product is bought with points and the Pricebook Entry does not specify an purchase points value. |\n| Hide Price Text | `s_c__Hide_Price_Text__c` | Text(128) | No | Text to be displayed in place of the price on Products where PriceBookEntry.s_c__Hide_Price__c is enabled. Can be overridden for individual Products with PriceBookEntry.s_c__Hide_Price_Text__c. If blank \"POA\" will be used. |\n| Minimum Deposit Amount | `s_c__Minimum_Deposit_Amount__c` | Currency(18,2) | No | If set the user will be asked for this minimum deposit amount set during checkout. |\n| Minimum Deposit Percent | `s_c__Minimum_Deposit_Percent__c` | Number(16,4) | No | Minimum Deposit Percent |\n| Minimum Deposit Points | `s_c__Minimum_Deposit_Points__c` | Number(18,0) | No | If set the user will be asked for this minimum deposit point set during checkout |\n| Order Quantity Maximum | `s_c__Order_Quantity_Maximum__c` | Number(18,0) | 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). Can be overridden for individual Products with PriceBookEntry.s_c__Order_Quantity_Maximum__c. If left blank then stock availability is used as the limit (or no limit if the Product is backorderable). |\n| Out of Stock Text | `s_c__Out_Of_Stock_Text__c` | Text(128) | No | Text to be displayed if the Product is out of stock (for Products that track stock). Can be overridden for individual Products with PriceBookEntry.s_c__Out_Of_Stock_Text__c. If blank 'Out of Stock' will be shown. |\n| Tax Method | `s_c__Tax_Method__c` | Picklist | No | Defines whether product pricing is tax inclusive, exclusive or exempt for a store, account or membership.  Can be overridden by corresponding related price book entries Tax_Method__c field.  Default is Exclusive.  A none/null value is equivalent to Exclusive. |\n| Tax Zone | `s_c__Tax_Zone_Id__c` | Lookup ([s_c__Zone__c](zone-object-reference)) | No | The tax zone applicable to all entries within this price book if tax method is Inclusive \u0026 single currency org. Can be overridden by corresponding related price book entries Tax_Zone_Id__c field. |\n| Unavailable Text | `s_c__Unavailable_Text__c` | Text(255) | No | Text to be displayed in place of the price when a Product is not available to purchase (e.g. is discontinued). If blank, \"Unavailable\" will be shown. |\n| StoreConnect External ID | `s_c__sC_Id__c` | Text(36) | No | StoreConnect External ID, do not modify in Salesforce |\n\n## Relationships\n\n| Field | Type | Related Object | Relationship Name |\n|-------|------|----------------|-------------------|\n| `s_c__Tax_Zone_Id__c` | Lookup | [s_c__Zone__c](zone-object-reference) | Price_Books_Zone |\n\n## Referenced by\n\nThese objects hold a lookup or master-detail relationship to **Pricebook2** (`Pricebook2`). Where the referring record exists to join things together, **Also links to** shows what it connects this object to.\n\n| Object | Field | Type | Relationship Name | Also links to |\n|--------|-------|------|-------------------|---------------|\n| [Account](account-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Account_Pricebook | — |\n| [s_c__Cart__c](cart-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Cart_Pricebooks | — |\n| [s_c__Component_Pricing__c](component-pricing-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Component_Pricings_Pricebook | [Product2](product2-object-reference) |\n| [s_c__Discount__c](discount-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Discounts | — |\n| [s_c__Membership__c](membership-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Memberships | [Product2](product2-object-reference), [s_c__Product_Category__c](product-category-object-reference) |\n| [s_c__Outlet__c](outlet-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Outlet_Pricebooks | — |\n| [s_c__Promotion_Scope__c](promotion-scope-object-reference) | `s_c__Pricebook_Id__c` | Lookup | promotions_for_pricebook | — |\n| [s_c__Store__c](store-object-reference) | `s_c__Pricebook_Id__c` | Lookup | Store_Pricebook | — |\n\n\u003c!-- DIAGRAM OPPORTUNITY\n     8 objects point at this one. A fan-in diagram would make the dependency direction obvious at a glance.\n     Deferred to the diagram phase; remove this comment when a diagram is added. --\u003e"}