How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BigCommerce

BigCommerce Widget API

The Widget API from BigCommerce — 2 operation(s) for widget.

Documentation Provider Profile APIs.io OpenAPI GitHub

BigCommerce Widget API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Widget. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Contact
BigCommerce
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

BigCommerce Widget API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Widget 5
POST
/content/widgets
BigCommerce Create a Widget
createWidget 2 params body → 200422
GET
/content/widgets
BigCommerce Get All Widgets
getWidgets 9 params → 200422
GET
/content/widgets/{uuid}
BigCommerce Get a Widget
getWidget 2 params → 200404422
PUT
/content/widgets/{uuid}
BigCommerce Update a Widget
updateWidget 3 params body → 200404422
DELETE
/content/widgets/{uuid}
BigCommerce Delete a Widget
deleteWidget 2 params → 204404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are widgetSchemaArray (7 properties), pagination (6 properties), error_Base (5 properties), widget_Post (5 properties). Each schema is shown below with its type and property counts.

metaCollection
object
Data about the response, including pagination and collection totals.
1 property
widget_Post
object
5 properties 2 required
widgetSchema
array
The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-re…
Meta
object
Response metadata.
widget_Full
widgetSchemaHidden
object
Hidden. Use the hidden settings type to create controls that have no user interface drawn in Page Builder. Hidden settings are not grouped into any other tabs…
2 properties
widget_Base
object
3 properties
widgetSchemaArray
object
Array. Use the array settings type to build collections of elements within the widget. Each element in the array can contain tabs, sections, and an entire sche…
7 properties
widgetTemplate_Base
object
4 properties
widgetTemplate_Full
widgetSchemaTab
object
Tab. Use the tab settings type to create settings visible in Page Builder.
3 properties
pagination
object
Data about the response, including pagination and collection totals.
6 properties
error_Base
object
Error payload for the BigCommerce API.
5 properties
widget_Put

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-widget-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
AE Profile APIs.io
Big Commerce Locations
AE Profile APIs.io
Big Commerce Customer Segmentation
AE Profile APIs.io
Big Commerce Promotions
AE Profile APIs.io
Big Commerce Promotion Settings
AE Profile APIs.io
Big Commerce Pickup Methods
AE Profile APIs.io
Big Commerce Storefront Pickup Options
AE Profile APIs.io
Big Commerce Transactions
AE Profile APIs.io
BigCommerce Abandoned Cart Emails API
AE Profile APIs.io
BigCommerce Abandoned Cart Settings API
AE Profile APIs.io
BigCommerce Abandoned Carts API
AE Profile APIs.io
BigCommerce Abandoned Carts Settings API
AE Profile APIs.io
#Widget
← Back to B APIs
API Details
ID
bigcommerce:bigcommerce-widget-api
Base URL
https://api.example.com
Docs
https://developer.bigcommerce.com/
Provider
BigCommerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bigcommerce-widget-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bigcommerce-widget-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BigCommerce Widget API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.