For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • Overview
  • Learning Plans
    • Developer Foundations
    • Composable Developer
    • Stencil Developer
    • B2B Developer
  • Courses
        • Course Overview and Prerequisites
        • Widgets API
        • Lab - Getting Started
    • Learning Changelog
Dev Portal
LogoLogo
On this page
  • What Can You Do with Widgets API?
  • Use Case
  • Advancing API-first with BigCommerce Widgets
CoursesWidgets - REST APIModule 1: Overview

Widgets API

Was this page helpful?
Previous

Course Overview and Prerequisites

Next

Lab - Getting Started

Built with

Plan: Stencil Developer

 Lesson 2 of 22 · 15 min

What is the Widgets API?

The Widgets API allows developers to create units of content and programmatically place them on specific pages of a BigCommerce storefront. The content can consist of HTML, CSS, and JavaScript, and is configurable using Handlebars variables. The Widgets API supports various content types, such as YouTube videos, image sliders, and chat apps.

What Can You Do with Widgets API?

What can you do with the Widgets API?

The Widgets API allows developers to programmatically inject custom content via HTML, JS, and CSS into Stencil templates, enabling them to build apps that enhance ecommerce experiences on BigCommerce storefronts.

  • Inject modular, reusable blocks of content inside new and existing store pages
  • Build tools that allow non-technical users to control content without editing theme files
  • Target specific products, categories, or brands with the widgets
  • Create sophisticated page builder applications and merchandising functionality

The Widgets API lays the groundwork for future tools that will give merchants more control over their storefronts than ever before, without editing code, even opening the door to creating new workflows to manage and publish content in BigCommerce stores.

As a developer, the Widgets API opens the door to building all kinds of creative and exciting solutions for BigCommerce merchants.

Use Case

In the Developer Blog article linked below, learn how the Widgets API is a foundational step towards providing native visual content merchandising capabilities in BigCommerce.

Advancing API-first with BigCommerce Widgets

When bringing a product to market, you have a decision to make. You can build and launch the product, get it into the hands of your users, and then later surface an API to allow the ecosystem to extend it. Or, you can take the API-first approach.

Blog Article