The order history module allows your customers to see their past orders. This of course empowers them to check on order status, and even print them for a hard copy receipt, if they wish. From your perspective, you might want to update it to add integrated information. For example, if you're using an ERP, you could implement a tracking feature to allow customers to see the various stages of fulfillment. The possibilities are endless.
The following prerequisites will be necessary to accomplish the goals of this article:
- Have access to your Hotcakes store administration
- Configure your store using the getting started wizard or do it manually
- Have one or more orders ready for the profile viewing the module
The information provided here is based upon the default configuration of Hotcakes and the default viewset. Your views may have more or less functionality, depending on how it was implemented by your technical team.
Order History Module
If you've used the wizard to set-up your store pages, you'll already have a order history module placed in your site. In a default configuration, that page will be found under the "Hotcakes Store" menu, on the Order History page. In most instances, those pages will have been moved and/or renamed on your site though.
If you're logged in and the user/customer account has at least one order, your view will look something similar to the example below. Otherwise, you won't see any orders in the history view.
The view begins by telling you how many reward points your account has, if the loyalty program is enabled. Next, you'll see a grid that contains all of your previous orders. If you have more than 20, they will be shown in a paged format, with each page showing 20 orders.
|Order Placed On||This value will show the date and time that the order was placed by the customer.|
|Order Number||Once an order is placed, it's assigned an order number. That order number is seen here.|
|Total||This will reflect the grand total that is expected to be paid for the order.|
|Status||The order status seen here will match the order status you see in the administration area.|
|[no name]||This is an actions column, with one action, which is to view the respective order for the row. When you click the button, it will take you to the order details view for the order.|
The order details view is essentially a copy of what your customer saw once they successfully placed their order in the first place. They saw it after clicking the "Place Order" button on the checkout page. They are different views though, so your designers can edit one without impacting the other.
From top to bottom, the customer will see their order number, followed by the billing and shipping addresses, as necessary. Moving down, they will see all of the products that were ordered this time, along with any choices they selected. If they entered any special instructions, they will be seen next, with the order payment summary next to it.
What you don't see here initially will be order notes. They'll only appear once there's at least one public order note created by your team or an integration you might have.
Finally, there will be a payment summary included to show your customer what the current and past state of payment is.
This module has settings that are unique to how it works on your site for you and your customer. If you're not already familiar with how module settings work, you should see the module settings documentation to learn more.
|View||This read-only setting will simply show you the view that was selected before viewing the current settings.|
|Select a View||If you wish to change the view that's being used to display the featured products, select the alternative view. By default, you'll only see "Index" as an option, unless your design team has created and added alternatives for you.|
Viewset View Location
You'll find the views for this module in the following location in your viewset:
If you used the getting started wizard, this module will initially be placed on the Order History page, under the Hotcakes Store navigation menu. In your own store, you'll likely want to move it to be somewhere else on your site. You may even find yourself renaming the module and/or page to more closely match the branding of your company (at least from your customer's perspective).
In general, there's nothing to keep you from moving and renaming the module in nearly any way. However, in most stores, the customer will expect to find the order history in their user account/profile area and/or in the top-level navigation. You should keep this in mind if you choose to move this module or page.
This module only works as expected when the customer is logged in. Otherwise, it won't have any idea how to look up the orders to display. As such, you should ensure that this module is only ever on a page that is available to customer security roles that you know are logged in. For example, in the image below the page is visible only to "Registered Users" which is a built-in security role that requires the customer to be logged in to be a part of.
You can also make the page more public if you have the need to. In this case, you'd simply want to make sure the module itself has view permissions to only show itself to security roles that require a logged in user account. In the example below, it was first necessary to uncheck the "Inherit View Permissions from Page" checkbox. Only then could we override when this module is shown to the customer.