The OrderViewModel is the primary model used to render the receipt and order history views to customers. This article will help you understand what's available to you in the view model.
The following pre-requisites will be necessary to accomplish the goals of this article:
- General understanding of template engines
- Familiarity with template languages
- Familiarity with ASP.NET MVC Razor
There are no tasks needed to get started with understanding this object.
The OrderViewModel object will contain all of the details of a single instance of a placed order in your Hotcakes Commerce store.
The following table gives you details on the various members of the OrderViewModel object. The descriptions are based on default functionality and the default Viewset included with Hotcakes.
This will be a pre-formatted HTML chunk of text that contains the billing address for the customer order.
|Coupons||List<OrderCoupon>||If the order has any coupons saved by the customer, they will be shown here. A coupon is also known as a coupon code or promotional code. This list will likely be empty in most orders, but can be many coupon codes.|
|FullOrderStatusDescription||String||This property will tell you the current status of the order, including: Paid, Unpaid, Partially Paid, Shipped, etc.|
|HasShippingItems||Bool||If any of the line items (products) in the current order can be physically shipped, this value will be true. Otherwise, it will be false. For example, if you sell software and only allow it to be downloaded, this may always be false.|
|Instructions||String||If the customer entered any special instructions during checkout, they will be here as well. Otherwise, it will be an empty value.|
|IsRecurring||Bool||This is not currently used and will always be false.|
|Items||List<LineItem>||This will contain a listing of all of the products that were added to the shopping cart when completing the checkout. There will always be at least one line item, but there could be many.|
|LocalOrder||Order||If you need to access a more advanced of uncommon property of the order, it can be found in this object.|
|OrderNumber||String||This is the unique number that was assigned to the order. While order numbers appear in numeric form, this value will be returned to you in string format.|
|ShippingAddressAsHtml||Bool||This will be a pre-formatted HTML chunk of text that contains the shipping address for the customer order.|
|TotalAsTable||String||This is the pre-formatted HTML chunk of text that represents the final order summary of shipping, taxes, subtotal, and total for the order.|