shipping.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 shipping.vm

Name

Type

Formal Syntax

Form Data?

Required on Post?

Comments/Sample Usage

address1

string

$form.address1

 

 

 

address2

string

$form.address2

 

 

 

addressBook

Addresses[ ]

$form.addressBook

 

 

 

addressLength

string

$form.addressLength

 

 

 

amazonMerchantId

string

$form.amazonMerchantId

 

 

 

amazonOrderReferenceId

string

$form.amazonOrderReferenceId

 

 

 

amazonWidgetUrl

string

$form.amazonWidgetUrl

 

 

 

ccEmail

string

$form.ccEmail

 

 

 

city

string

$form.city

 

 

 

company

string

$form.company

 

 

 

countries

string[ ]

$form.countries

 

 

 

country

string

$form.country

 

 

 

customField1

string

$form.customField1

 

 

 

deliveryBlackouts

string[ ]

$form.deliveryBlackouts

 

 

 

deliveryDate

string

$form.deliveryDate

 

 

 

deliveryDateDisableDays

string

$form.deliveryDateDisableDays

 

 

 

deliveryDateRangeLow

string

$form.deliveryDateRangeLow

 

 

 

deliveryOnDatePickadateDisabled

string

$form.deliveryOnDatePickadateDisabled

 

 

 

deliveryOnDatePickadateMin

string

$form.deliveryOnDatePickadateMin

 

 

 

email

string

$form.email

 

 

 

emailConfirm

string

$form.emailConfirm

 

 

 

errors

Error[ ]

$form.errors

 

 

 

eveningPhone

string

$form.eveningPhone

 

 

 

firstName

string

$form.firstName

 

 

 

formattedGiftCharge

string

$form.formattedGiftCharge

 

 

 

giftCharge

string

$form.giftCharge

 

 

 

giftEmail

string

$form.giftEmail

 

 

 

giftMaxLengthMessage

string

$form.giftMaxLengthMessage

 

 

 

giftMessage

string

$form.giftMessage

 

 

 

giftWrapId

int

$form.giftWrapId

 

 

 

giftWraps

GiftWrap[ ] (see below)

$form.giftWraps

 

 

 

infoMessages

string[ ]

$form.infoMessages

 

 

 

lastName

string

$form.lastName

 

 

 

merchantId

string

$form.merchantId

 

 

 

phone

string

$form.phone

 

 

 

shipOnDate

string

$form.shipOnDate

 

 

 

shipOnDateDisableDays

string

$form.shipOnDateDisableDays

 

 

 

shipOnDatePickadateDisabled

string

$form.shipOnDatePickadateDisabled

 

 

 

shipOnDatePickadateMin

string

$form.shipOnDatePickadateMin

 

 

 

shipOnDateRangeLow

string

$form.shipOnDateRangeLow

 

 

 

shippingBlackouts

string[ ]

$form.shippingBlackouts

 

 

 

state

string

$form.state

 

 

 

stateOptionalCountriesJson

string

$form.stateOptionalCountriesJson

 

 

 

title

string

$form.title

 

 

 

zip

string

$form.zip

 

 

 

Template Specific Value Objects

GiftWrap

Field

Type

Comment/Sample

cost

string

 

giftWrapId

string

 

imageUrl

string

 

name

string

 

 

Flow