Post-purchase checkout extensions overview
Post-purchase checkout extensions allow merchants to add a post-purchase page directly into the Shopify checkout. The post-purchase page appears after the order is confirmed, but before the thank you page. You can use these extensions to add custom content such as the following:
- Upsell offers
- Survey requests
- Feedback requests
- Donation requests
- Discount code offers
- Important notifications
- Loyalty sign-ups
RequirementsAnchor link to section titled "Requirements"
- You've created a Partner account and a development store.
- You follow the Guidelines and limitations and considerations.
- You request access to use the post-purchase checkout extension on a live store.
- You understand how apps fit into Shopify.
You've created an app that uses Shopify CLI 3.0 or higher, or you've migrated your existing app so it's compatible with Shopify CLI 3.0 or higher.
Customer flowAnchor link to section titled "Customer flow"
The following diagram illustrates a high-level customer flow for an app that uses a post-purchase checkout extension:
The customer goes to the payment information page.
The page loads the Checkout::PostPurchase::ShouldRender extension point.
(Optional) The extension makes a network call to your app server to obtain any data needed for the post-purchase page. The extension can store data in the browser's local storage, speeding up the time to the first render.
The extension returns the result of
renderto the payment information page. For
true, all the required conditions must be met (for example, the customer's credit card must be vaulted before the post-purchase offer is displayed).
The customer completes checkout.
If render returned
true, then the post-purchase page loads the Checkout::PostPurchase::Render extension point. Any stored data is directly available to the
renderextension point. You app needs to call done to redirect the customer to the thank you page.
App Bridge CheckoutAnchor link to section titled "App Bridge Checkout"
Post-purchase checkout extensions use App Bridge Checkout, a technology that hosts your extension on Shopify's CDN and integrates directly into the Shopify checkout. App Bridge Checkout includes a set of consistent UI components, extension points, and development tools.
You create an extension by writing in Vanilla JS or React, and deciding whether to use TypeScript. Shopify securely hosts and renders your user interface in the client. When the extension appears to the customer in the checkout, it includes both app-provided and Shopify-provided interface elements, as shown in the diagram below:
Limitations and considerationsAnchor link to section titled "Limitations and considerations"
The following limitations and considerations for post-purchase checkout extensions apply:
- Additional payment methods: The post-purchase page won't be surfaced in the following scenarios:
- The customer chooses to check out with an installment service or a wallet service (such as Klarna, Affirm, AfterPay, Apple Pay, Amazon Pay, or Google Pay).
- The initial purchase was made with a gift card or any payment method other than a credit card.
- Purchase events: Third-party analytic services that use the Shopify Pixel API (such as Google Analytics, Facebook, Pinterest and Snap) report only the purchase event and value for the initial purchase.
- Analytics: Third-party analytics services that use the
ScriptTagREST Admin API or GraphQL Admin API resource, or Additional Scripts have incomplete conversion data, because they're only triggered on the thank you page.
- Duties and support for multiple currencies: Post-purchase upsell offers won’t be surfaced on orders with duties and multiple currencies.
- Order creation delays: In scenarios such as flash sales where the Shopify Platform is under extreme load, our system might optimize to capture orders but briefly delay the order creation step for a fast and seamless buyer experience. In these scenarios, post-purchase pages won't be surfaced, even if the request for the post-purchase page was properly made.
- Multiple apps: Merchants with multiple apps that have the post-purchase checkout extension need to select which app appears on the post-purchase page. You can use a banner during app onboarding to let merchants know that they can select your app as the default post-purchase app in the Shopify admin checkout settings.
- Fulfillment holds: Shopify places a hold on fulfillment for all orders undergoing a post purchase cross-sell flow. Holds are released either when the customer visits the thank you page, or after a set amount of time, if the customer doesn't complete the post-purchase flow. If the customer doesn't complete the flow (for example, the customer closes the browser before actioning the post-purchase upsell offer), then the fulfillment hold is lifted one hour after submission of the initial checkout. Fulfillment holds are only supported using the FulfillmentOrder resource.
- Interaction with the thank you page. The post-purchase page shouldn't be used as a replacement for the thank you page. For more information, refer to the customer flow.
- API versioning. The post-purchase checkout extension APIs aren't versioned and don't follow the Shopify API versioning quarterly release schedule.
- Orders without a shipping address: If the customer's checkout results in the creation of an order without a shipping address, then you can't add a subscription to the order using post-purchase. For example, a customer might have bought only digital products, which doesn't require a shipping address. Similarly, a customer might choose local pickup as their delivery method, which also doesn't require a shipping address. You can determine in advance whether a shipping address exists by viewing the payment step within the
ShouldRenderextension point. If the
destinationCountryCodeinput field is
null, then no shipping address is set.
- Orders for local delivery: Post-purchase upsell offers won’t be surfaced on orders for local delivery.
- Accepted offers: A customer can accept a maximum of two post-purchase offers for each checkout.
- Number of post-purchase pages: You can create only one post-purchase page. However, because a post-purchase extension is a single-page app, you can paginate the single page to create multiple pages.
- Get started building a post-purchase checkout extension.