Skip to main content

Interface: CartCustomField

Definition of a custom field in the cart submission form.

This interface represents a form field that appears during the checkout process for collecting customer information. Fields can be standard system fields or custom fields defined specifically for this customer's checkout process.

Each field has a specific type (text, number, checkbox, etc.), validation rules, and display properties that determine how it appears and functions in the checkout form.

Properties​

description?​

optional description: string

Additional explanatory text for this field.

Optional help text that provides more detailed information about what this field is for or how it should be filled out. This can appear as tooltips, placeholders, or secondary text below the field.

name​

name: string

Display label for this field.

The human-readable text that appears next to this field in the form to explain what information should be entered. Clear, concise labels improve form usability and completion rates.

ordinal​

ordinal: number

Display order position in the form.

A numeric value that determines where this field appears in the form relative to other fields. Lower numbers appear earlier in the form, allowing precise control over the form's visual structure and logical flow.

parameterKey​

parameterKey: string

Unique identifier for this field.

The key that uniquely identifies this field in the system and will be used to store and retrieve its value. This should be a stable identifier that doesn't change over time.

source​

source: "CUSTOM" | "SYSTEM"

Origin of this field definition.

Indicates whether this field is a standard field provided by the system or a custom field created specifically for this customer's checkout process.

  • 'SYSTEM': Standard fields like name, email, phone
  • 'CUSTOM': Customer-specific fields like project references, department codes

type​

type: CustomFieldType

The data type of this field.

Determines what kind of data this field collects and what UI component should be used to collect it. Different field types have different capabilities, validation rules, and UI representations.

typeConfig?​

optional typeConfig: object

Type-specific configuration options.

Additional settings that customize the behavior and appearance of the field based on its specific type. Different field types have different available configuration options.

checkboxContent?​

optional checkboxContent: object

Settings specific to checkbox fields.

For fields of type "checkbox", this provides the content and labels for the checked and unchecked states, as well as any explanatory text that accompanies the checkbox.

checkboxContent.checkedLabel​

checkboxContent.checkedLabel: string

Text label for when the checkbox is checked.

The text to display in summaries or confirmations when this checkbox field has been selected (e.g., "Yes", "Agreed", "Included").

checkboxContent.content​

checkboxContent.content: string

Explanatory text associated with the checkbox.

The content that explains what the checkbox represents, such as terms and conditions text, privacy policy, or special instructions. This may be displayed next to the checkbox or in a popup/tooltip.

checkboxContent.showInFooter?​

optional checkboxContent.showInFooter: boolean

Whether to display checkbox content in email footers.

When true, the checkbox content (often legal text or terms) is included in the footer of confirmation emails. This is commonly used for terms and conditions or privacy policy acceptance.

checkboxContent.uncheckedLabel​

checkboxContent.uncheckedLabel: string

Text label for when the checkbox is unchecked.

The text to display in summaries or confirmations when this checkbox field has not been selected (e.g., "No", "Declined", "Not included").

selectOptions?​

optional selectOptions: object[]

Available options for dropdown fields.

For fields of type "dropdown" or "select", this defines the list of possible choices that can be selected, each with a display name and value.

validationConfig​

validationConfig: CustomFieldValidationConfig

Validation requirements for this field.

Defines constraints on what constitutes valid input for this field, including whether the field is required and any specific format or content requirements.