BigCommerce · Schema

CustomerSettingsObject

Customer Settings.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
privacy_settings	object	Controls the privacy settings.
customer_group_settings	object	The settings for a collection of customers.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerSettingsObject",
  "title": "CustomerSettingsObject",
  "type": "object",
  "description": "Customer Settings.",
  "properties": {
    "privacy_settings": {
      "type": "object",
      "description": "Controls the privacy settings.",
      "properties": {
        "ask_shopper_for_tracking_consent": {
          "type": "boolean",
          "description": "Determines if a customer requires consent for tracking privacy."
        },
        "policy_url": {
          "type": "string",
          "example": "https://bigcommmerce.com/policy",
          "description": "The URL for a website\u02bcs privacy policy."
        }
      }
    },
    "customer_group_settings": {
      "type": "object",
      "description": "The settings for a collection of customers.",
      "properties": {
        "guest_customer_group_id": {
          "type": "integer",
          "example": 0,
          "description": "The ID for a guest customer group."
        },
        "default_customer_group_id": {
          "type": "integer",
          "example": 0,
          "description": "The ID for a default customer group."
        }
      }
    }
  },
  "x-examples": {
    "example-1": {
      "value": {
        "privacy_settings": {
          "ask_shopper_for_tracking_consent": true,
          "policy_url": "https://bigcommmerce.com/policy"
        },
        "customer_group_settings": {
          "guest_customer_group_id": 0,
          "default_customer_group_id": 0
        }
      }
    }
  },
  "x-internal": false
}