Build a custom checkout on BigCommerce using the Checkout SDK

domain: developer.bigcommerce.com · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Install the Checkout SDK: npm install @bigcommerce/checkout-sdk, or reference the script-based distribution from the BigCommerce CDN for browser environments
  2. Initialize the SDK with createCheckoutService() and call checkoutService.loadCheckout(checkoutId) where checkoutId comes from the storefront cart cookie or the Cart REST API response
  3. Call checkoutService.loadShippingOptions() to fetch available shipping methods; call checkoutService.selectShippingOption({ shippingOptionId }) to select one
  4. Collect billing/shipping addresses with checkoutService.updateBillingAddress(address) and checkoutService.updateShippingAddress(address); both accept an address object with firstName, lastName, address1, city, stateOrProvinceCode, postalCode, countryCode
  5. Initialize a payment method with checkoutService.initializePayment({ methodId: 'METHOD_ID' }) and submit with checkoutService.submitOrder({ payment: { methodId, paymentData } })
  6. Handle checkout state changes by subscribing to checkoutService.subscribe(state => ...) which fires on every state mutation

Known gotchas

Related routes

Implement BigCommerce Embedded Checkout in a headless storefront using the Checkout SDK embedCheckout method
developer.bigcommerce.com · 6 steps · unrated
Complete a BigCommerce headless checkout via the Checkout API
bigcommerce.com · 5 steps · unrated
Configure BigCommerce Embedded Checkout with a custom storefront and pass customer login state securely using customer impersonation tokens
developer.bigcommerce.com · 6 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans