Skip to end of metadata
Go to start of metadata
In addition to other standard variables like $cart
, StoreFront system screens (display and post form data, such as checkout screens) have a $form
variable that contains fields and data specific to that screen.
Listed below are the form fields specific to this screen template.
Name | Type | Formal Syntax | Form Data? | Required on Post? | Comments/Sample Usage |
---|
clickWrapAgreement
| string
| $form.clickWrapAgreement
| | | |
customerService
| CustomerService
| $form.customerService
| | | |
digitalDownloads
| DigitalDownload[]
| $form.digitalDownloads
| | | |
digitalOrderUrlId
| string
| $form.digitalOrderUrlId
| | | |
downloadServerHostName
| string
| $form.downloadServerHostName
| | | |
emailRecipient
| string
| $form.emailRecipient
| | | |
errors
| Error[]
| $form.errors
| | | |
expirationDate
| string
| $form.expirationDate
| | | |
expirationDateRaw | Timestamp | $form.getExpirationDateRaw()
note: requires this exact syntax |
|
| useful to re-format the expiration date into a different format or timezone.
see https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html for formatting examples.
$formatHelper.formatDate($form.getExpirationDateRaw(), "dd.MM.yyyy", "GMT")
|
infoMessages
| string[]
| $form.infoMessages
| | | |
orderId
| string
| $form.orderId
| | | |
screenBrandingThemeOid
| integer
| $form.screenBrandingThemeOid
| | | |
Flow