BigCommerce · Schema

CustomTemplateAssociation

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id integer
channel_id integer
entity_type string
entity_id integer
file_name string
is_valid boolean An invalid file name does not match with an existing custom layout file in the currently active theme for the channel. When an association is invalid the store will fallback to using the default for t
date_created string
date_modified string
View JSON Schema on GitHub

JSON Schema

bigcommerce-customtemplateassociation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomTemplateAssociation",
  "title": "CustomTemplateAssociation",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "channel_id": {
      "type": "integer"
    },
    "entity_type": {
      "type": "string",
      "enum": [
        "product",
        "category",
        "brand",
        "page"
      ]
    },
    "entity_id": {
      "type": "integer"
    },
    "file_name": {
      "type": "string",
      "example": "custom-product-1.html"
    },
    "is_valid": {
      "type": "boolean",
      "description": "An invalid file name does not match with an existing custom layout file in the currently active theme for the channel. When an association is invalid the store will fallback to using the default for that entity type."
    },
    "date_created": {
      "type": "string"
    },
    "date_modified": {
      "type": "string"
    }
  },
  "x-internal": false
}