LineItem - Liquid Object Reference - 1.1.0
| Object Name | LineItem |
| Version | 1.1.0 |
Description
A LineItem represents a single line in the customer’s Cart. It always relfects a Product that the customer is purchasing, whether it be a regular product, a bundle, a subscription, or even shipping. Whatever the Product is, the LineItem always represents a single distinct configuration of that Product.
Attributes
| Attribute | Type | Description |
|---|---|---|
| bookable? | Boolean | Returns true if the LineItem is for a bookable Product |
| bookable_event | BookableEvent | Returns the BookableEvent for the LineItem |
| bundle_items | List[LineItem] | Returns the items contained in the Bundle |
| bundle_lead? | Boolean | Returns true if the LineItem is the lead item in a Bundle |
| custom_forms | List[CustomForm] | Returns a list of CustomForms for this LineItem |
| delete_path | String | Returns a path that can be used in a delete link to delete the LineItem from the Cart |
| edit_bundle_path | String | Returns a path that can be used in a link to edit LineItem |
| id | String | Returns the unique id for this LineItem |
| in_bundle? | Boolean | Returns true if the LineItem is part of a Bundle |
| max_quantity | Number | Returns the maximum valid quantity level for this LineItem |
| min_quantity | Number | Returns the minimum valid quantity level for this LineItem |
| name | String | Returns the name of the LineItem Product |
| pickup_options | List[PickupOption] | Returns a list of valid Pickup locations for this LineItem Product |
| pricing | ProductPricing | Returns the Pricing for this LineItem |
| product | Product | Returns the Product for this LineItem |
| quantity | Number | Returns the value of the Quantity attribute |
| reserved_product? | Boolean | Returns true if the LineItem is for a reserved Product |
| shipping_methods | List[String] | Returns a list of valid shipping methods for this LineItem |
Deliveries
Attributes related to delivery windows
| Attribute | Type | Description |
|---|---|---|
| available_delivery_dates | List[Timestamp] | Returns available delivery dates for the LineItem |
| available_delivery_days | List[String] | Returns available delivery days for the LineItem |
| available_delivery_windows | List[DeliveryWindow] | Returns available DeliveryWindows for the LineItem |
| delivery_date | Timestamp | Returns the selected delivery date for the LineItem |
| delivery_day | String | Returns the selected delivery day for the LineItem |
| delivery_time | String | Returns the selected delivery timeslot for the LineItem |
Weights
Attributes related to weights
| Attribute | Type | Description |
|---|---|---|
| shipping_dimensions_unit | String | Returns the unit of the shipping dimensions of the LineItem |
| shipping_height | Number | Returns the shipping height of the LineItem |
| shipping_length | Number | Returns the shipping length of the LineItem |
| shipping_weight | Number | Returns the shipping weight of the LineItem |
| shipping_weight_unit | String | Returns the unit of the shipping weight of the LineItem |
| shipping_width | Number | Returns the shipping width of the LineItem |
| total_shipping_weight | Number | Returns the total shipping weight of the LineItem |
Objects that return LineItems
Back to Liquid Reference for 1.1.0
Back to Documentation