Cart - Liquid Object Reference
On this page
Description
The Cart object represents a shopping cart for a customer’s purchasing session. It holds the items that the customer is intending to purchase.
:::note
This object supports custom data via the data attribute.
:::
Backed by
This drop renders the s_c__Cart__c Salesforce object. A theme writes it as cart.
| Liquid attribute | Salesforce field |
|---|---|
discount_mode |
s_c__Discount_Mode__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 cart.data. See custom data fields in Liquid.
Attributes
| Attribute | Type | Description |
|---|---|---|
adjustment_items |
List[CartItem] | Returns a list of adjustment CartItems in this Cart |
all_vouchers |
List[AppliedVoucher] | Returns a list of all vouchers for this Cart |
applied_credits |
List[AppliedCredit] | Returns a list of AppliedCredits for this Cart |
applied_vouchers |
List[AppliedVoucher] | Returns a list of AppliedVouchers for this Cart |
billing_address |
Address | Returns the billing Address for this Cart |
bookable_cart_items_valid_until |
Timestamp | Returns the timestamp after which the Booking Timer is expired |
bookable_items |
List[CartItem] | Returns a list of CartItems in this Cart which are for Bookable products |
bookable_line_items_valid_until |
Timestamp | Deprecated: Returns the timestamp after which the Booking Timer is expired |
bookable? |
Boolean | Returns true if the Cart contains any Bookable products |
cache_key |
String | Returns a key that can be used for caching. |
contact |
Contact | Returns the Contact for this Cart |
created_at |
Timestamp | Returns the date and time when the Cart was created |
currency_code |
String | Returns currency used for this Cart |
currency_payment_required? |
Boolean | Returns true if the Cart requires a currency amount to be charged at checkout |
custom_forms |
List[CustomForm] | Returns a list of CustomForms for this Cart |
id |
String | Returns the unique id for this Cart |
item_count |
Number | Returns the total number of items in this Cart |
items |
List[CartItem] | Returns a list of CartItems in this Cart |
payment_provider |
PaymentProvider | Returns selected PaymentProvider for this Cart, defaults to first available |
payment_surcharge_values |
List[Surcharge] | Returns a list of Surcharges that might be applied to this Cart |
pickup_options |
List[PickupOption] | Returns a list of Pickup options for this Cart |
points_payment_required? |
Boolean | Returns true if the Cart requires a points amount to be charged at checkout |
promotions |
List[Promotion] | Returns a list of Promotions that have been applied to this Cart |
quotable? |
Boolean | Returns true if the Cart contains any CartItems that allow quotes |
require_delivery_method? |
Boolean | Returns true if the Cart requires a delivery method to be selected at checkout |
schedulable_items |
List[CartItem] | Returns a list of CartItems in this Cart which are for products which can be scheduled for delivery |
select_path |
String | Returns the path to select this Cart |
shipping_address |
Address | Returns the shipping Address for this Cart |
shipping_cost |
Number | Returns the shipping cost for this Cart |
shipping_provider_service_name |
String | Returns the name of the shipping provider service for this Cart |
shipping_rates |
List[ShippingRate] | Returns a list of ShippingRates for items in this Cart |
sub_total |
Number | Returns the sub total price for all CartItems, excluding any taxes where tax is exclusive |
sub_total_points |
Number | Returns the sub total points price for all CartItems |
taxes |
List[Tax] | Returns a list of CartItems in this Cart |
test_order? |
Boolean | Returns true if the Cart represents a test order |
total |
Number | Returns the total price including tax for this Cart |
total_deposit |
Number | Returns the total deposit amount for all CartItems in this Cart |
total_deposit_points |
Number | Returns the total deposit points amount for all CartItems in this Cart |
total_fixed_term_subscriptions |
Number | Returns the total price for fixed term subscriptions in this Cart |
total_fixed_term_subscriptions_points |
Number | Returns the total points price for fixed term subscriptions in this Cart |
total_non_subscriptions |
Number | Returns the total price for non-subscription items in this Cart |
total_non_subscriptions_points |
Number | Returns the total points price for non-subscription items in this Cart |
total_paid |
Number | Returns the total amount already paid for this Cart |
total_paid_points |
Number | Returns the total points amount already paid for this Cart |
total_payable |
Number | Returns the total amount to be paid at checkout for this Cart |
total_payable_points |
Number | Returns the total points amount to be paid at checkout for this Cart |
total_points |
Number | Returns the total points price for this Cart |
total_shipping_weight_kg |
Number | Returns the total shipping weight of the Cart in kilograms |
total_shipping_weight_lb |
Number | Returns the total shipping weight of the Cart in pounds |
total_subscriptions |
Number | Returns the total price for subscription items in this Cart |
total_subscriptions_points |
Number | Returns the total points price for subscription items in this Cart |
total_tax |
Number | Returns the total tax for this Cart |
Available on
- Contact - Liquid Object Reference —
carts - Global - Liquid Object Reference —
current_cart
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.