• Location
  • Schema
  • Content
  • Usage

checkout.liquid

Deprecated

checkout.liquid is now unsupported for the Information, Shipping, and Payment checkout steps. 'checkout.liquid', additional scripts, and script tags are deprecated for the Thank you and Order status pages and will be sunset on August 28, 2025.

Stores that currently use checkout.liquid for the Thank you and Order status pages need to upgrade to Checkout Extensibility before the deadline. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.

Learn how to build checkout extensions that extend the functionality of Shopify checkout.

The checkout.liquid layout renders the checkout and is available only to Shopify Plus merchants. If your store isn't on Shopify Plus, then you can customize your checkout pages in the theme editor.

Location

Anchor link to section titled "Location"

The checkout.liquid layout is located in the layout directory of the theme:

Schema

Anchor link to section titled "Schema"

The checkout.liquid layout has the following format by default:

Content

Anchor link to section titled "Content"

The checkout.liquid layout has specific checkout objects to render various checkout content, depending on the checkout step.

Checkout steps

Anchor link to section titled "Checkout steps"

The checkout has the following steps:

Step Description
Inventory issues This step is displayed if one or more of the cart items is out of stock, or the inventory level is below what the customer has requested. Customers are shown a confirmation button that will update their cart with the available item quantities.
Contact information The customer enters their email address and will have the option to log in if customer accounts are enabled for the store. If any cart items require shipping, then the customer is shown a shipping address form. Otherwise, the customer is shown a billing address form.
Shipping method The customer selects a shipping option or edits their shipping information. This step is skipped when none of the cart items require shipping. Skipping the shipping method is common for merchants selling digital products or services. Clicking Edit shipping information returns the visitor to the Customer information step.
Payment method The customer chooses a payment method and, if applicable, enters payment information. Some payment providers require the customer to complete payment information on a different site. Customers can also specify a different billing address during this step.
Review order

Optional based on checkout settings. The customer confirms their order total, shipping and billing addresses, and payment details by clicking Complete order.

This step might be required if the store is operating in the European Union.

Processing/forwarding A temporary page shown to customers as their order is being processed, or as they are being redirected to an off-site payment provider. The message displayed during this step depends on your checkout's translation settings.
Order status The last step of checkout. This step is displayed after an order is complete. Learn more ›

On every step, an Order summary showing the products, price, taxes, and shipping costs is displayed in the right column. This column collapses at mobile breakpoints.

Tip

You can use JavaScript to identify the current step.

Checkout objects

Anchor link to section titled "Checkout objects"
Object Description Required
content_for_header The scripts from Shopify for features like hCaptcha, Shopify apps, and more. You need to add a reference to this object between the <head> and </head> HTML tags. Yes
content_for_layout The form fields and content for each step of the checkout process. You need to add a reference to this object between the <body> and </body> HTML tags. Yes
locale The currently-selected locale. No
direction The CSS direction of the content. For example, ltr or rtl. No
page_title The page title. Commonly wrapped in <title> and </title> tags. No
skip_to_content_link A hidden link for accessibility that allows users to skip to the main content. No
checkout_html_classes A string that should be added to the <html> tag to benefit from Shopify's default CSS. No
checkout_stylesheets Shopify's checkout stylesheets. It's recommended that you don't remove this, even if you have your own stylesheets, as it requires extensive work to replace the default styling. No
checkout_scripts Shopify's JavaScript files. No
content_for_logo The store logo, as determined by the checkout settings. No
breadcrumb The list of steps required to complete the checkout. The breadcrumb doesn't display on the final review step during checkout. No
order_summary_toggle The markup necessary to show and hide the order summary on mobile devices. No
content_for_order_summary The content summary, including line items, discounts, taxes, and totals. No
alternative_payment_methods The list of available express payment methods, such as PayPal. No
content_for_footer The list of your store policies or, if the list is empty, a copyright notice. No
tracking_code The JavaScript responsible for Google Analytics and Facebook Pixel tracking. No
checkout The checkout object. No

Caution

If you don't include the required objects in your checkout.liquid template, then you can't save or update the file using the code editor or tools like Shopify CLI.

Usage

Anchor link to section titled "Usage"

When working with checkout.liquid, you should familiarize yourself with the following concepts:

  • How to access checkout.liquid
  • Considerations for customizing checkout content
  • How to identify the current checkout step
  • Page events
  • Checkout jQuery
  • How to capture checkout attributes

Access checkout.liquid

Anchor link to section titled "Access checkout.liquid"

To enable or disable access to checkout.liquid, Shopify Plus merchants must contact support.

Before requesting access to checkout.liquid, you should be familiar with the following versions of checkout and their implications:

Version Description
Standard The default checkout. It's used if access to checkout.liquid isn't enabled, and is automatically updated as Shopify releases updates and features for the checkout.
Maintenance

Used when access to checkout.liquid is enabled. It's a stable version of Standard, frozen at a specific time. This means that it's not automatically updated. If you use Maintenance, then you can get access to updates and features in the following ways:

  • Disable access to checkout.liquid to move back onto Standard.
  • Wait for Maintenance to be upgraded and follow the manual checkout upgrade process.

Add checkout.liquid to your theme

Anchor link to section titled "Add checkout.liquid to your theme"

