single.vm

Owned by Perry Tew
Last updated: Apr 19, 2016 by Jonathan Tew
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 single.vm

Name

Type

Formal Syntax

Form Data?

Required on Post?

Comments/Sample Usage

above3rdPartyCheckout

string

$form.above3rdPartyCheckout

 

 

 

aboveCartHtml

string

$form.aboveCartHtml

 

 

 

aboveOuterTable

string

$form.aboveOuterTable

 

 

 

abovePaymentInformationHtml

string

$form.abovePaymentInformationHtml

 

 

 

aboveShippingBillingAddressHtml

string

$form.aboveShippingBillingAddressHtml

 

 

 

addXml

string

$form.addXml

 

 

 

advertisingSource

string

$form.advertisingSource

 

 

 

advertisingSourceOther

string

$form.advertisingSourceOther

 

 

 

advertisingSources

string[ ]

$form.advertisingSources

 

 

 

affiliateId

string

$form.affiliateId

 

 

 

amazonButtonUrl

string

$form.amazonButtonUrl

 

 

 

amazonCheckout

string

$form.amazonCheckout

 

 

 

amazonMerchantId

string

$form.amazonMerchantId

 

 

 

amazonOrderReferenceId

string

$form.amazonOrderReferenceId

 

 

 

amazonWidgetUrl

string

$form.amazonWidgetUrl

 

 

 

applyAffiliateId

string

$form.applyAffiliateId

 

 

 

applyCouponCode

string

$form.applyCouponCode

 

 

 

below3rdPartyCheckout

string

$form.below3rdPartyCheckout

 

 

 

belowCartHtml

string

$form.belowCartHtml

 

 

 

belowOuterTable

string

$form.belowOuterTable

 

 

 

belowPaymentInformationHtml

string

$form.belowPaymentInformationHtml

 

 

 

belowShippingBillingAddressHtml

string

$form.belowShippingBillingAddressHtml

 

 

 

billingAddress1

string

$form.billingAddress1

 

 

 

billingAddress2

string

$form.billingAddress2

 

 

 

billingCity

string

$form.billingCity

 

 

 

billingCompany

string

$form.billingCompany

 

 

 

billingCountry

string

$form.billingCountry

 

 

 

billingEveningPhone

string

$form.billingEveningPhone

 

 

 

billingFirstName

string

$form.billingFirstName

 

 

 

billingLastName

string

$form.billingLastName

 

 

 

billingState

string

$form.billingState

 

 

 

billingTitle

string

$form.billingTitle

 

 

 

billingZip

string

$form.billingZip

 

 

 

buysafeBondChange

string

$form.buysafeBondChange

 

 

 

buysafeBondCost

BigDecimal

$form.buysafeBondCost

 

 

 

buysafeBondCostStr

string

$form.buysafeBondCostStr

 

 

 

buysafeBondingSignal

string

$form.buysafeBondingSignal

 

 

 

buysafeCartDisplayText

string

$form.buysafeCartDisplayText

 

 

 

buysafeCartDisplayUrl

string

$form.buysafeCartDisplayUrl

 

 

 

buysafeHtml

string

$form.buysafeHtml

 

 

 

buysafeRolloverScriptUrl

string

$form.buysafeRolloverScriptUrl

 

 

 

ccEmail

string

$form.ccEmail

 

 

 

changeCurrencyCode

string

$form.changeCurrencyCode

 

 

 

checkoutTerms

string

$form.checkoutTerms

 

 

 

checkoutTermsAgreementAgreement$form.checkoutTermsAgreement   

checkoutWithPayPal

string

$form.checkoutWithPayPal

 

 

 

checkoutWithPayPalBml

string

$form.checkoutWithPayPalBml

 

 

 

comments

string

$form.comments

 

 

 

continueShopping

string

$form.continueShopping

 

 

 

countries

string[ ]

$form.countries

 

 

 

couponCode

string

$form.couponCode

 

 

 

couponInputFieldStr

string

$form.couponInputFieldStr

 

 

 

couponPluralStr

string

$form.couponPluralStr

 

 

 

couponSingularStr

string

