Embedded Checkout Overview

Embedded Checkout lets you place BigCommerce’s checkout onto any website. Customers can check out on an external storefront while their order information syncs simultaneously to the BigCommerce Control Panel. 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. View more information about the plugin in the article BigCommerce for Wordpress.

How it Works

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, 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.

Channels, Sites and Routes APIs

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 site and routes are used to link back to the proper URL from invoice emails and storefront links.

BigCommerce Checkout SDK

Embedded Checkout requires the BigCommerce Checkout SDK to invoke a method that can render the checkout in your site. Learn more about the Checkout SDK.

Logged-In Customers

Customers are handled 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. This is done through the Customer Login API.