FormFieldGroups

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-form-field-groups-schema.json",
  "title": "FormFieldGroups",
  "description": "Group of form field groups",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-form-fields-api-openapi.yml#/components/schemas/FormFieldGroups",
  "type": "object",
  "x-internal": false,
  "properties": {
    "customerAccount": {
      "$ref": "#/$defs/FormFields"
    },
    "shippingAddress": {
      "$ref": "#/$defs/FormFields"
    },
    "billingAddress": {
      "$ref": "#/$defs/FormFields"
    }
  },
  "$defs": {
    "FormField": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Field unique ID"
        },
        "name": {
          "type": "string",
          "description": "Field name"
        },
        "custom": {
          "type": "boolean",
          "description": "Whether this is a custom field or system built-in field."
        },
        "label": {
          "type": "string",
          "description": "User-friendly label"
        },
        "required": {
          "type": "boolean",
          "description": "Whether this field is required or not"
        },
        "default": {
          "type": "string",
          "description": "The field unique ID"
        },
        "type": {
          "type": "string",
          "description": "Type of the value hold by the field",
          "enum": [
            "integer",
            "string",
            "array",
            "date"
          ]
        },
        "fieldType": {
          "type": "string",
          "description": "Type of the field",
          "enum": [
            "checkbox",
            "text",
            "date",
            "multiline",
            "radio",
            "dropdown"
          ]
        },
        "min": {
          "type": "string",
          "description": "The minimun valid value for the field (integer and date type only)"
        },
        "max": {
          "type": "string",
          "description": "The minimun valid value for the field (integer and date type only)"
        },
        "maxLength": {
          "type": "integer",
          "description": "The maximum length for the value (string type only)"
        },
        "secret": {
          "type": "boolean",
          "description": "Whether the field represents a password field"
        },
        "options": {
          "type": "object",
          "properties": {
            "helperLabel": {
              "type": "string",
              "description": "Placeholder text for dropdown field type."
            },
            "items": {
              "type": "array",
              "description": "List of possible values for this field.",
              "items": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "description": "Extra data for radio, dropdown and checkbox field types."
        }
      },
      "description": "Form Field",
      "x-internal": false
    },
    "FormFields": {
      "type": "array",
      "description": "List of form fields for the group",
      "items": {
        "$ref": "#/$defs/FormField"
      },
      "x-internal": false
    }
  }
}