Interface: SubmissionDataParameters
Parameter in a basket submission with its metadata.
This interface defines the structure of a custom field value in a submission, including both the value itself and metadata about the field's definition. This comprehensive structure ensures that field values can be properly validated, displayed, and processed according to their specific requirements.
Properties
key
key:
string
Unique identifier for this field.
The key that uniquely identifies this field in the system. This is used for referencing the field in code and mapping values to their definitions.
parameter
parameter:
object
Complete field definition and metadata.
Contains comprehensive information about the field itself, including its type, display name, validation rules, and configuration options. This metadata is essential for correctly processing and displaying the field value.
name
name:
string
Display name of the field.
The human-readable label shown to users when presenting this field in forms or displaying its value in summaries.
source
source:
string
Origin of this field definition.
Indicates whether this field is defined by the system (standard fields) or created by the customer (custom fields). This may affect behavior and display logic.
type
type:
string
The data type of this field.
Indicates what kind of input this field accepts, such as text, number, checkbox, or dropdown. This determines how the value is validated and what UI components are used to collect it.
typeConfig?
optionaltypeConfig: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 configuration options available.
typeConfig.checkboxContent?
optionaltypeConfig.checkboxContent:object
Settings specific to checkbox fields.
For fields of type "checkbox", this provides labels for the checked and unchecked states, which can be used in summaries and confirmations.
typeConfig.checkboxContent.checkedLabel
typeConfig.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").
typeConfig.checkboxContent.uncheckedLabel
typeConfig.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").
typeConfig.selectOptions?
optionaltypeConfig.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:
object
Validation requirements for this field.
Rules that determine what constitutes a valid value for this field, including whether the field is required and any specific format or content constraints.
validationConfig.isRequired
validationConfig.isRequired:
boolean
Whether a value must be provided for this field.
When true, the field cannot be left empty during submission.
Required fields are typically marked with an asterisk (*) in forms.
value
value:
any
The value provided for this field.
The actual data entered by the user or selected from options. The type varies based on the field type (string, boolean, number, etc.).