Custom fields: theme data reference

Account and checkout forms pass prepared customFieldGroups to partials/account_custom_fields.cfm. These are local partial inputs. The page reference identifies the corresponding model path.

Relative field	Type	Meaning / condition
customFieldGroups[].key	string	Group key.
customFieldGroups[].label	string	Group label.
customFieldGroups[].description	string	Group description.
customFieldGroups[].fields[]	object[]	Prepared fields in this group.
fields[].customFieldDefinitionId	number	Definition identifier.
fields[].setId	number	Field-set identifier.
fields[].setKey	string	Field-set key.
fields[].setLabel	string	Field-set label.
fields[].setDescription	string	Field-set description.
fields[].key	string	Field key.
fields[].label	string	Visible label.
fields[].description	string	Supporting text.
fields[].type	string	Control type, such as text, boolean, single_select, multi_select or media.
fields[].name	string	Prepared form field name; preserve it.
fields[].inputId	string	Prepared HTML control ID.
fields[].value	string	Prepared display value.
fields[].rawValue	string, number, boolean or array	Stored/submitted value; its shape depends on field type.
fields[].displayValue	string	Localized display value for the current form.
fields[].inputValue	string	Prepared input representation in checkout forms. Not supplied by every account form.
fields[].hasValue	boolean	Whether the prepared value is non-empty.
fields[].usesDefaultValue	boolean	Present in general entity fields; indicates a definition default.
fields[].isEditable	boolean	Whether the current form may edit the field.
fields[].isRequired	boolean	Whether an editable control is required.
fields[].isActive	boolean	Active definition.
fields[].storefrontVisible	boolean	Storefront visibility flag.
fields[].storefrontEditable	boolean	Storefront editing flag.
fields[].checkoutEditable	boolean	Checkout editing flag when supplied.
fields[].checkoutBillingEnabled	boolean	Included for billing-address use.
fields[].checkoutShippingEnabled	boolean	Included for shipping-address use.
fields[].connectorVisible	boolean	Connector visibility metadata; not a theme authorization decision.
fields[].importExportEnabled	boolean	Import/export metadata.
fields[].isSearchable	boolean	Search metadata.
fields[].isFilterable	boolean	Filter metadata.
fields[].flags	object	Grouped definition flags matching the corresponding top-level values.
fields[].options	object[]	Prepared choices for select fields.

The fields[] rows are relative to customFieldGroups[]. For example, the full partial-input path is customFieldGroups[].fields[].rawValue.

Order-detail address display groups are smaller: groups contain key, label and fields; each field contains key, label, type and displayValue. They are display records, not form controls.

Do not use stored flags to override the prepared isEditable decision or to recalculate checkout address roles.

Select options

Each customFieldGroups[].fields[].options[] entry has:

Relative field	Type	Meaning
options[].customFieldOptionId	number	Option identifier.
options[].customFieldDefinitionId	number	Owning field definition.
options[].key	string	Value submitted by the control.
options[].label	string	Localized option text.
options[].sortOrder	number	Prepared option order.
options[].isActive	boolean	Option activity flag.

fields[].flags contains the boolean keys isActive, isRequired, storefrontVisible, storefrontEditable, checkoutBillingEnabled, checkoutShippingEnabled, connectorVisible, importExportEnabled, isSearchable and isFilterable. Each mirrors the matching top-level definition flag.