Skip to content
Log in

Pricebook - Liquid Object Reference

On this page

Description

The Pricebook object contains information about a Pricebook.

:::note This object supports custom data via the data attribute. :::

Backed by

This drop renders the Pricebook2 Salesforce object. A theme writes it as pricebook.

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
default_earn_rate s_c__Default_Earn_Rate__c
default_purchase_rate s_c__Default_Purchase_Rate__c
hide_price_text s_c__Hide_Price_Text__c
order_quantity_maximum s_c__Order_Quantity_Maximum__c
out_of_stock_text s_c__Out_Of_Stock_Text__c
tax_method s_c__Tax_Method__c
unavailable_text s_c__Unavailable_Text__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.data. See custom data fields in Liquid.

Attributes

Attribute Type Description
active? Boolean Returns whether this Pricebook 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
currency String Returns the currency code for this Pricebook
default_earn_rate Number Returns the default earn rate for this Pricebook
default_purchase_rate Number Returns the default purchase rate for this Pricebook
hide_price_text String Returns the text to display when the price is hidden
id String Returns the unique id for this Pricebook
name String Returns the name for this Pricebook
order_quantity_maximum Number Returns the maximum order quantity for this Pricebook
out_of_stock_text String Returns the text to display when the product is out of stock
pricebook_entries PaginatedList[PricebookEntry] Returns the PricebookEntries associated with this Pricebook
standard? Boolean Returns whether this Pricebook is the standard pricebook
tax_method String Returns the tax method for this Pricebook
tax_zone Zone Returns the tax zone for this Pricebook
unavailable_text String Returns the text to display when the product is unavailable

Available on

Was this article helpful?

Was this article helpful?