The checkout object
The checkout
object can be accessed in the order status page of the checkout. Shopify Plus merchants can also access properties of the checkout
object in the checkout.liquid layout file.
The checkout
object has the following attributes:
checkout.applied_gift_cards
Returns the gift cards applied to the checkout.
checkout.attributes
Returns the attributes of the checkout, that were captured in the cart.
checkout.billing_address
Returns the billing address of the checkout.
checkout.buyer_accepts_marketing
Returns whether the buyer accepted the newsletter during the checkout.
Input
{% if checkout.buyer_accepts_marketing %}
Thank you for subscribing to our newsletter. You will receive our exclusive newsletter deals!
{% endif %}
Output
Thank you for subscribing to our newsletter. You will receive our exclusive newsletter deals!
checkout.cart_level_discount_applications
Returns an array of any cart-specific discount applications for the checkout.
Input
{% for discount_application in checkout.cart_level_discount_applications %}
Discount name: {{ discount_application.title }}
Savings: -{{ discount_application.total_allocated_amount | money }}
{% endfor %}
Output
Discount name: SUMMER16
Savings: -$20.00
checkout.currency
Returns the currency of the checkout. If your store uses multi-currency, then the checkout.currency
is the same as the customer's local (presentment) currency. Otherwise, the checkout currency is the same as your store currency.
To return the list of currencies that are accepted by your store, see the shop.enabled_currencies object.
Input
{{ checkout.currency.iso_code }}
Output
USD
checkout.customer
Returns the customer associated with the checkout.
checkout.discount_applications
Returns an array of discount applications for a checkout.
Input
{% for discount_application in checkout.discount_applications %}
Discount name: {{ discount_application.title }}
Savings: -{{ discount_application.total_allocated_amount | money }}
{% endfor %}
Output
Discount name: SUMMER16
Savings: -$20.00
checkout.discounts_amount
Returns the sum of the amount of the discounts applied to the checkout.
Input
You save: {{ checkout.discounts_amount | money }} <br>
Output
You save: $12.00
checkout.discounts_savings
Returns the sum of the savings of the discounts applied to the checkout. The negative opposite of discounts_amount.
checkout.email
Returns the email used during the checkout.
checkout.gift_cards_amount
Returns the amount paid in gift cards of the checkout.
checkout.id
Returns the id of the checkout.
checkout.line_items
Returns all the line items of the checkout.
checkout.line_items_subtotal_price
Returns the sum of the cart's line item prices after any line item discounts. The subtotal doesn't include taxes (unless taxes are included in the prices), cart discounts, or shipping costs.
Input
<!-- subtotal = total dollar value of cart items - line item discount -->
Subtotal: {{ checkout.line_items_subtotal_price | money }}
Output
<!-- for a cart containing a $500 product with a $50 line item discount -->
Subtotal: $450.00
checkout.name
Returns the name of the checkout. This value is identical to checkout.id
with a hash prepended to it.
checkout.note
Returns the note of the checkout.
checkout.order
Returns the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page and this property could be nil.
checkout.order_id
Returns the id of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.order_name
Returns the name of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.order_number
Returns the number of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.requires_shipping
Returns whether the checkout as a whole requires shipping, that is whether any of the line items require shipping.
Input
{% if checkout.requires_shipping %}
You will receive an email with your shipment tracking number as soon as your order is shipped.
{% endif %}
Output
You will receive an email with your shipment tracking number as soon as your order is shipped.
checkout.shipping_address
Returns the shipping address of the checkout.
checkout.shipping_method
Returns the shipping method of the checkout.
checkout.shipping_methods
Returns an array of shipping methods of the checkout.
Input
Shipping methods: <br>
{% for shipping_method in checkout.shipping_methods %}
* {{ shipping_method.title }}: {{ shipping_method.price | money }} <br>
{% endfor %}
Output
Shipping methods: <br>
* International Shipping: $12.00
checkout.shipping_price
Returns the shipping price of the checkout.
checkout.tax_lines
Returns all the tax lines of the checkout.
checkout.tax_price
Returns the tax price of the checkout, whether the taxes are included or not in the prices.
checkout.total_price
Returns the total price of the checkout.
Input
<!-- Total = subtotal + shipping cost - shipping discount + taxes -->
Total: {{ checkout.total_price | money }}
Output
<!-- For a $500 product with a $50 discount, $10 shipping, and a tax rate of 20% -->
Total: $552.00
checkout.transactions
Returns an array of transactions from the checkout.