BigCommerce · Schema

placement_Base

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
entity_id	string	The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not support `entity_id`.
sort_order	integer	The sort order to control the position of a content widget in a region.
region	string	The name of the region in which to insert content widgets.
status	string	Sets the placement as either inactive or active.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/placement_Base",
  "title": "placement_Base",
  "type": "object",
  "properties": {
    "entity_id": {
      "type": "string",
      "description": "The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not support `entity_id`."
    },
    "sort_order": {
      "type": "integer",
      "description": "The sort order to control the position of a content widget in a region."
    },
    "region": {
      "type": "string",
      "description": "The name of the region in which to insert content widgets."
    },
    "status": {
      "type": "string",
      "enum": [
        "inactive",
        "active"
      ],
      "description": "Sets the placement as either inactive or active.",
      "default": "inactive"
    }
  },
  "x-internal": false
}