ChannelAbandonedCartSettingsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-channel-abandoned-cart-settings-request-schema.json",
  "title": "ChannelAbandonedCartSettingsRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-abandoned-carts-settings-api-openapi.yml#/components/schemas/ChannelAbandonedCartSettingsRequest",
  "allOf": [
    {
      "$ref": "#/$defs/ChannelAbandonedCartSettings"
    },
    {
      "description": "The request object for updating the abandoned cart settings overrides of a store for a channel"
    }
  ],
  "x-tags": [
    "Models"
  ],
  "$defs": {
    "ChannelAbandonedCartSettings": {
      "description": "Represents all settings overrides related to the abandoned cart functionality of a store for a channel",
      "type": "object",
      "x-tags": [
        "Models"
      ],
      "properties": {
        "enable_notification": {
          "description": "Indicates whether or not abandoned cart notification is on. If it is null, it means there is no override for the specified channel.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "email_customer_until_cart_is_recovered": {
          "description": "Indicates whether or not a customer should continue to receive abandoned cart emails until their cart is recovered. If it is null, it means there is no override for the specified channel.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "marketing_emails_require_customer_consent": {
          "description": "Indicates whether or not a customer should receive abandoned cart emails based on their consent. If it is null, it means there is no override for the specified channel. By default customers will not receive emails.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "email_merchant_when_cart_is_converted": {
          "description": "Indicates whether or not a merchant should receive a notification email when a cart is converted into an order. If it is null, it means there is no override for the specified channel.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "email_merchant_when_cart_is_abandoned": {
          "description": "Indicates whether or not a merchant should receive a notification email when a cart is abandoned. If it is null, it means there is no override for the specified channel.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "merchant_email_address": {
          "description": "The email address for receiving merchant notifications. If it is null, it means there is no override for the specified channel.",
          "type": [
            "string",
            "null"
          ],
          "format": "email"
        },
        "merchant_abandoned_cart_email_frequency_type": {
          "description": "Indicates whether to send an email for every abandoned cart or to send a digest email after X number of abandoned carts. If it is null, it means there is no override for the specified channel.",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "digest",
            "individual"
          ]
        },
        "merchant_abandoned_cart_digest_email_frequency": {
          "description": "The number of abandoned carts to accumulate before a digest email is sent to a merchant. If it is null, it means there is no override for the specified channel.",
          "type": [
            "integer",
            "null"
          ],
          "minimum": 2,
          "maximum": 1000
        }
      }
    }
  }
}