BigCommerce · Schema

PageBase

Common Page properties.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
name string The name of the page. Must be unique.
is_visible boolean Determines the visibility of the page in the storefront’s navigation menu. Boolean value that specifies the visibility of the page in the storefront’s navigation menu. Indicates whether the page is av
parent_id integer ID of any parent Web page.
sort_order integer Determines the order in which the page is displayed on the storefront. (Lower integers specify earlier display.)
type string Determines the type of the page. |Value|Description| |-|-| | `blog` | blog page. Read-only; blog pages can only be created in the store control panel. | |`contact_form`|hosts the store's contact form|
is_homepage boolean Determines whether this page is the storefront’s home page.
is_customers_only boolean If `true`, this page will only be visible to customers that are logged in to the store.
View JSON Schema on GitHub

JSON Schema

bigcommerce-pagebase-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageBase",
  "title": "PageBase",
  "type": "object",
  "description": "Common Page properties.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the page. Must be unique.\n",
      "minLength": 1,
      "maxLength": 100,
      "example": "My Store Page"
    },
    "is_visible": {
      "type": "boolean",
      "description": "Determines the visibility of the page in the storefront\u2019s navigation menu.\n\nBoolean value that specifies the visibility of the page in the storefront\u2019s navigation menu.\n          \nIndicates whether the page is available to users and visible in any menus.\n"
    },
    "parent_id": {
      "type": "integer",
      "description": "ID of any parent Web page.\n",
      "example": 0,
      "default": 0
    },
    "sort_order": {
      "type": "integer",
      "description": "Determines the order in which the page is displayed on the storefront. (Lower integers specify earlier display.)\n",
      "example": 0,
      "default": 0
    },
    "type": {
      "type": "string",
      "description": "Determines the type of the page.\n\n|Value|Description|\n|-|-|\n| `blog` | blog page. Read-only; blog pages can only be created in the store control panel. |\n|`contact_form`|hosts the store's contact form|\n|`link`|link to another absolute URL|\n|`page`|user-defined plain-text page|\n|`raw`|page that contains markup, such as HTML.|\n|`rss_feed`|contains syndicated content from an RSS feed|",
      "example": "page",
      "enum": [
        "page",
        "raw",
        "contact_form",
        "feed",
        "link",
        "blog"
      ]
    },
    "is_homepage": {
      "type": "boolean",
      "description": "Determines whether this page is the storefront\u2019s home page.\n"
    },
    "is_customers_only": {
      "type": "boolean",
      "description": "If `true`, this page will only be visible to customers that are logged in to the store.\n"
    }
  },
  "required": [
    "name",
    "type"
  ]
}