BigCommerce · Schema

StorefrontProductSettings

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name Type Description
show_product_price boolean Determines the visibility of the product price.
show_product_sku boolean Determines the visibility of the product SKU.
show_product_weight boolean Determines the visibility of the productʼs weight.
show_product_brand boolean Determines the visibility of the productʼs brand.
show_product_shipping boolean Determines the visibility of the productʼs shipping option.
show_product_rating boolean Determines the visibility of the productʼs rating.
show_add_to_cart_link boolean Determines the visibility of the Add to Cart link.
default_preorder_message string The productʼs pre-order message. If undefined, the message defaults to the storewide setting.
show_breadcrumbs_product_pages string
show_add_to_cart_qty_box boolean Determines the visibility of the Add to Cart quantity setting.
show_add_to_wishlist boolean Determines the visibility of the Add to Wishlist setting.
hide_price_from_guests boolean Determines the visibility of the price.
View JSON Schema on GitHub

JSON Schema

bigcommerce-storefrontproductsettings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StorefrontProductSettings",
  "title": "StorefrontProductSettings",
  "type": "object",
  "properties": {
    "show_product_price": {
      "type": "boolean",
      "description": "Determines the visibility of the product price.\n",
      "example": true
    },
    "show_product_sku": {
      "type": "boolean",
      "description": "Determines the visibility of the product SKU.\n",
      "example": true
    },
    "show_product_weight": {
      "type": "boolean",
      "description": "Determines the visibility of the product\u02bcs weight.\n",
      "example": false
    },
    "show_product_brand": {
      "type": "boolean",
      "description": "Determines the visibility of the product\u02bcs brand.\n",
      "example": true
    },
    "show_product_shipping": {
      "type": "boolean",
      "description": "Determines the visibility of the product\u02bcs shipping option.\n",
      "example": false
    },
    "show_product_rating": {
      "type": "boolean",
      "description": "Determines the visibility of the product\u02bcs rating.\n",
      "example": true
    },
    "show_add_to_cart_link": {
      "type": "boolean",
      "description": "Determines the visibility of the Add to Cart link.\n",
      "example": true
    },
    "default_preorder_message": {
      "type": "string",
      "description": "The product\u02bcs pre-order message. If undefined, the message defaults to the storewide setting.\n",
      "example": "Preorder message"
    },
    "show_breadcrumbs_product_pages": {
      "type": "string",
      "enum": [
        "show_one",
        "show_none"
      ],
      "example": "show_one"
    },
    "show_add_to_cart_qty_box": {
      "type": "boolean",
      "description": "Determines the visibility of the Add to Cart quantity setting.\n",
      "example": true
    },
    "show_add_to_wishlist": {
      "type": "boolean",
      "description": "Determines the visibility of the Add to Wishlist setting.\n",
      "example": true
    },
    "hide_price_from_guests": {
      "type": "boolean",
      "description": "Determines the visibility of the price.\n",
      "example": false
    }
  },
  "x-tags": [
    "Models"
  ]
}