review.vm
info
Transcluded from Screen Interface Intro.
$form variables for template review.vm
| Name | Type | Formal Syntax | Form Data? | Required on Post? | Comments/Sample Usage |
|---|---|---|---|---|---|
address1 | string | $form.address1 | |||
address2 | string | $form.address2 | |||
addressBook | [Addresses[ ]](../storefront-object-model/address-sfo.md) | $form.addressBook | |||
amazonMerchantId | string | $form.amazonMerchantId | |||
amazonOrderReferenceId | string | $form.amazonOrderReferenceId | |||
amazonWidgetUrl | string | $form.amazonWidgetUrl | |||
billingInfo | string[ ] | $form.billingInfo | |||
buysafeBondChange | string | $form.buysafeBondChange | |||
buysafeBondCost | [BigDecimal](../storefront-object-model/bigdecimal-sfo.md) | $form.buysafeBondCost | |||
buysafeBondingSignal | string | $form.buysafeBondingSignal | |||
buysafeCartDisplayText | string | $form.buysafeCartDisplayText | |||
buysafeCartDisplayUrl | string | $form.buysafeCartDisplayUrl | |||
buysafeRolloverScriptUrl | string | $form.buysafeRolloverScriptUrl | |||
ccEmail | string | $form.ccEmail | |||
checkNumber | string | $form.checkNumber | |||
checkoutTerms | string | $form.checkoutTerms | |||
checkoutTermsAgreement | [Agreement](../storefront-object-model/agreement-sfo.md) | $form.checkoutTermsAgreement | |||
city | string | $form.city | |||
company | string | $form.company | |||
countries | string[ ] | $form.countries | |||
country | string | $form.country | |||
creditCardExpMonth | string | $form.creditCardExpMonth | |||
creditCardExpMonths | [Option](../storefront-object-model/option-sfo.md)[ ] | $form.creditCardExpMonths | |||
creditCardExpYear | string | $form.creditCardExpYear | |||
creditCardExpYears | [Option](../storefront-object-model/option-sfo.md) [ ] | $form.creditCardExpYears | |||
creditCardNumber | string | $form.creditCardNumber | |||
creditCardToken | string | $form.creditCardToken | |||
creditCardType | string | $form.creditCardType | |||
creditCardTypes | [Option](../storefront-object-model/option-sfo.md) [ ] | $form.creditCardTypes | |||
creditCardVerificationNumber | string | $form.creditCardVerificationNumber | |||
customField2 | string | $form.customField2 | |||
dayPhone | string | $form.dayPhone | |||
deliveryDate | string | $form.deliveryDate | |||
echeckAccountNumber | string | $form.echeckAccountNumber | |||
echeckAccountType | string | $form.echeckAccountType | |||
echeckBankName | string | $form.echeckBankName | |||
echeckConfirmAccountNumber | string | $form.echeckConfirmAccountNumber | |||
echeckCustomerTaxId | string | $form.echeckCustomerTaxId | |||
echeckDriversLicenseDOB | string | $form.echeckDriversLicenseDOB | |||
echeckDriversLicenseNumber | string | $form.echeckDriversLicenseNumber | |||
echeckDriversLicenseState | string | $form.echeckDriversLicenseState | |||
echeckDriversLicenseStates | string[ ] | $form.echeckDriversLicenseStates | |||
echeckOwnerType | string | $form.echeckOwnerType | |||
echeckRoutingNumber | string | $form.echeckRoutingNumber | |||
email | string | $form.email | |||
errors | [Error[ ]](../storefront-object-model/error-sfo.md) | $form.errors | |||
eveningPhone | string | $form.eveningPhone | |||
firstName | string | $form.firstName | |||
formattedBuysafeBondCost | string | $form.formattedBuysafeBondCost | |||
gatewayTokenizationScripts | string | $form.gatewayTokenizationScripts | |||
giftMessage | string | $form.giftMessage | |||
infoMessages | string[ ] | $form.infoMessages | |||
items | ItemObject[ ] (see below) | $form.items | |||
lastName | string | $form.lastName | |||
liftGate | string | $form.liftGate | |||
merchantId | string | $form.merchantId | |||
paymentPreference | string | $form.paymentPreference | |||
purchaseOrderNumber | string | $form.purchaseOrderNumber | |||
returnPolicy | string | $form.returnPolicy | |||
returnPolicyAgreement | [Agreement](../storefront-object-model/agreement-sfo.md) | $form.returnPolicyAgreement | | | Null if no return policy is configured. |
returnPolicyDescription | string | $form.returnPolicyDescription | |||
screenBrandingThemeCode | string | $form.screenBrandingThemeCode | |||
shipOnDate | string | $form.shipOnDate | |||
shipping3rdPartyAccountNumber | string | $form.shipping3rdPartyAccountNumber | |||
shippingInfo | string[ ] | $form.shippingInfo | |||
shippingMethod | string | $form.shippingMethod | |||
showAddress | string | $form.showAddress | |||
specialInstructions | string | $form.specialInstructions | |||
state | string | $form.state | |||
stateOptionalCountriesJson | string | $form.stateOptionalCountriesJson | |||
storedCreditCardMask | string | $form.storedCreditCardMask | |||
summaryLineItems | SummaryLineItem[ ] (see below) | $form.summaryLineItems | |||
thirdPartyUrl | string | $form.thirdPartyUrl | |||
title | string | $form.title | |||
total | string | $form.total | |||
zip | string | $form.zip |
$form methods for template review.vm
| Method | Signature | Comments/Sample |
|---|---|---|
getItemIdsAsJson | string $form.getItemIdsAsJson() | returns a json array of item ids. very useful if you need the cart item ids in a javascript array. |
Template Specific Value Objects
ItemObject
| Field | Type | Comment/Sample |
|---|---|---|
amount | string | |
autoOrderFrequency | string | |
description | string | |
discount | string | |
itemId | string | |
options | [ValueObject](../storefront-object-model/valueobject-sfo.md)``[ ] (name, value) | |
quantity | string |
SummaryLineItem
| Field | Type | Comment/Sample |
|---|---|---|
amount | string | Formatted amount |
discount | boolean | true if this line item is a discount |
name | string | label or description of the line item |
rawAmount | [BigDecimal](../storefront-object-model/bigdecimal-sfo.md) | This raw amount is for advanced use only. It contains no formatting. |
currencyCode | The cart currency code (useful for manipulating rawAmount) | |
baseCurrencyCode | The merchant base currency code (useful for manipulating rawAmount) | |
exchangeRate | [BigDecimal](../storefront-object-model/bigdecimal-sfo.md) | The cart exchange rate (useful for manipulating rawAmount) |
Flow
Was this page helpful?