If access to checkout.liquid has been enabled, then you can follow the steps below to add the layout to your theme through the code editor in the Shopify admin:

  1. From your Shopify admin, go to Online Store > Themes.

  2. Find the theme that you want to edit, and then click ... > Edit code.

  1. From the Shopify app, tap Store.

  2. In the Sales channels section, tap Online Store.

  3. Tap Manage all themes.

  4. Find the theme that you want to edit, and then tap ... > Edit code.

  1. From the Shopify app, tap Store.

  2. In the Sales channels section, tap Online Store.

  3. Tap Manage all themes.

  4. Find the theme that you want to edit, and then tap ... > Edit code.

  1. In the Layout directory, click Add a new layout.
  2. In the drop-down list, select checkout, and then click Create layout.

You should now see checkout.liquid listed in the Layout directory.

Customize checkout content

Anchor link to section titled "Customize checkout content"

You can't edit the content generated by any of the checkout objects, required or optional, before they're rendered. The only exceptions to this are for translation settings, theme editor settings, and some options made available in the Shopify admin.

If you need to customize the content output by a checkout object, then you need to use JavaScript to alter the content after it's been rendered. To learn more about customizing this content, refer to Best practices for editing checkout.liquid.

Step identification

Anchor link to section titled "Step identification"

The checkout is all hosted on one page, which means that the URL remains the same regardless of which step of the process a customer is on. To account for this, you can use the following JavaScript objects to identify where the customer is in the checkout process.

  • Shopify.Checkout.step
  • Shopify.Checkout.page
  • Shopify.Checkout.OrderStatus

Tip

The above JavaScript objects can be viewed using your browser's developer tools.

Shopify.Checkout.step

Anchor link to section titled "Shopify.Checkout.step"

An object that shows which step of the checkout the customer is on. It returns one of the following results:

  • contact_information
  • shipping_method
  • payment_method
  • processing - This is the step between the payment_method step and the thank_you page.
  • review - This is an optional step set in the Shopify Admin.

Note

This object is defined only when the customer first visits the Order Status page.

Shopify.Checkout.page

Anchor link to section titled "Shopify.Checkout.page"

An object that shows which type of page the customer is on. It returns one of the following results:

  • show - A page template for various steps of the checkout process.
  • stock_problems - A page that displays if there's an inventory issue with any cart items.
  • processing - A page that displays while the payment is being processed.
  • forward - A page from PayPal or another third-party gateway.
  • thank_you

Note

This object is defined only when the customer first visits the Order Status page.

Shopify.Checkout.OrderStatus

Anchor link to section titled "Shopify.Checkout.OrderStatus"

An object that can be used for adding content to the Order status page. It can also help determine whether the customer is on a Thank You page or an Order Status page.

The Order Status page is usually considered as a checkout page. However, the first time a customer visits the page, it's considered as a Thank You page, where the Shopify.Checkout.step and Shopify.Checkout.page objects are defined.

If the customer revisits or reloads the page, then this checkout is converted to an order, and the page loads as an Order Status page, where the Shopify.Checkout.step and Shopify.Checkout.page objects are undefined and the Shopify.Checkout.OrderStatus object is defined.

Page events

Anchor link to section titled "Page events"

All of the checkout steps are hosted at a single URL path, where the content is loaded dynamically depending on the current step. There are two main page events that are triggered during this process:

  • page:load
  • page:change

page:load

Anchor link to section titled "page:load"

The page:load event is triggered when the content of each step is loaded. This is the default event that you should use when adding content into the page on load.

page:change

Anchor link to section titled "page:change"

The page:change event is triggered when the customer is on the same checkout step, but part of the content has changed. For example, this event triggers when the discount form is submitted.

If you add content to the Document Object Model (DOM) with only page:load, then there’s a risk that it could be overwritten by a page:change event. To avoid this issue, you should watch for both events when adding content.

Checkout jQuery

Anchor link to section titled "Checkout jQuery"

The checkout contains its own version of jQuery, which can be accessed using Checkout.$.

Note

The checkout's version of jQuery is not always the most recent version. If you need any functionality from a more recent version of jQuery, then you'll need to include it specifically.

Capture checkout attributes

Anchor link to section titled "Capture checkout attributes"

You can capture checkout attributes in a similar way to capturing cart attributes.

To capture a checkout attribute, include an input with an attribute of name="checkout[attributes][attribute-name]", where attribute-name is the desired name of your attribute, inside the main checkout form.

Tip

If you're collecting attributes on the Payment method step, then you should populate them with a placeholder value before allowing the order to proceed. If the attribute has a blank value, then it can cause an error noting that the checkout has changed.

Note that capturing checkout attributes will remove any existing cart attributes. To learn how to avoid this issue, refer to Preserve cart attributes below.

Preserve cart attributes

Anchor link to section titled "Preserve cart attributes"

When capturing checkout attributes, you can preserve any cart attributes with the checkout.attributes Liquid object, which contains the cart attribute values. You can loop through the attributes to add them as checkout attribute inputs with names and values defined by the existing attribute data.

This snippet should be included inside a JavaScript function for placing the attribute inputs inside the main form.

On this page

  • Location
  • Schema
  • Content
  • Usage