Order status page extensions
Order status page extensions enable merchants to add content to the order status page. This guide introduces how order status page extensions work, and provides some resources for getting started.
How it worksAnchor link to section titled "How it works"
You can use a checkout UI extension to add custom content to the order status page. The order status page first appears to the customer as an initial purchase confirmation after checkout.
The customer can refresh or revisit the page throughout the order creation and fulfillment process to review the details of their order, and any updates. For example, customers often visit the order status page after clicking on a link in the order confirmation email.
The information displayed on this page varies depending on the state of Shopify's internal order processing.
You can use an order status page extension to add custom content such as a post-checkout customer survey, product reviews, social sharing options, and download links for digital products or invoices. The following example demonstrates a post-checkout customer survey extension:
Getting startedAnchor link to section titled "Getting started"
Follow the getting started tutorial to learn how to build order status page extensions.
Developer tools and resourcesAnchor link to section titled "Developer tools and resources"
Explore the following developer tools and resources to get familiar with building order status page extensions.
Checkout UI extensions API reference
Consult the API reference for checkout UI extension points and their respective types.
Components for checkout UI extensions
Learn about the components that are available in checkout UI extensions.
Checkout extension configuration
Learn about the properties that you can configure in your checkout UI extension.
Limitations and considerationsAnchor link to section titled "Limitations and considerations"
- For the developer preview, order status page extensions can't currently be placed or tested with the checkout editor. You need to test locally instead.
- There's currently no support for write APIs to directly mutate the order in this developer preview. You can use
fetchto make network calls to web services your extension needs. For extensions that need to make changes to the order being created, consider making a post-purchase extension.
- Learn how to add a survey to the order status page.