options.vm

Owned by Perry Tew
Last updated: Aug 11, 2015
1 min read

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.

$form variables for template options.vm

Name

Type

Formal Syntax

Form Data?

Required on Post?

Comments/Sample Usage

advertisingSource

string

$form.advertisingSource

 

 

 

advertisingSourceOther

string

$form.advertisingSourceOther

 

 

 

advertisingSources

string[ ]

$form.advertisingSources

 

 

 

customerProfileCreditCardOid

string

$form.customerProfileCreditCardOid

 

 

 

errors

Error[ ]

$form.errors

 

 

 

giftCertificateCode

string

$form.giftCertificateCode

 

 

 

infoMessages

string[ ]

$form.infoMessages

 

 

 

merchantId

string

$form.merchantId

 

 

 

noMethods

string

$form.noMethods

 

 

 

paymentPreference

string

$form.paymentPreference

 

 

 

paymentPreferences

PaymentPreference[ ] (see below)

$form.paymentPreferences

 

 

 

referralCode

string

$form.referralCode

 

 

 

referralCodeDescription

string

$form.referralCodeDescription

 

 

 

shipping3rdPartyAccountNumber

string

$form.shipping3rdPartyAccountNumber

 

 

 

shippingMethod

string

$form.shippingMethod

 

 

 

shippingMethods

ShippingMethod[ ] (see below)

$form.shippingMethods

 

 

 

show3rdPartyJavascript

string

$form.show3rdPartyJavascript

 

 

 

showLiftGateJavascript

string

$form.showLiftGateJavascript

 

 

 

specialInstructions

string

$form.specialInstructions

 

 

 

specialInstructionsLength

string

$form.specialInstructionsLength

 

 

 

taxCounties

string[ ]

$form.taxCounties

 

 

 

taxCounty

string

$form.taxCounty

 

 

 

 

Template Specific Value Objects

 

Payment Preference

Field

Type

Comment/Sample

customerProfileCreditCardOid

string

 

existingCardImage

string

 

existingCardText

string

 

html

string

 

name

string

 

value

string

 

 

ShippingMethod

Field

Type

Comment/Sample

allow3rdPartyBilling

boolean

 

comment

string

 

cost

string

 

costBigDecimal

BigDecimal

 

discounted

boolean

 

displayName

string

 

estimatedDelivery

string

 

lifeGateOption

boolean

 

name

string

 

 

Flow