special_offers_confirmation.vm

Owned by Perry Tew
Last updated: Aug 12, 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 special_offers_confirmation.vm

Name

Type

Formal Syntax

Form Data?

Required on Post?

Comments/Sample Usage

billingAddress1

string

$form.billingAddress1

 

 

 

billingAddress2

string

$form.billingAddress2

 

 

 

billingCity

string

$form.billingCity

 

 

 

billingCompany

string

$form.billingCompany

 

 

 

billingCountry

string

$form.billingCountry

 

 

 

billingFirstName

string

$form.billingFirstName

 

 

 

billingLastName

string

$form.billingLastName

 

 

 

billingPhone

string

$form.billingPhone

 

 

 

billingState

string

$form.billingState

 

 

 

billingZip

string

$form.billingZip

 

 

 

confirm

string

$form.confirm

 

 

 

email

string

$form.email

 

 

 

errors

Error[]

$form.errors

 

 

 

infoMessages

string[]

$form.infoMessages

 

 

 

items

SpecialOffersItem[] (see below)

$form.items

 

 

 

merchantId

string

$form.merchantId

 

 

 

paymentMethod

string

$form.paymentMethod

 

 

 

paymentMethodLines

SpecialOffersPaymentMethod[] (see below)

$form.paymentMethodLines

 

 

 

redirectUrl

string

$form.redirectUrl

 

 

 

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

 

 

 

shippingPhone

string

$form.shippingPhone

 

 

 

shippingState

string

$form.shippingState

 

 

 

shippingZip

string

$form.shippingZip

 

 

 

summaryLines

SpecialOffersSummary[] (see below)

$form.summaryLines

 

 

 

update

string

$form.update

 

 

 

 

Template Specific Value Objects

SpecialOffersItem

Field

Type

Comment/Sample

amount

string

 

description

string

 

discount

string

 

itemIndex

integer

 

maxQuantity

integer

 

merchantItemId

string

 

merchantItemOid

integer

 

options

SpecialOffersItemOption[] (see below)

 

quantity

integer

 

remove

string

 

removeOnConfirmation

boolean

 

thumbnailUrl

string

 

unitCost

string

 

upsell

boolean

 

viewUrl

string

 

SpecialOffersItemOption

Field

Type

Comment/Sample

file

html file element

 

label

string

 

name

string

 

qualiferGroupId

integer

internal use

type

string

 

value

string

 

values

string[]

 

SpecialOffersPaymentMethod

Field

Type

Comment/Sample

name

string

 

value

string

 

SpecialOffersSummary

Field

Type

Comment/Sample

amount

string

 

discount

boolean

 

name

string

 

 

Flow