Checkout SDK

The Checkout JS SDK is a wrapper for the BigCommerce Storefront Checkout API.

It allows a developer to create a custom checkout experience to move a customer through the checkout process. The SDK handles all the ‘heavy-lifting’ such as customer login, getting shipping quotes and submitting payment for an order. With the Checkout JS SDK, you can build a custom checkout presentation layer in popular frontend frameworks such as React.

What Can I Do with the SDK?

  • It can initialize payment and shipping providers that require client-side setup through a common interface. Below are some examples of these providers:

    • PayPal Express
    • Braintree
    • Stripe
    • Square
    • Amazon
    • Klarna
  • It provides a JavaScript interface for interacting with the web API.

    • Fetch and submit resources:
      • Cart
      • Order
      • Customer
    • Fetch available options:
      • Shipping addresses
      • Shipping countries
      • Shipping states
      • Billing addresses
      • Billing countries
      • Billing states
      • Shipping methods
      • Payment methods

The Checkout JS SDK allows you to present the checkout process to the shopper in any way you like, and, through frontend technologies and external web services, augment the checkout with extra information.

However, the Checkout JS SDK does not allow you to change the underpinnings of the checkout - you must still conform to the model of the Checkout API underpinning the SDK to complete a Checkout and create an Order in BigCommerce. The SDK does not allow you to implement custom payment, shipping, or tax calculation providers into the checkout - instead, the configured providers for these services on a given store are expressed via our Checkout API.

Where Can I Get the SDK?

The Checkout JS SDK and associated documentation is available from the BigCommerce SDK Repo.

Support and Customization

  • Enterprise clients can reach out to their account manager to review services and resources available.
  • For more on our design policy please visit Design Support.