CheckoutViewModel

Overview

The CheckoutViewModel is the primary model used to render the checkout view to customers. This article will help you understand what's available to you in the view model.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of template engines
  • Understanding HTML, CSS, JavaScript
  • Familiarity with template languages
  • Familiarity with ASP.NET MVC Razor

Getting Started

There are no tasks needed to get started with understanding this object. 

CheckoutViewModel

The CheckoutViewModel object will contain all of the details of a single instance of placing an order in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the CheckoutViewModel object.  The descriptions are based on default functionality and the default Viewset included with Hotcakes.

Member Type Description
AffiliateId String

If populated, it's ID of the affiliate that referred the customer. It might have been manually entered, or implicitly added from a previous referral.

AgreedToTerms Bool Indicates whether the terms checkbox was checked by the customer or not.
AgreedToTermsDescription String Description placed next to the agree to terms checkbox in the checkout view.
BillShipSame Bool Indicates whether the customer specified that the billing and shipping address are the same or not.
Countries List<Country> List of enabled countries to be shown on the address forms.
CurrentCustomer CustomerAccount If logged in, this will have information about the current customer.
CurrentOrder Order Order information for the current cart.
ErrorCssClass String CSS class name to be applied to indicated validation errors on form fields in the checkout.
GiftCards GiftCardViewModel If enabled, a model necessary to render the ability to accept gift cards as payment.
IsLoggedIn Bool Indicates whether the customer is logged in or not.
LabelRewardPoints String Name of the reward points program to be shown to the customer, as set in the administration area.
LabelRewardUse String Custom label set in the administration area to indicate to customers they can use their available reward points.
LabelTerms String The name that you wish for the terms of use to have in it's link.
LoginTabID String The ID of the page that contains the login form for customers to use to authenticate themselves.
PaymentViewModel CheckoutPaymentViewModel A model that contains the payment details for this specific order.
PayPalPayerId String BuyerID required to be sent when directing the customer to PayPal Express.
PayPalToken String Token received from PayPal when using their Express payment option.
RegPassword String Password entered by the customer when creating a new customer account on the checkout view.
RegUsername String Desired username for the customer account, when the customer chooses to create a user account on the checkout view.
RequirePhoneNumber Boolean If true, this setting is enabled in the Order settings, and customers must enter a value for the phone number before they can complete the checkout process.
RewardPointsAvailable String Customized message to show the customer that they have rewards points available.
ShowAffiliateId Bool Indicates whether or not the store settings require that the affiliate ID field should be displayed to customers.
ShowAgreeToTerms Bool Indicates whether the checkout should display the terms and description to the customer or not.
ShowConfirmation Bool Indicates whether the checkout needs to display a confirmation to the customer before actually submitting the order.
ShowRewards Bool Indicates whether the checkout should display the reward points to customers or not.
UseRewardPoints Bool If true, the customer has chosen to apply their reward points to the order.
Violations List<Violations> List of form validation errors that have been found in the checkout view.

 

Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.