PrintNowPrintNowDocs

Checkout Fields

Create custom field groups and fields that appear during checkout to collect additional information from customers.

The Checkout Fields page lets you define custom form fields that appear on the checkout page to collect additional information from customers. Fields are organized into groups, and each group can be assigned to specific user groups so that only certain customers see those fields. For example, you might create a "Delivery Instructions" group with fields for delivery date, special handling notes, and a department dropdown -- then assign it to your wholesale customer group.

Checkout fields support three input types: text, dropdown, and date picker. Each field can be marked as required with a custom validation message. When a customer completes checkout, the field values are saved with the order and visible in order details.

View Checkout Field Groups

  1. From your Unified Admin, go to Settings > Checkout Settings > Checkout Fields.
  2. The page displays all checkout field groups for the current storefront in a master-detail AG Grid table.
  3. Click the expand arrow next to any group name to reveal its individual fields in an inline detail grid.
  4. To add a new field group, click the Add Checkout Field button.
  5. To edit a field group, click Edit in the Action column.
  6. To delete a field group, click Delete in the Action column. This also deletes all fields within the group.

Field Group Columns

ColumnDescription
NameThe internal identifier for this field group. Click the expand arrow to view the fields within this group. Used when assigning the group to a user group.
TitleThe heading displayed to customers on the checkout page above this group of fields.
ActionEdit or Delete the field group.

Add/Edit Field Group

Click Add Checkout Field or Edit on an existing group to open the field group dialog.

FieldDescription
NameThe internal name for this field group. Used to identify the group when assigning it to user groups. Required.
TitleThe heading displayed to customers above this group of fields on the checkout page. Required.

View/Edit Fields

Expand a field group row to reveal the detail grid showing all fields within that group.

  1. Click the expand arrow next to a field group name to open the detail panel.
  2. The detail grid shows all fields in the group, ordered by display order.
  3. To add a new field, click the Add button in the detail panel.
  4. To edit a field, click Edit in the Action column.
  5. To delete a field, click Delete in the Action column.

Field List Columns

ColumnDescription
NameThe label displayed next to this field on the checkout page.
TypeThe input type: Text, Dropdown, or Date.
RequiredWhether the customer must fill in this field to complete checkout.
Display OrderThe position of this field within its group. Lower numbers appear first.
ActionEdit or Delete the field.

Add/Edit Field

Click Add or Edit on an existing field to open the field dialog.

FieldDescription
NameThe label displayed to customers next to the field on the checkout page. Required.
TypeThe input control type:
Text -- a standard text input box.
Dropdown -- a dropdown selection list. Define the choices in the Options field.
Date -- a date picker input.
Display OrderControls the position of this field within its group. Fields are sorted by display order, then by ID. Required.
OptionsFor Dropdown fields, enter the selectable choices separated by semicolons (e.g., Option A;Option B;Option C). Not used for Text or Date fields.
RequiredWhen checked, the customer must fill in this field to proceed with checkout. If left blank, the validation message is displayed.
Validation MessageThe error message shown to customers when a required field is left blank (e.g., "Please enter a delivery date").

Associations

AreaEffect
Checkout PageCustom fields appear on the checkout page under their group title. On single-page checkout, fields are loaded via the checkout API and rendered dynamically. On traditional checkout, fields are rendered as ASP.NET controls in a Bootstrap grid layout (col-md-3 columns).
User GroupsField groups are assigned to user groups via the User Group settings. Only customers belonging to a user group with an assigned field group see those fields at checkout. If a customer has no user group assignment, the system falls back to the default "Retail" group.
OrdersWhen a customer completes checkout, field values are saved to the OrderMetaField table linked to the order. The field name and entered value are stored and visible in order details.
Store CloneCheckout field configurations are included when cloning a storefront to a new instance.
Activity LogAll field group and field create, update, and delete actions are recorded in the Activity Log.
  • Orders — view custom field values submitted with each order
  • Users — assign field groups to user groups to target specific customers
  • Checkout Styles — style the checkout page where custom fields appear
  • Activity Log — field group and field changes are recorded for auditing

On this page