• What you'll learn
  • Requirements
  • How it works
  • Pre-purchase
  • Post-purchase
  • Pre and post purchase
  • Testing the extension in the checkout editor
  • Next steps

Create multi-page extensions

In this tutorial, you'll learn how an extension can target checkout, the Thank you page, the Order status page, or all of the above, to create a seamless experience for merchants and their customers.

What you'll learn

Anchor link to section titled "What you'll learn"

In this tutorial, you'll learn how to create a checkout UI extension that can render in checkout, the Thank you page, the Order status page, or all three areas.

Requirements

Anchor link to section titled "Requirements"
  • You're familiar with Thank you and Order status extensions.

  • You've created a Partner account.

  • You've created a new development store with the following:

    • Generated test data
    • Checkout and Customer Accounts Extensibility developer preview enabled

  • You've created an app that uses Shopify CLI 3.0 or higher.

How it works

Anchor link to section titled "How it works"

You can use a checkout UI extension to add custom content across multiple pages of checkout.

Depending on the page and state of Shopify’s internal order processing, the targets and APIs available to extensions can vary.

A multi-page extension can be used to add custom content such as final sale details, upsells, surveys and more. The following examples demonstrate how to use targets to target different parts of the flow, depending on your use case.

Pre-purchase

Anchor link to section titled "Pre-purchase"

You can configure an extension to display before a purchase is completed by using the purchase.checkout.cart-line-item.render-after target. This means that merchants can place the extension on the information, payment and shipping steps of checkout (pre-purchase).

An image that shows an extension in the order summary displaying that the product cannot be shipped to PO boxes

Post-purchase

Anchor link to section titled "Post-purchase"

You can configure an extension to display after a purchase is completed by using both the purchase.thank-you.cart-line-item.render-after and customer-account.order-status.cart-line-item.render-after targets. This means that merchants can place the extension on the Thank you and Order status pages (post-purchase).

An image that shows an extension in the order summary displaying expected shipping delays

Pre and post purchase

Anchor link to section titled "Pre and post purchase"

You can configure an extension to display on all areas of the checkout flow by combining the purchase.checkout.cart-line-item.render-after, purchase.thank-you.cart-line-item.render-after and customer-account.order-status.cart-line-item.render-after targets.

An image that shows an extension in the order summary final sale, no returns or exchanges

Testing the extension in the checkout editor

Anchor link to section titled "Testing the extension in the checkout editor"
  1. Follow the guide to test an extension in the editor
  2. Use the dropdown list at the top of the page to navigate to the Thank you and Order status pages.

Note

In a future release, we'll improve the extension installation in the editor to enable merchants to add an extension to multiple pages at once and share configuration between each placements.

Next steps

Anchor link to section titled "Next steps"

Get started with editor extension collections

Get started with building editor extension collections to group multi-page extensions

On this page

  • What you'll learn
  • Requirements
  • How it works
  • Pre-purchase
  • Post-purchase
  • Pre and post purchase
  • Testing the extension in the checkout editor
  • Next steps