$form.couponSingularStr

 

 

 

coupons

Coupon[ ]

$form.coupons

 

 

 

creditCardExpMonth

string

$form.creditCardExpMonth

 

 

 

creditCardExpMonths

Option[ ]

$form.creditCardExpMonths

 

 

 

creditCardExpYear

string

$form.creditCardExpYear

 

 

 

creditCardExpYears

Option[ ]

$form.creditCardExpYears

 

 

 

creditCardNumber

string

$form.creditCardNumber

 

 

 

creditCardToken

string

$form.creditCardToken

 

 

 

creditCardType

string

$form.creditCardType

 

 

 

creditCardTypes

Option[ ]

$form.creditCardTypes

 

 

 

creditCardVerificationNumber

string

$form.creditCardVerificationNumber

 

 

 

currencyCode

string

$form.currencyCode

 

 

 

currencySuffix

string

$form.currencySuffix

 

 

 

currencySymbol

string

$form.currencySymbol

 

 

 

customField1

string

$form.customField1

 

 

 

customField2

string

$form.customField2

 

 

 

customField3

string

$form.customField3

 

 

 

customField4

string

$form.customField4

 

 

 

customField5

string

$form.customField5

 

 

 

customField6

string

$form.customField6

 

 

 

customField7

string

$form.customField7

 

 

 

email

string

$form.email

 

 

 

emailConfirm

string

$form.emailConfirm

 

 

 

errors

Error[ ]

$form.errors

 

 

 

finalizeOrder

string

$form.finalizeOrder

 

 

 

formattedBuysafeBondCost

string

$form.formattedBuysafeBondCost

 

 

 

gatewayTokenizationScripts

string

$form.gatewayTokenizationScripts

 

 

 

hostLink

string

$form.hostLink

 

 

 

infoMessages

string[ ]

$form.infoMessages

 

 

 

isoCode

string

$form.isoCode

 

 

 

items

CartItem[ ]

$form.items

 

 

 

returnPolicy

string

$form.returnPolicy

 

 

 

returnPolicyAgreementAgreement$form.returnPolicyAgreement   

returnPolicyDescription

string

$form.returnPolicyDescription

 

 

 

returnPolicyHeader

string

$form.returnPolicyHeader

 

 

 

shipping

BigDecimal

$form.shipping

 

 

 

shippingAddress1

string

$form.shippingAddress1

 

 

 

shippingAddress2

string

$form.shippingAddress2

 

 

 

shippingCity

string

$form.shippingCity

 

 

 

shippingCompany

string

$form.shippingCompany

 

 

 

shippingCountry

string

$form.shippingCountry

 

 

 

shippingFirstName

string

$form.shippingFirstName

 

 

 

shippingLastName

string

$form.shippingLastName

 

 

 

shippingMethod

string

$form.shippingMethod

 

 

 

shippingMethods

ShippingMethod[ ]

$form.shippingMethods

 

 

 

shippingPhone

string

$form.shippingPhone

 

 

 

shippingState

string

$form.shippingState

 

 

 

shippingTitle

string

$form.shippingTitle

 

 

 

shippingUrl

string

$form.shippingUrl

 

 

 

shippingZip

string

$form.shippingZip

 

 

 

stateOptionalCountriesJson

string

$form.stateOptionalCountriesJson

 

 

 

storedCardExp

string

$form.storedCardExp

 

 

 

storedCardMaskedNumber

string

$form.storedCardMaskedNumber

 

 

 

subtotal

BigDecimal

$form.subtotal

 

 

 

subtotalBeforeDiscount

BigDecimal

$form.subtotalBeforeDiscount

 

 

 

subtotalDiscount

BigDecimal

$form.subtotalDiscount

 

 

 

tax

BigDecimal

$form.tax

 

 

 

total

BigDecimal

$form.total

 

 

 

updateQuantity

string

$form.updateQuantity

 

 

 

 

$form methods for template single.vm

Method

Signature

Comments/Sample

getItemIdsAsJsonstring $form.getItemIdsAsJson()returns a json array of item ids. very useful if you need the cart item ids in a javascript array.

Flow