PricebookEntry - Liquid Object Reference - 1.1.0
| Object Name | PricebookEntry |
| Version | 1.1.0 |
Description
The PricebookEntry object contains information about a PricebookEntry.
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 |
| data | Object | Returns a custom data object for this object |
| 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? | Boolean | Returns whether the price is hidden for this PricebookEntry |
| hide_price_text | String | Returns the text to display when the price is hidden |
| 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? | Boolean | Returns whether this PricebookEntry is restricted |
| restricted_text | String | Returns the text to display when this PricebookEntry is restricted |
| sale_price | Number | Returns the sale price 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[Number] | Returns the variable pricing options for this PricebookEntry |
Objects that return PricebookEntries
Back to Liquid Reference for 1.1.0
Back to Documentation