BigCommerce · Schema

complexRuleConditionBase

Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple `modifier_value_id`’s, or else reference a `modifier_value_id` and a `variant_id`.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	The unique numeric ID of the rule condition; increments sequentially. Read-Only
rule_id	integer	The unique numeric ID of the rule with which the condition is associated. Read-Only
modifier_id	integer	The unique numeric ID of the modifier with which the rule condition is associated. Required in /POST.
modifier_value_id	integer	The unique numeric ID of the modifier value with which the rule condition is associated. Required in /POST.
variant_id	integer	The unique numeric ID of the variant with which the rule condition is associated. Required in /POST.
combination_id	integer	(READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/complexRuleConditionBase",
  "title": "complexRuleConditionBase",
  "required": [
    "modifier_id",
    "modifier_value_id",
    "variant_id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique numeric ID of the rule condition; increments sequentially. Read-Only\n",
      "nullable": true,
      "example": 3
    },
    "rule_id": {
      "type": "integer",
      "description": "The unique numeric ID of the rule with which the condition is associated.\nRead-Only",
      "nullable": true,
      "example": 4
    },
    "modifier_id": {
      "type": "integer",
      "description": "The unique numeric ID of the modifier with which the rule condition is associated.\nRequired in /POST.",
      "nullable": true,
      "example": 55
    },
    "modifier_value_id": {
      "type": "integer",
      "description": "The unique numeric ID of the modifier value with which the rule condition is associated.\nRequired in /POST.",
      "nullable": true,
      "example": 256
    },
    "variant_id": {
      "type": "integer",
      "description": "The unique numeric ID of the variant with which the rule condition is associated.\nRequired in /POST.",
      "nullable": true,
      "example": 1
    },
    "combination_id": {
      "type": "integer",
      "description": "(READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.\n"
    }
  },
  "description": "Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple `modifier_value_id`\u2019s, or else reference a `modifier_value_id` and a `variant_id`.",
  "x-internal": false
}