Cart - Liquid Object Reference - 0.11.5

Object Name Cart
Version 0.11.5

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.

Attributes

Attribute Type Description
adjustment_items List[LineItem] Returns a list of adjustment LineItems in 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
bookable? Boolean Returns true if the Cart contains any Bookable products
bookable_items List[LineItem] Returns a list of LineItems in this Cart which are for Bookable products
bookable_line_items_valid_until Timestamp Returns the timestamp after which the Booking Timer is expired
cache_key String Returns a key that can be used for caching.
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
id String Returns the unique id for this Cart
item_count Number Returns the total number of items in this Cart
items List[LineItem] Returns a list of LineItems in this Cart
payment_surcharge_values List[Surcharge] Returns a list of Surcharges that might be applied to this Cart
points_payment_required? Boolean Returns true if the Cart requires a points amount to be charged at checkout
quotable? Boolean Returns true if the Cart contains any LineItems that allow quotes
sub_total Number Returns the sub total price for all LineItems, excluding any taxes where tax is exclusive
sub_total_points Number Returns the sub total points price for all LineItems
taxes List[Tax] Returns a list of LineItems 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 LineItems in this Cart
total_deposit_points Number Returns the total deposit points amount for all LineItems 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_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

Objects that return Carts

Back to Object List

Back to Liquid Reference for 0.11.5

 

 
Back to Documentation