Embedded Checkout Overview
The Checkout SDK's embedded-checkout sub-module (opens in a new tab) can be used to embed BigCommerce's Optimized One-Page Checkout (opens in a new tab) into non-native storefronts like WordPress. You can see this in action within the BigCommerce for WordPress plugin, which uses the same process described here as a checkout option for merchants. For more information about the plugin, see BigCommerce for WordPress.
Embedded Checkout uses an HTML
<iframe> to display BigCommerce's PCI-compliant Optimized One-Page Checkout on non-BigCommerce web pages.
If your channel site doesn't match the URL from which you're making a request to a BigCommerce store, you will get a security error and the checkout will not load. Additionally, if requests to your BigCommerce store aren't served over HTTPS, you will also see an error.
You will need to use the Channels, Sites, and Routes APIs to embed checkout on an external site. The Channels API allows you to create and manage sales channel listings across a merchant's product catalog. A channel can be a marketplace, like Amazon, or an external storefront, like a WordPress site. The Sites and Routes APIs let you set an external storefront domain and define the paths for important pages, like the home page, cart page, or checkout page. The Sites and Routes APIs allow you to link back to the proper URL from invoice emails and storefront links.
Embedded Checkout requires the BigCommerce Checkout SDK to invoke a method to render the checkout in your site. Learn more about the Checkout SDK.
Stencil translation files are not supported by Embedded Checkout. To display translated strings at checkout, we suggest Installing a Custom Checkout.
The Customer Login API allows you to manage customers in two steps. First, you need to pass the
customer_id when creating the cart. Second, you need to log in the customer, so the session is active when the checkout loads.
You are required to include the
channel_id in the login JWTs to embed checkout for headless storefronts. The default
channel_id value is
1. For more information, see the Embedded Checkout Overview.
For Embedded Checkout to work correctly for shoppers using a browser with restricted privacy settings (like Apple's Safari), your checkout page must be served from the same domain as your BigCommerce storefront. For example, if your headless storefront is
www.mystore.com, then your BigCommerce store's domain should be
checkout.mystore.com. For more information on making Embedded Checkout on a headless WordPress storefront compatible with Safari, see BigCommerce for WordPress (opens in a new tab) in the Help Center.