PricebookEntry - Liquid Object Reference
On this page
Description
The PricebookEntry object contains information about a PricebookEntry.
:::note
This object supports custom data via the data attribute.
:::
Backed by
This drop renders the PricebookEntry Salesforce object. A theme writes it as pricebook_entry.
| Liquid attribute | Salesforce field |
|---|---|
add_to_cart_text |
s_c__Add_To_Cart_Text__c |
buy_it_now_text |
s_c__Buy_It_Now_Text__c |
can_earn_points? |
s_c__Can_Earn_Points__c |
can_purchase_with_currency? |
s_c__Can_Purchase_With_Currency__c |
can_purchase_with_points? |
s_c__Can_Purchase_With_Points__c |
deposit_amount |
s_c__Deposit_Amount__c |
deposit_points |
s_c__Deposit_Points__c |
disable_quantity_selection? |
s_c__Disable_Quantity_Selection__c |
display_if_restricted? |
s_c__Display_If_Restricted__c |
earn_points |
s_c__Earn_Points__c |
earn_points_bonus |
s_c__Earn_Points_Bonus__c |
enable_variable_pricing? |
s_c__Enable_Variable_Pricing__c |
hide_price_text |
s_c__Hide_Price_Text__c |
hide_price? |
s_c__Hide_Price__c |
minimum_sell_price |
s_c__Minimum_Sell_Price__c |
order_quantity_maximum |
s_c__Order_Quantity_Maximum__c |
out_of_stock_text |
s_c__Out_Of_Stock_Text__c |
percentage |
s_c__Percentage__c |
purchase_points |
s_c__Purchase_Points__c |
purchase_points_sale |
s_c__Purchase_Points_Sale__c |
restricted_text |
s_c__Restricted_Text__c |
restricted? |
s_c__Restricted__c |
sale_price |
s_c__Sale_Price__c |
tax_method |
s_c__Tax_Method__c |
variable_pricing_options |
s_c__Variable_Pricing_Options__c |
Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.
Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from pricebook_entry.data. See custom data fields in Liquid.
Attributes
| Attribute | Type | Description |
|---|---|---|
active? |
Boolean | Returns whether this PricebookEntry is active |
add_to_cart_text |
String | Returns the text to display on the Add to Cart button |
buy_it_now_text |
String | Returns the text to display on the Buy It Now button |
can_earn_points? |
Boolean | Returns whether this PricebookEntry can earn points |
can_purchase_with_currency? |
Boolean | Returns whether this PricebookEntry can be purchased with currency |
can_purchase_with_points? |
Boolean | Returns whether this PricebookEntry can be purchased with points |
currency |
String | Returns the currency code for this PricebookEntry |
deposit_amount |
Number | Returns the deposit amount for this PricebookEntry |
deposit_points |
Number | Returns the deposit points for this PricebookEntry |
disable_quantity_selection? |
Boolean | Returns whether the quantity selection is disabled for this PricebookEntry |
display_if_restricted? |
Boolean | Returns whether this PricebookEntry is displayed if restricted |
earn_points |
Number | Returns the number of points earned for this PricebookEntry |
earn_points_bonus |
Number | Returns the bonus points earned for this PricebookEntry |
enable_variable_pricing? |
Boolean | Returns whether variable pricing is enabled for this PricebookEntry |
hide_price_text |
String | Returns the text to display when the price is hidden |
hide_price? |
Boolean | Returns whether the price is hidden for this PricebookEntry |
id |
String | Returns the unique id for this Pricebook |
minimum_sell_price |
Number | Returns the minimum sell price for this PricebookEntry |
name |
String | Returns the name for this PricebookEntry |
order_quantity_maximum |
Number | Returns the maximum order quantity for this PricebookEntry |
out_of_stock_text |
String | Returns the text to display when the product is out of stock |
percentage |
Number | Returns the percentage for this PricebookEntry |
pricebook |
Pricebook | Returns the Pricebook to which this PricebookEntry belongs |
product |
Product | Returns the Product to which this PricebookEntry belongs |
productcode |
String | Returns the product code for this PricebookEntry |
purchase_points |
Number | Returns the number of points required to purchase this PricebookEntry |
purchase_points_sale |
Number | Returns the number of points required to purchase this PricebookEntry on sale |
restricted_text |
String | Returns the text to display when this PricebookEntry is restricted |
restricted? |
Boolean | Returns whether this PricebookEntry is restricted |
sale_price |
Number | Returns the sale price for this PricebookEntry |
tax_method |
String | Returns the tax method for this PricebookEntry |
tax_zone |
Zone | Returns the tax zone for this PricebookEntry |
unitprice |
Number | Returns the unit price for this PricebookEntry |
use_standard_price? |
Boolean | Returns whether the standard price is used for this PricebookEntry |
variable_pricing_options |
List | Returns the variable pricing options for this PricebookEntry |
Available on
- OrderItem - Liquid Object Reference —
pricebook_entry - Pricebook - Liquid Object Reference —
pricebook_entries - Product - Liquid Object Reference —
pricebook_entry
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.