BigCommerce · Schema

placement_Post

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
View JSON Schema on GitHub

JSON Schema

bigcommerce-placement-post-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/placement_Post",
  "title": "placement_Post",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "widget_uuid": {
          "type": "string",
          "description": "A widget identifier."
        },
        "template_file": {
          "type": "string",
          "description": "The template file that you would like to target."
        },
        "channel_id": {
          "type": "integer",
          "description": "The id of the channel on which to create this placement. Defaults to the first channel created on the store.",
          "example": 1
        }
      },
      "required": [
        "widget_uuid",
        "template_file"
      ]
    },
    {
      "$ref": "#/components/schemas/placement_Base"
    }
  ],
  "x-internal": false
}