BigCommerce · Schema

widgetSchemaSetting_Base

For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name Type Description
type string The type of setting component to display. You can view the list of elements below to discover which are available to use. For examples of each type of setting, see [Page Builder > Schema Settings](/do
label string The user friendly message to inform the user how this setting will be used.
id string The variable name where the setting value will be available in the widget template.
default string The default value to use when rendering the widget for the first time. Make sure to set sensible defaults to make your widget easier to use.
typeMeta object Additional information needed based on the selected setting type.
conditional object
View JSON Schema on GitHub

JSON Schema

bigcommerce-widgetschemasetting-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/widgetSchemaSetting_Base",
  "title": "widgetSchemaSetting_Base",
  "type": "object",
  "description": "For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of setting component to display. You can view the list of elements below to discover which are available to use.\n\nFor examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.",
      "enum": [
        "alignment",
        "boolean",
        "boxModel",
        "code",
        "color",
        "imageManager",
        "input",
        "number",
        "productId",
        "productImage",
        "range",
        "regexInput",
        "select",
        "text",
        "toggle"
      ]
    },
    "label": {
      "type": "string",
      "description": "The user friendly message to inform the user how this setting will be used."
    },
    "id": {
      "type": "string",
      "description": "The variable name where the setting value will be available in the widget template."
    },
    "default": {
      "type": "string",
      "description": "The default value to use when rendering the widget for the first time. Make sure to set sensible defaults to make your widget easier to use."
    },
    "typeMeta": {
      "type": "object",
      "description": "Additional information needed based on the selected setting type.",
      "properties": {
        "selectOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string",
                "example": "Image"
              },
              "value": {
                "type": "string",
                "example": "image"
              }
            }
          }
        }
      }
    },
    "conditional": {
      "$ref": "#/components/schemas/widgetSchemaConditional"
    }
  },
  "x-internal": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bigcommerce-widgetschemasetting-base"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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