BigCommerce · Schema

widgetTemplate_Base

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
name	string	The user-friendly name.
schema	object
template	string	The widget template HTML. Supports Handlebars and Paper helpers.
storefront_api_query	string	The GraphQL Storefront API query that provides widget data.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/widgetTemplate_Base",
  "title": "widgetTemplate_Base",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The user-friendly name."
    },
    "schema": {
      "$ref": "#/components/schemas/widgetSchema"
    },
    "template": {
      "type": "string",
      "format": "html",
      "description": "The widget template HTML. Supports Handlebars and Paper helpers."
    },
    "storefront_api_query": {
      "type": "string",
      "description": "The GraphQL Storefront API query that provides widget data."
    }
  },
  "description": "",
  "x-internal": false
}